[WIP] Ephemeris Documentation

rlkoshak · November 12, 2019, 5:35pm

I’ve created the PR.

Please add any further comments and edits there.

tnemrap · December 21, 2019, 9:55pm

How to use holiday_descriptions.properties ?

/Mike

RipNCode · December 22, 2019, 12:35am

@mashborn Did you ever get the xml file to be found? I’m running into the same issue on OH 2.5 stable (openhabian).

Marian_Kilinski · December 23, 2019, 5:23pm

use

getHolidayDescription(holiday name)

Jollyday defines a mapping between the holiday name and a description. This will return the description based on the holiday name returned by getBankHolidayName

jcosta46 · February 25, 2020, 6:49pm

I’m trying to make it work
but I haven’t succeeded
/etc/openhab2/services/Holidays_gr.xml

<?xml version="1.0" encoding="UTF-8"?>

<tns:Configuration hierarchy="gr" description="Greece"

    xmlns:tns="http://www.example.org/Holiday" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

    xsi:schemaLocation="http://www.example.org/Holiday /Holiday.xsd">

    <tns:Holidays>

        <tns:Fixed month="JANUARY" day="1" descriptionPropertiesKey="NEW_YEAR"/>

        <tns:Fixed month="JANUARY" day="6" descriptionPropertiesKey="THEOPHANY"/>

        <tns:Fixed month="JANUARY" day="12" descriptionPropertiesKey="CHRIS_BIRTHDAY"/>

        <tns:Fixed month="JANUARY" day="20" descriptionPropertiesKey="Chris_test"/>

        <tns:Fixed month="JANUARY" day="30" descriptionPropertiesKey="THREE_HIERARCHS"/>

        <tns:Fixed month="FEBRUARY" day="25" descriptionPropertiesKey="February_25"/>

        <tns:Fixed month="FEBRUARY" day="26" descriptionPropertiesKey="February_26"/>

        <tns:Fixed month="MARCH" day="6" descriptionPropertiesKey="GEORGE_BIRTHDAY"/>

        <tns:Fixed month="MARCH" day="25" descriptionPropertiesKey="ANNUNCIATION"/>

        <tns:Fixed month="MAY" day="1" descriptionPropertiesKey="LABOUR_DAY"/>

        <tns:Fixed month="MAY" day="4" descriptionPropertiesKey="KONSTANTINE_BIRTHDAY"/>

        <tns:Fixed month="MAY" day="6" descriptionPropertiesKey="OLGA_BIRTHDAY"/>

        <tns:Fixed month="AUGUST" day="15" descriptionPropertiesKey="ASSUMPTION_DAY"/>

        <tns:Fixed month="OCTOBER" day="28" descriptionPropertiesKey="OCHI"/>

        <tns:Fixed month="DECEMBER" day="25" descriptionPropertiesKey="CHRSITMAS"/>

        <tns:Fixed month="DECEMBER" day="26" descriptionPropertiesKey="STEPHENS"/>

        <tns:ChristianHoliday type="EASTER" chronology="JULIAN"/>

        <tns:ChristianHoliday type="CLEAN_MONDAY"

            chronology="JULIAN" />

        <tns:ChristianHoliday type="GOOD_FRIDAY"

            chronology="JULIAN" />

        <tns:ChristianHoliday type="EASTER_MONDAY"

            chronology="JULIAN" />

        <tns:ChristianHoliday type="WHIT_MONDAY"

            chronology="JULIAN" />

    </tns:Holidays>

</tns:Configuration>

items
Switch TestEphemeris “Test Switch”

rules

val filename = "Ephemeris"

rule "Ephemeris started rule"

when 

 Item TestEphemeris changed

then

   

   if (Ephemeris.isBankHoliday(0,"/etc/openhab2/services/Holidays_gr.xml") ) {

      logInfo(filename,"February 25") // not working

   }

   if ( Ephemeris.isBankHoliday(1,"/etc/openhab2/services/Holidays_gr.xml") ) {

      logInfo(filename,"February 26") //  not working

   }

   if (!isWeekend(5)) {

   logInfo(filename,"Ημέρα της εβδομάδας") // OK

   }

   if (isWeekend(4)) {

   logInfo(filename,"Αύριο είναι το Σαββατοκύριακο")  // OK

   }

   if (isInDayset("school",0))// deytera me paraskeuh 

   {

   logInfo(filename,"Υπάρχει σχολείο σήμερα") // OK 

   }

