mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-22 08:46:51 +00:00
Updates docs for Jewish calendar (#10231)
* Updates docs for Jewish calendar Updates for PR https://github.com/home-assistant/home-assistant/pull/26200 * Update source/_components/jewish_calendar.markdown Co-Authored-By: Klaas Schoute <klaas_schoute@hotmail.com>
This commit is contained in:
Tsvi Mostovicz
Franck Nijhof
parent
9084527c32
commit
525f08e488
@ -1,6 +1,6 @@
|
||||
---
|
||||
title: "Jewish Calendar"
|
||||
description: "Instructions on how to integrate the Jewish Calendar sensor within Home Assistant."
|
||||
description: "Instructions on how to integrate the Jewish Calendar integration within Home Assistant."
|
||||
ha_category:
|
||||
- Calendar
|
||||
ha_iot_class: Local Polling
|
||||
@ -17,8 +17,7 @@ To enable this sensor in your installation, add the following to your `configura
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
sensor:
|
||||
- platform: jewish_calendar
|
||||
jewish_calendar:
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
@ -52,46 +51,33 @@ havdalah_minutes_after_sunset:
|
||||
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.
|
||||
default: 0
|
||||
type: integer
|
||||
sensors:
|
||||
description: List of available sensors.
|
||||
required: false
|
||||
default: date
|
||||
type: list
|
||||
keys:
|
||||
date:
|
||||
description: Show the hebrew date for today.
|
||||
weekly_portion:
|
||||
description: Show the weekly portion (parshat hashavu'a).
|
||||
holiday_name:
|
||||
description: If it is a holiday, show the name of the holiday.
|
||||
holyness:
|
||||
description: On a scale of 1 to 9 show the level of holyness _(see below)_.
|
||||
first_light:
|
||||
description: First light of dawn (Alot Hashachar - עלות השחר).
|
||||
gra_end_shma:
|
||||
description: Last time for reading of the Shma according to the GR"A.
|
||||
mga_end_shma:
|
||||
description: Last time for reading of the Shma according to the MG"A.
|
||||
plag_mincha:
|
||||
description: Time of the Plag Hamincha.
|
||||
first_stars:
|
||||
description: Time at which the first stars are visible (Tset Hakochavim - צאת הכוכבים).
|
||||
upcoming_shabbat_candle_lighting:
|
||||
description: The time of candle lighting for either the current Shabbat (if it is currently Shabbat) or the immediately upcoming Shabbat.
|
||||
upcoming_shabbat_havdalah:
|
||||
description: 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:
|
||||
description: 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:
|
||||
description: 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.
|
||||
issur_melacha_in_effect:
|
||||
description: 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.
|
||||
omer_count:
|
||||
description: An integer sensor indicating the day of the Omer (1-49) or 0 if it is not currently the Omer.
|
||||
|
||||
{% endconfiguration %}
|
||||
|
||||
### Holyness levels
|
||||
## Sensor list
|
||||
|
||||
### 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)_.
|
||||
- omer_count: An integer sensor indicating the day of the Omer (1-49) or 0 if it is not currently the Omer.
|
||||
|
||||
### Time sensors
|
||||
- first_light: First light of dawn (Alot Hashachar - עלות השחר).
|
||||
- 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.
|
||||
- plag_mincha: Time of the Plag Hamincha.
|
||||
- first_stars: Time at which the first stars are visible (Tset 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_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_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
|
||||
- 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
|
||||
|
||||
1. Mido'rayta - by Torah ordination (Rosh Hashana, Yom Kippur, Pesach, Shavuot, Sukkot)
|
||||
2. Erev Yom Tov
|
||||
@ -112,16 +98,4 @@ sensor:
|
||||
language: english
|
||||
diaspora: true
|
||||
havdalah_minutes_after_sunset: 50
|
||||
sensors:
|
||||
- date
|
||||
- weekly_portion
|
||||
- holiday_name
|
||||
- holyness
|
||||
- first_light
|
||||
- gra_end_shma
|
||||
- mga_end_shma
|
||||
- plag_mincha
|
||||
- first_stars
|
||||
- upcoming_candle_lighting
|
||||
- upcoming_havdalah
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user