rt400 / Jewish-Sabbaths-Holidays

Jewish Shabbat Yomtov and Holidays times and event
9 stars 1 forks source link
hacs holidays jewish sensor shabbat

hacs_badge

Jewish Sabbaths and Holidays Times integration for Home-Assistant

The Jewish-Sabbaths-Holidays platform uses the HebCal API to receive Shabbat times and the times of Jewish holidays, as well as the Hebrew date and the names of Jewish holidays (chagim).

Installation

To install the integration, first download all the files in this folder: https://github.com/rt400/Jewish-Sabbaths-Holidays/tree/master/custom_components/hebcal.

Then create a folder called hebcal in your HomeAssistant config/custom_components folder and copy all files that you already download.

In order to display the correct times, the sensor needs your geolocation. By default it receives this from the instance's configuration.yaml.

You can configure your geolocation as follows:

   homeassistant:
     latitude: 32.0667
     longitude: 34.7667
     time_zone: Asia/Jerusalem

If you don't know your geocoordinates, you can find them here.

The sensor also requires TimeZone to work.

To install using HACS (Home Assistant Community Store), add this repository to your HACS custom repositories and select type -> integration.

When it shows up, click Install.

Configuration

To enable hebcal times , just add the following lines to your configuration.yaml:

# Example configuration.yaml entry
sensor:
  - platform: hebcal
    resources:
      - shabbat_in
      - shabbat_out

Optional Configuration Variables

You can configure the time for havdala and the time for the entry of Shabbat by modifying the following parameters:

    - shabbat_in     # get shabbat entrace
    - shabbat_out    # get shabbat exit
    - parasha        # get parashat haShavoh
    - hebrew_date    # get the hebrew date on every day (changed in 00:00)
    - is_shabbat     # get if shabbat or not by True or False.
    - yomtov_in     # get yomtov entrace
    - yomtov_out    # get yomtov exit
    - is_yomtov     # get if yomtov or not by True or False.
    - yomtov_name    # get yomtov name.
    - event_name     # get event name.
    - omer_day       # get omer name.
    - zmanim       # get zmanim for the current day

Full configuration example

The following sample configuration shows a configuration with all the resources loaded:

# Example configuration.yaml entry
sensor:
  - platform: hebcal
    havdalah_calc: 42
    time_before_check: 10
    time_after_check: 1
    jerusalem_candle: False
    tzeit_hakochavim: False
    omer_count_type: 0
    language: english
    resources:
      - shabbat_in
      - shabbat_out
      - parasha
      - hebrew_date
      - is_shabbat
      - yomtov_in
      - yomtov_out
      - is_yomtov
      - yomtov_name
      - event_name
      - omer_day
      - zmanim

Good Luck !