Jewish calendar component documentation (#6265)

* Initial commit for Jewosh calendar documentation * Minimize the configuration sample * Update 'ha_release'
2025-07-19 07:17:14 +00:00 · 2018-09-17 23:30:20 +03:00 · 2018-09-17 23:30:20 +03:00 · 2493f6970e
commit 2493f6970e
parent 0f1cdee7b0
1 changed files with 104 additions and 0 deletions
--- a/source/_components/sensor.jewish_calendar.markdown
+++ b/source/_components/sensor.jewish_calendar.markdown
@ -0,0 +1,104 @@
+---
+layout: page
+title: "Jewish Calendar"
+description: "Instructions on how to integrate the Jewish Calendar sensor within Home Assistant."
+date: 2018-09-09 00:00
+sidebar: true
+comments: false
+sharing: true
+footer: true
+logo: home-assistant.png
+ha_category: Calendar
+ha_iot_class: "Local Push"
+ha_release: "0.80"
+---
+
+The Jewish Calendar (`jewish_calendar`) sensor platform displays a variety of information related to the Jewish Calendar as a variety of sensors.
+
+## {% linkable_title Configuration %}
+
+To enable this sensor in your installation, add the following to your `configuration.yaml` file:
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+  - platform: jewish_calendar
+```
+
+{% configuration %}
+language:
+  required: false
+  default: hebrew
+  description: Whether to represent the sensors in Hebrew (א' תשרי תשע"ט) or English characters (1 Tishri 5779).
+  type: string
+latitude:
+  required: false
+  description: Latitude for time calculations of the sensor.
+  default: Home Assistant location
+  type: int
+longitude:
+  required: false
+  description: Longitude for time calculations of the sensor.
+  default: Home Assistant location
+  type: int
+disapora:
+  required: false
+  description: Consider the location as diaspora or not for calculation of the weekly portion and holidays.
+  default: False
+  type: string
+sensors:
+  required: false
+  default: date
+  description: List of available sensors.
+  keys:
+    date:
+      description: Show the hebrew date for today.
+    weekly_portion:
+      description: Show the weekly portion (parshat hashavu'a) - _At the moment only shows up on Saturday's_.
+    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 - צאת הכוכבים).
+{% endconfiguration %}
+
+### {% linkable_title Holyness levels %}
+
+1. Mido'rayta - by Torah ordination (Rosh Hashana, Yom Kippur, Pesach, Shavuot, Sukkot)
+2. Erev Yom Kippur
+3. Hol Hamo'ed
+4. Hanukka and Purim
+5. Fast days
+6. Yom Yerushalayim and Yom Haatsmaut
+7. 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.
+
+## {% linkable_title Full configuration sample %}
+
+```yaml
+# Example configuration.yaml entry
+sensor:
+  - platform: jewish_calendar
+    language: english
+    disapora: True
+    sensors:
+      - date
+      - weekly_portion
+      - holiday_name
+      - holyness
+      - first_light
+      - gra_end_shma
+      - mga_end_shma
+      - plag_mincha
+      - first_stars
+```