Cleanup info about holiday sensor (#10817)

Cleanup for holiday sensor. Parent PR: home-assistant/home-assistant#27654
This commit is contained in:
Tsvi Mostovicz 2019-10-20 16:21:22 +03:00 committed by Franck Nijhof
parent db460c26fb
commit 703be08638

View File

@ -56,8 +56,7 @@ havdalah_minutes_after_sunset:
### Data sensors
- date: Shows the hebrew date for today.
- weekly_portion: Shows the weekly portion (parshat hashavu'a).
- holiday_name: If it is a holiday, shows the name of the holiday.
- holiday_type: Shows the type of the holiday _(see below)_.
- holiday: If it is a holiday, shows the name of the holiday _(see below for more info)_.
- omer_count: An integer sensor indicating the day of the Omer (1-49) or 0 if it is not currently the Omer.
### Time sensors
@ -81,17 +80,56 @@ For easier use in automations, all time sensors have a `timestamp` attribute, wh
- issur_melacha_in_effect: A boolean sensor indicating if melacha is currently not permitted. The value is true when it is currently Shabbat or Yom Tov and false otherwise.
### Holiday types
### Holiday sensor
The holiday sensor includes two attibutes: *type* and *id*.
The following is the list of holidays the sensor knows about with their selected type:
| ID | English | Hebrew | Type |
|----------------------|----------------------------|-----------------------|---------------------------|
| erev_rosh_hashana | Erev Rosh Hashana | ערב ראש השנה | EREV_YOM_TOV |
| rosh_hashana_i | Rosh Hashana I | א' ראש השנה | YOM_TOV |
| rosh_hashana_ii | Rosh Hashana II | ב' ראש השנה | YOM_TOV |
| tzom_gedaliah | Tzom Gedaliah | צום גדליה | FAST_DAY |
| erev_yom_kippur | Erev Yom Kippur | עיוה"כ | EREV_YOM_TOV |
| yom_kippur | Yom Kippur | יום הכפורים | YOM_TOV |
| erev_sukkot | Erev Sukkot | ערב סוכות | EREV_YOM_TOV |
| sukkot | Sukkot | סוכות | YOM_TOV |
| hol_hamoed_sukkot | Hol hamoed Sukkot | חול המועד סוכות | HOL_HAMOED |
| hoshana_raba | Hoshana Raba | הושענא רבה | EREV_YOM_TOV |
| simchat_torah | Simchat Torah | שמחת תורה | YOM_TOV |
| chanukah | Chanukah | חנוכה | MELACHA_PERMITTED_HOLIDAY |
| asara_btevet | Asara B'Tevet | צום עשרה בטבת | FAST_DAY |
| tu_bshvat | Tu B'Shvat | ט"ו בשבט | MINOR_HOLIDAY |
| taanit_esther | Ta'anit Esther | תענית אסתר | FAST_DAY |
| purim | Purim | פורים | MELACHA_PERMITTED_HOLIDAY |
| shushan_purim | Shushan Purim | שושן פורים | MELACHA_PERMITTED_HOLIDAY |
| erev_pesach | Erev Pesach | ערב פסח | EREV_YOM_TOV |
| pesach | Pesach | פסח | YOM_TOV |
| hol_hamoed_pesach | Hol hamoed Pesach | חול המועד פסח | HOL_HAMOED |
| pesach_vii | Pesach VII | שביעי פסח | YOM_TOV |
| yom_haatzmaut | Yom HaAtzma'ut | יום העצמאות | MODERN_HOLIDAY |
| lag_bomer | Lag B'Omer | ל"ג בעומר | MINOR_HOLIDAY |
| erev_shavuot | Erev Shavuot | ערב שבועות | EREV_YOM_TOV |
| shavuot | Shavuot | שבועות | YOM_TOV |
| tzom_tammuz | Tzom Tammuz | צום שבעה עשר בתמוז | FAST_DAY |
| tisha_bav | Tish'a B'Av | תשעה באב | FAST_DAY |
| tu_bav | Tu B'Av | ט"ו באב | MINOR_HOLIDAY |
| yom_hashoah | Yom HaShoah | יום השואה | MEMORIAL_DAY |
| yom_hazikaron | Yom HaZikaron | יום הזכרון | MEMORIAL_DAY |
| yom_yerushalayim | Yom Yerushalayim | יום ירושלים | MODERN_HOLIDAY |
| shmini_atzeret | Shmini Atzeret | שמיני עצרת | YOM_TOV |
| pesach_viii | Pesach VIII | אחרון של פסח | YOM_TOV |
| shavuot_ii | Shavuot II | שני של שבועות | YOM_TOV |
| sukkot_ii | Sukkot II | שני של סוכות | YOM_TOV |
| pesach_ii | Pesach II | שני של פסח | YOM_TOV |
| family_day | Family Day | יום המשפחה | ISRAEL_NATIONAL_HOLIDAY |
| memorial_day_unknown | Memorial day for fallen whose place of burial is unknown | יום זכרון... | MEMORIAL_DAY |
| rabin_memorial_day | Yitzhak Rabin memorial day | יום הזכרון ליצחק רבין | MEMORIAL_DAY |
| zeev_zhabotinsky_day | Zeev Zhabotinsky day | יום ז'בוטינסקי | MEMORIAL_DAY |
1. Mido'rayta - by Torah ordination (Rosh Hashana, Yom Kippur, Pesach, Shavuot, Sukkot)
2. Erev Yom Tov
3. Hol Hamo'ed
4. Hanukka and Purim
5. Fast days
6. Modern holidays, e.g. Yom Yerushalayim and Yom Haatsmaut
7. Minor holidays, e.g. Lag ba'omer and Tu bishvat
8. Memorial days: yom hazikaron and yom hashoah
9. Days mentioned by the Israeli parliament: Rabin memorial day, Ze'ev Zhabotinsky day, etc.
## Full configuration sample