end

i’m trying

but not work
thanks

cweitkamp · February 25, 2020, 7:47pm

Hi @jcosta46,

Unfortunately exactly the isBankHoliday(<offset>, <file>) action is broken in OH 2.5.x and will probably not working before OH 3.0 - even if it is already fixed in our code base (see https://github.com/openhab/openhab-core/issues/1374).

A small workaround is to use isBankHoliday(<datetime>, <file>) and set ZonedDateTime.now().plusDays(<offset>) for <datetime>.

I think we should add a note to the docs.

frankie.delure · February 25, 2020, 7:59pm

I added this to my ephemeris.cfg

org.openhab.ephemeris:dayset-weekend = [SATURDAY,SUNDAY]
org.openhab.ephemeris:dayset-school = [MONDAY,TUESDAY,WEDNESDAY,THURSDAY,FRIDAY]
org.openhab.ephemeris:country = [DE]

This is how my config looks under PaperUI:

I have no idea how to fix this. Whatever I do either in PaperUi or in ephemeris.cfg - the result is broken like in the screenshot.

jcosta46 · February 25, 2020, 11:12pm

thanks
could you help me
val filename = “Ephemeris”

rule "Ephemeris started rule"

when 

 Item TestEphemeris changed

then

      var Number datetime = ZonedDateTime.now().plusDays(1)

      var file = "/etc/openhab2/services/Holidays_gr.xml"

   if (Ephemeris.isBankHoliday(datetime,file) ) {

      logInfo(filename,"February 25") // not working

   }

   if ( Ephemeris.isBankHoliday(1,"/etc/openhab2/services/Holidays_gr.xml") ) {

      logInfo(filename,"February 26") //  not working

   }

   if (!isWeekend(5)) {

   logInfo(filename,"Ημέρα της εβδομάδας") // OK

   }

   if (isWeekend(4)) {

   logInfo(filename,"Αύριο είναι το Σαββατοκύριακο")  // OK

   }

   if (isInDayset("school",0))// deytera me paraskeuh 

   {

   logInfo(filename,"Υπάρχει σχολείο σήμερα") // OK 

   }

end

I don’t know how to write it.

I get that

2020-02-26 01:11:48.292 [ERROR] [ntime.internal.engine.RuleEngineImpl] - Rule 'Ephemeris started rule': The name 'ZonedDateTime' cannot be resolved to an item or type; line 61, column 29, length 13

rlkoshak · February 26, 2020, 3:40pm

Try

new DateTimeType().zonedDateTime.now().plusDays(1)

jcosta46 · February 27, 2020, 1:42am

thanks
but I couldn’t make it work
i have tried this

val filename = "Ephemeris"

rule "Ephemeris started rule"

when 

 Item TestEphemeris changed

then

      var datetime = new DateTimeType().zonedDateTime.now().plusDays(1)

      var file = "/etc/openhab2/services/Holidays_gr.xml"

   if (Ephemeris.isBankHoliday(new DateTimeType().zonedDateTime.now().plusDays(1),"/etc/openhab2/services/Holidays_gr.xml") ) {

      logInfo(filename,"February 27") // not working

   }

   if (isBankHoliday(new DateTimeType().zonedDateTime.now().plusDays(1),"/etc/openhab2/services/Holidays_gr.xml") ) {

      logInfo(filename,"February 27") // not working

   }

   if ( Ephemeris.isBankHoliday(datetime,file) ) {

      logInfo(filename,"February 27") //  not working

   }

   if (isBankHoliday(datetime,file) ) {

      logInfo(filename,"February 27") //  not working

   }

   if ( Ephemeris.isBankHoliday(datetime) ) {

      logInfo(filename,"February 27") //  not working

   }

   if (!isWeekend(5)) {

   logInfo(filename,"Ημέρα της εβδομάδας") // OK

   }

   if (isWeekend(4)) {

   logInfo(filename,"Αύριο είναι το Σαββατοκύριακο")  // OK

   }

   if (isInDayset("school",0))

   {

   logInfo(filename,"Υπάρχει σχολείο σήμερα") // OK 

   }

end

rlkoshak · February 27, 2020, 3:52pm

Errors in the log?

jcosta46 · February 27, 2020, 10:28pm

@rlkoshak nothing Errors in the log
I had to do
sudo systemctl restart openhab2.service
now it works
thanks

val filename = "Ephemeris"

rule "Ephemeris started rule"

when 

 Item TestEphemeris changed

then

      var datetime = new DateTimeType().zonedDateTime.now().plusDays(0)

      var file = "/etc/openhab2/services/Holidays_gr.xml"

   if (isBankHoliday(datetime,file) ) {

      logInfo(filename,"February 28") //  ok

   }

   if (isWeekend()) {

   logInfo(filename,"Αύριο είναι το Σαββατοκύριακο")  // OK

   }

   if (isInDayset("school",0))

   {

   logInfo(filename,"Υπάρχει σχολείο σήμερα") // OK 

   }

end

INT5749 · March 2, 2020, 7:46pm

Hi all,
I’m trying to lookup some “holiday” with proper translation, but fail and hope you can advise or help

Unfortunately I have no idea how to debug further as it’s my names are simply not looked up.
My entry in *.xml
<tns:FixedWeekdayRelativeToFixed which="FIRST" weekday="SUNDAY" when="BEFORE" descriptionPropertiesKey="FOURTH_ADVENT" localizedType="OFFICIAL_HOLIDAY"> <tns:day month="DECEMBER" day="25"/> </tns:FixedWeekdayRelativeToFixed>
Entry to holiday_descriptions_de.properties
holiday.description.FOURTH_ADVENT = 4. Advent
This seems to be equal to the other entries.

So FOURTH_ADVENT is returned properly when using
logInfo("Test", "Vierter {}", Ephemeris.getBankHolidayName((new DateTimeType("2021-12-2019").zonedDateTime), '<myPath>/holidays_de.xml'))

But I didn’t get value from
logInfo("Test", "vorher: {} und nachher: {}", Ephemeris.getBankHolidayName((new DateTimeType("2020-12-20").zonedDateTime), '<myPath>/holidays_de.xml'), Ephemeris.getHolidayDescription(Ephemeris.getBankHolidayName((new DateTimeType("2020-12-20").zonedDateTime), '<myPathY/holidays_de.xml')))

Returns

20:27:42.667 [INFO ] [g.eclipse.smarthome.model.script.Test] - vorher: FOURTH_ADVENT und nachher: undefined

Hope this helps?

simcla · November 16, 2020, 8:40am

new DateTimeType().zonedDateTime.now().plusDays(1)

works fine - thank you!

Could you please also correct the documentation at
(https://www.openhab.org/docs/configuration/actions.html#ephemeris)
It still says
…This action is broken in OH 2.5.x. Use getNextBankHoliday(, ) instead by replacing with ZonedDateTime.now().plusDays()

sihui · November 16, 2020, 12:01pm

It’s easy, just click on the link at the bottom of the page, this is a community driven project.

grafik

simcla · November 16, 2020, 1:22pm

Thanks for the hint - done

INT5749 · January 18, 2021, 7:48am

Hi all,

I have just migrated to openHAB 3.1.0 Snapshop, but still have issue to get personal SpecialDays translated properly (Reported here while on OH2.x)

I have added my special days to holiday_descriptions_de.properties which is stored along with the other xml in services folder. Special days added to specialdays.xml are reconized, just not translated properly :-/

Does anyone have same issue on OH3?

Regards
Joerg

mas · May 9, 2021, 10:42am

A question about daysets:
For me, the trash is only emptied every second Monday.

Is it possible to specify in ephemeris.cfg that dayset-trash applies only every second Monday?

glhopital · May 10, 2021, 4:40am

No, you can’t

INT5749 · December 1, 2021, 8:36pm

I still stuck to get translation for my personal entries and imagine if anyone else uses translation for personal entries?

Best Regards