jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Jewish calendar docs (#14435)

Browse Source 
Co-authored-by: Engineering2 <Engineering2@atm.local>
This commit is contained in:
Yuval Aboulafia 2020-09-09 18:27:51 +03:00 committed by GitHub
parent 51500b39d3
commit 643c9c09b6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 68 additions and 69 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

137
source/_integrations/jewish_calendar.markdown
View File

@ -10,11 +10,11 @@ ha_codeowners:
ha_domain: jewish_calendar ha_domain: jewish_calendar
--- ---
The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors. The Jewish Calendar (`jewish_calendar`) integration displays a variety of information related to the Jewish Calendar as a variety of sensors.
## Configuration ## Configuration
To enable this sensor in your installation, add the following to your `configuration.yaml` file: To enable this integration in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
@ -49,7 +49,7 @@ candle_lighting_minutes_before_sunset:
type: integer type: integer
havdalah_minutes_after_sunset: havdalah_minutes_after_sunset:
required: false required: false
description: Number of minutes after sunset to report as havdalah time. If this is set to 0, uses the time that the sun is 8.5 degrees below the horizon (same as the 'three_stars' sensor). If non-zero, this value is added as an offset to the time of sunset to report havdalah. description: Number of minutes after sunset to report as havdalah time. If this is set to 0, uses the time that the sun is 8.5 degrees below the horizon (same as the `first_stars` sensor). If non-zero, this value is added as an offset to the time of sunset to report havdalah.
default: 0 default: 0
type: integer type: integer
{% endconfiguration %} {% endconfiguration %}
@ -57,11 +57,12 @@ havdalah_minutes_after_sunset:
## Sensor list ## Sensor list
### Data sensors ### Data sensors
- date: Shows the hebrew date for today.
- weekly_portion: Shows the weekly portion (parshat hashavu'a). - `date`: Shows the hebrew date for today.
- holiday: If it is a holiday, shows the name of the holiday _(see below for more info)_. - `weekly_portion`: Shows the weekly portion (parshat hashavu'a - פרשת השבוע)
- omer_count: An integer sensor indicating the day of the Omer (1-49) or 0 if it is not currently the Omer. - `holiday`: If it is a holiday, shows the name of the holiday _(see below for more info)_.
- daf_yomi: Shows the date's daf yomi page. - `omer_count`: An integer sensor indicating the day of the Omer (1-49) or 0 if it is not currently the Omer.
- `daf_yomi`: Shows the date's daf yomi page.
### Time sensors ### Time sensors
@ -70,25 +71,25 @@ havdalah_minutes_after_sunset:
Time sensor states are represented as ISO8601 formatted *UTC time*. Time sensor states are represented as ISO8601 formatted *UTC time*.
For easier use in automations, all time sensors have a `timestamp` attribute, which returns the UNIX timestamp. For easier use in automations, all time sensors have a `timestamp` attribute, which returns the UNIX timestamp.
- first_light: First light of dawn (Alot Hashachar - עלות השחר). - `first_light`: First light of dawn (Alot Hashachar - עלות השחר)
- talit: Earliest time for tallit and tefillin - `talit`: Earliest time for tallit and tefillin (Misheyakir - משיכיר)
- gra_end_shma: Last time for reading of the Shma according to the Gr"a. - `gra_end_shma`: Last time for reading of the Shma according to the Gr"a.
- mga_end_shma: Last time for reading of the Shma according to the MG"A. - `mga_end_shma`: Last time for reading of the Shma according to the MG"A.
- gra_end_tefilla: Last time for full shacharit according to the Gr"a. - `gra_end_tefilla`: Last time for full shacharit according to the Gr"a.
- mga_end_tefilla: Last time for full shacharit according to the MG"A. - `mga_end_tefilla`: Last time for full shacharit according to the MG"A.
- big_mincha: Earliest time for Mincha (Mincha Gedola) - `big_mincha`: Earliest time for Mincha (Mincha Gedola - מנחה גדולה)
- little_mincha: Preferable earliest time for Mincha (Mincha Ketana) - `little_mincha`: Preferable earliest time for Mincha (Mincha Ketana - מנחה קטנה)
- plag_mincha: Time of the Plag Hamincha. - `plag_mincha`: Time of the Plag Hamincha (פלג המנחה)
- sunset: Sunset (Shkiya) - `sunset`: Sunset (Shkiya - שקיעה)
- first_stars: Time at which the first stars are visible (Tseit Hakochavim - צאת הכוכבים). - `first_stars`: Time at which the first stars are visible (Tseit Hakochavim - צאת הכוכבים)
- upcoming_shabbat_candle_lighting: The time of candle lighting for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat. - `upcoming_shabbat_candle_lighting`: The time of candle lighting for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat.
- upcoming_shabbat_havdalah: The time of havdalah for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat. If it is currently a three-day holiday, this value *could* be None (i.e., if holiday is Sat./Sun./Mon. and it's Saturday, there will be no shabbat_havdalah value. See comments in hdate library for details.) - `upcoming_shabbat_havdalah`: The time of havdalah for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat. If it is currently a three-day holiday, this value *could* be None (i.e., if holiday is Sat./Sun./Mon. and it's Saturday, there will be no `shabbat_havdalah` value. See comments in hdate library for details.)
- upcoming_candle_lighting: The time of candle lighting for either the current Shabbat OR Yom Tov, or the immediately upcoming Shabbat OR Yom Tov. If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night, this reports the candle lighting for Rosh Hashana on Monday night. This avoids a situation of triggering pre-candle-lighting automations while it is currently Yom Tov. To always get the Shabbat times, use the upcoming_shabbat_candle_lighting sensor. - `upcoming_candle_lighting`: The time of candle lighting for either the current Shabbat OR Yom Tov, or the immediately upcoming Shabbat OR Yom Tov. If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night, this reports the candle lighting for Rosh Hashana on Monday night. This avoids a situation of triggering pre-candle-lighting automations while it is currently Yom Tov. To always get the Shabbat times, use the `upcoming_shabbat_candle_lighting` sensor.
- upcoming_havdalah: The time of havdalah for either the current Shabbat OR Yom Tov, or the immediately upcoming Shabbat OR Yom Tov. If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night, this reports the havdalah for Rosh Hashana on Wednesday night. To always get the Shabbat times, use the upcoming_shabbat_havdalah sensor. - `upcoming_havdalah`: The time of havdalah for either the current Shabbat OR Yom Tov, or the immediately upcoming Shabbat OR Yom Tov. If, for example, today is Sunday, and Rosh Hashana is Monday night through Wednesday night, this reports the havdalah for Rosh Hashana on Wednesday night. To always get the Shabbat times, use the `upcoming_shabbat_havdalah` sensor.
### Binary sensors ### Binary sensors
- 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.
- `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 sensor ### Holiday sensor
@ -97,52 +98,50 @@ The *type_id* is useful for cases to condition automations based on a range of t
The following is the list of holidays the sensor knows about with their selected type: The following is the list of holidays the sensor knows about with their selected type:
| ID | English | Hebrew | Type | Type_ID |
|----------------------|----------------------------|-----------------------|---------------------------|:-------:|
| erev_rosh_hashana | Erev Rosh Hashana | ערב ראש השנה | EREV_YOM_TOV | 2 |
| rosh_hashana_i | Rosh Hashana I | א' ראש השנה | YOM_TOV | 1 |
| rosh_hashana_ii | Rosh Hashana II | ב' ראש השנה | YOM_TOV | 1 |
| tzom_gedaliah | Tzom Gedaliah | צום גדליה | FAST_DAY | 5 |
| erev_yom_kippur | Erev Yom Kippur | עיוה"כ | EREV_YOM_TOV | 2 |
| yom_kippur | Yom Kippur | יום הכפורים | YOM_TOV | 1 |
| erev_sukkot | Erev Sukkot | ערב סוכות | EREV_YOM_TOV | 2 |
| sukkot | Sukkot | סוכות | YOM_TOV | 1 |
| hol_hamoed_sukkot | Hol hamoed Sukkot | חול המועד סוכות | HOL_HAMOED | 3 |
| hoshana_raba | Hoshana Raba | הושענא רבה | EREV_YOM_TOV | 2 |
| simchat_torah | Simchat Torah | שמחת תורה | YOM_TOV | 1 |
| chanukah | Chanukah | חנוכה | MELACHA_PERMITTED_HOLIDAY | 4 |
| asara_btevet | Asara B'Tevet | צום עשרה בטבת | FAST_DAY | 5 |
| tu_bshvat | Tu B'Shvat | ט"ו בשבט | MINOR_HOLIDAY | 7 |
| taanit_esther | Ta'anit Esther | תענית אסתר | FAST_DAY | 5 |
| purim | Purim | פורים | MELACHA_PERMITTED_HOLIDAY | 4 |
| shushan_purim | Shushan Purim | שושן פורים | MELACHA_PERMITTED_HOLIDAY | 4 |
| erev_pesach | Erev Pesach | ערב פסח | EREV_YOM_TOV | 2 |
| pesach | Pesach | פסח | YOM_TOV | 1 |
| hol_hamoed_pesach | Hol hamoed Pesach | חול המועד פסח | HOL_HAMOED | 3 |
| pesach_vii | Pesach VII | שביעי פסח | YOM_TOV | 1 |
| yom_haatzmaut | Yom HaAtzma'ut | יום העצמאות | MODERN_HOLIDAY | 6 |
| lag_bomer | Lag B'Omer | ל"ג בעומר | MINOR_HOLIDAY | 7 |
| erev_shavuot | Erev Shavuot | ערב שבועות | EREV_YOM_TOV | 2 |
| shavuot | Shavuot | שבועות | YOM_TOV | 1 |
| tzom_tammuz | Tzom Tammuz | צום שבעה עשר בתמוז | FAST_DAY | 5 |
| tisha_bav | Tish'a B'Av | תשעה באב | FAST_DAY | 5 |
| tu_bav | Tu B'Av | ט"ו באב | MINOR_HOLIDAY | 7 |
| yom_hashoah | Yom HaShoah | יום השואה | MEMORIAL_DAY | 8 |
| yom_hazikaron | Yom HaZikaron | יום הזכרון | MEMORIAL_DAY | 8 |
| yom_yerushalayim | Yom Yerushalayim | יום ירושלים | MODERN_HOLIDAY | 6 |
| shmini_atzeret | Shmini Atzeret | שמיני עצרת | YOM_TOV | 1 |
| pesach_viii | Pesach VIII | אחרון של פסח | YOM_TOV | 1 |
| shavuot_ii | Shavuot II | שני של שבועות | YOM_TOV | 1 |
| sukkot_ii | Sukkot II | שני של סוכות | YOM_TOV | 1 |
| pesach_ii | Pesach II | שני של פסח | YOM_TOV | 1 |
| family_day | Family Day | יום המשפחה | ISRAEL_NATIONAL_HOLIDAY | 9 |
| memorial_day_unknown | Memorial day for fallen whose place of burial is unknown | יום הזיכרון לחללי מערכות ישראל שמקום קבורתם לא נודע | MEMORIAL_DAY | 8 |
| rabin_memorial_day | Yitzhak Rabin memorial day | יום הזכרון ליצחק רבין | MEMORIAL_DAY | 8 |
| zeev_zhabotinsky_day | Zeev Zhabotinsky day | יום זאב ז'בוטינסקי | MEMORIAL_DAY | 8 |
| ID | English | Hebrew | Type | ## Full configuration example
|----------------------|----------------------------|-----------------------|--------------------------------|
| erev_rosh_hashana | Erev Rosh Hashana | ערב ראש השנה | EREV_YOM_TOV (2) |
| rosh_hashana_i | Rosh Hashana I | א' ראש השנה | YOM_TOV (1) |
| rosh_hashana_ii | Rosh Hashana II | ב' ראש השנה | YOM_TOV (1) |
| tzom_gedaliah | Tzom Gedaliah | צום גדליה | FAST_DAY (5) |
| erev_yom_kippur | Erev Yom Kippur | עיוה"כ | EREV_YOM_TOV (2) |
| yom_kippur | Yom Kippur | יום הכפורים | YOM_TOV (1) |
| erev_sukkot | Erev Sukkot | ערב סוכות | EREV_YOM_TOV (2) |
| sukkot | Sukkot | סוכות | YOM_TOV (1) |
| hol_hamoed_sukkot | Hol hamoed Sukkot | חול המועד סוכות | HOL_HAMOED (3) |
| hoshana_raba | Hoshana Raba | הושענא רבה | EREV_YOM_TOV (2) |
| simchat_torah | Simchat Torah | שמחת תורה | YOM_TOV (1) |
| chanukah | Chanukah | חנוכה | MELACHA_PERMITTED_HOLIDAY (4) |
| asara_btevet | Asara B'Tevet | צום עשרה בטבת | FAST_DAY (5) |
| tu_bshvat | Tu B'Shvat | ט"ו בשבט | MINOR_HOLIDAY (7) |
| taanit_esther | Ta'anit Esther | תענית אסתר | FAST_DAY (5) |
| purim | Purim | פורים | MELACHA_PERMITTED_HOLIDAY (4) |
| shushan_purim | Shushan Purim | שושן פורים | MELACHA_PERMITTED_HOLIDAY (4) |
| erev_pesach | Erev Pesach | ערב פסח | EREV_YOM_TOV (2) |
| pesach | Pesach | פסח | YOM_TOV (1) |
| hol_hamoed_pesach | Hol hamoed Pesach | חול המועד פסח | HOL_HAMOED (3) |
| pesach_vii | Pesach VII | שביעי פסח | YOM_TOV (1) |
| yom_haatzmaut | Yom HaAtzma'ut | יום העצמאות | MODERN_HOLIDAY (6) |
| lag_bomer | Lag B'Omer | ל"ג בעומר | MINOR_HOLIDAY (7) |
| erev_shavuot | Erev Shavuot | ערב שבועות | EREV_YOM_TOV (2) |
| shavuot | Shavuot | שבועות | YOM_TOV (1) |
| tzom_tammuz | Tzom Tammuz | צום שבעה עשר בתמוז | FAST_DAY (5) |
| tisha_bav | Tish'a B'Av | תשעה באב | FAST_DAY (5) |
| tu_bav | Tu B'Av | ט"ו באב | MINOR_HOLIDAY (7) |
| yom_hashoah | Yom HaShoah | יום השואה | MEMORIAL_DAY (8) |
| yom_hazikaron | Yom HaZikaron | יום הזכרון | MEMORIAL_DAY (8) |
| yom_yerushalayim | Yom Yerushalayim | יום ירושלים | MODERN_HOLIDAY (6) |
| shmini_atzeret | Shmini Atzeret | שמיני עצרת | YOM_TOV (1) |
| pesach_viii | Pesach VIII | אחרון של פסח | YOM_TOV (1) |
| shavuot_ii | Shavuot II | שני של שבועות | YOM_TOV (1) |
| sukkot_ii | Sukkot II | שני של סוכות | YOM_TOV (1) |
| pesach_ii | Pesach II | שני של פסח | YOM_TOV (1) |
| family_day | Family Day | יום המשפחה | ISRAEL_NATIONAL_HOLIDAY (9) |
| memorial_day_unknown | Memorial day for fallen whose place of burial is unknown | יום זכרון... | MEMORIAL_DAY (8) |
| rabin_memorial_day | Yitzhak Rabin memorial day | יום הזכרון ליצחק רבין | MEMORIAL_DAY (8) |
| zeev_zhabotinsky_day | Zeev Zhabotinsky day | יום ז'בוטינסקי | MEMORIAL_DAY (8) |
## Full configuration sample
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry