HazardDede/home-assistant-ferienapidotde

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

ferien-api.de binary sensor

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

Installation

HACS

1. Make sure the HACS component is installed and working.
2. Add this github repository https://github.com/HazardDede/home-assistant-ferienapidotde as custom integration repository in HACS settings.
3. Install the integration ferienapidotde and update home assistant configuration accordingly. You need to restart home assistant for the changes to take effect.

Manual

1. Copy the ferienapidotde folder into your custom_components folder that is located under the root of your home assistant config. If it does not exists you can create it (which probably means you never used a custom component before).
2. Throw down a minimal configuration

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

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

---