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

---

home-assistant-ferienapidotde's Issues

not longer working

Seems it is not longer working, i cant get any values form my sensors (running HA 2022.9.4)

main sensor shows only "off" but not anymore "start" and "end" vor next vacation as its was

Date Format and Vacation Name

is it possible to change the Date Formate (used it "next_start" and "next_end" from YYYY-MM-DD to DD.MM.YYYY ?

And modify the "vacation_name" to allways use uppercase letter for the first Letter of an Vacation name?
right now it says "weihnachtsferien" - cleaner would be "Weihnachtsferien"

Current look:

next_start: '2021-12-24'
next_end: '2022-01-08'
vacation_name: weihnachtsferien
friendly_name: Ferien (NRW)
icon: mdi:calendar-remove

wish it would look like this:

next_start: '24.12.2021'
next_end: '08.01.2022'
vacation_name: Weihnachtsferien
friendly_name: Ferien (NRW)
icon: mdi:calendar-remove

ferien-api.de url not available

Hello,

since today there seems to be an issue with the url ferien-api.de. The url is not reachable anymore.

Error after 2022.9.6 update

Logger: custom_components.ferienapidotde.binary_sensor
Source: custom_components/ferienapidotde/binary_sensor.py:81
Integration: ferienapidotde (documentation)
First occurred: 02:23:55 (103 occurrences)
Last logged: 07:22:13

Traceback (most recent call last): File "/mnt/dietpi_userdata/homeassistant/deps/lib/python3.9/site-packages/ferien/model.py", line 59, in _parse_date dt = datetime.strptime(candidate, '%Y-%m-%dT%H:%M') File "/home/homeassistant/.pyenv/versions/3.9.10/lib/python3.9/_strptime.py", line 568, in _strptime_datetime tt, fraction, gmtoff_fraction = _strptime(data_string, format) File "/home/homeassistant/.pyenv/versions/3.9.10/lib/python3.9/_strptime.py", line 349, in strptime raise ValueError("time data %r does not match format %r" % ValueError: time data '2021-02-01' does not match format '%Y-%m-%dT%H:%M' During handling of the above exception, another exception occurred: Traceback (most recent call last): File "/mnt/dietpi_userdata/homeassistant/custom_components/ferienapidotde/binary_sensor.py", line 77, in async_setup_platform await data_object.async_update() File "/mnt/dietpi_userdata/homeassistant/custom_components/ferienapidotde/binary_sensor.py", line 159, in async_update self.data = await ferien.state_vacations_async(self.state_code) File "/mnt/dietpi_userdata/homeassistant/deps/lib/python3.9/site-packages/ferien/async.py", line 58, in state_vacations_async return await convert_json(resp) File "/mnt/dietpi_userdata/homeassistant/deps/lib/python3.9/site-packages/ferien/async.py", line 30, in _convert_json res.append(Vacation.from_dict(entry)) File "/mnt/dietpi_userdata/homeassistant/deps/lib/python3.9/site-packages/ferien/model.py", line 71, in from_dict start=cls._parse_date(dct['start']), File "/mnt/dietpi_userdata/homeassistant/deps/lib/python3.9/site-packages/ferien/model.py", line 62, in _parse_date dt = datetime.strptime(candidate, '%Y-%m-%dT%H:%MZ') File "/home/homeassistant/.pyenv/versions/3.9.10/lib/python3.9/_strptime.py", line 568, in _strptime_datetime tt, fraction, gmtoff_fraction = _strptime(data_string, format) File "/home/homeassistant/.pyenv/versions/3.9.10/lib/python3.9/_strptime.py", line 349, in _strptime raise ValueError("time data %r does not match format %r" % ValueError: time data '2021-02-01' does not match format '%Y-%m-%dT%H:%MZ'

Info for next day

Is it possible to get information for the following day?

Manifest-Warning 'no version key'

HA shows warning:
No 'version' key in the manifest file for custom integration 'ferienapidotde'. As of Home Assistant 2021.6, this integration will no longer be loaded. Please report this to the maintainer of 'ferienapidotde'
Plaese integrate the version