info.md

Home assistant binary sensor component to indicate if today is a german vacational day or not

{% if not installed %}

Installation

1. Click install.
2. Add ferienapidotde to your configuration.yaml

binary_sensor:
  - platform: ferienapidotde
    state_code: HH  # Federal state of Hamburg

{% endif %}

Configuration

To integrate ferienapidotde to your Home Assistant instance, you need to add the following section to your configuration.yaml:

Minimal example:

binary_sensor:
  - platform: ferienapidotde
    state_code: HH

Full example:

Not so much you can do here but for the sake of completness.

  - platform: ferienapidotde
    name: Vacation (HH)
    state_code: HH
    days_offset: 1  # Offset = 1 -> Is there any vacation tomorrow? Can be negative as well!

A list of all valid abbreviations for the german federal states can be found here: https://www.datenportal.bmbf.de/portal/de/G122.html

If you want to monitor multiple states you have to setup multiple sensors:

binary_sensor:
  - platform: ferienapidotde
    name: Vacation (HH)
    state_code: HH
  - platform: ferienapidotde
    name: Vacation (SH)
    state_code: SH
  - platform: ferienapidotde
    name: Vacation (HH) + 3 days
    days_offset: 3
    state_code: HH

---