Holidays

December 28, 2023 ยท View on GitHub

hacs_badge Holidays Maintenance

End of Support

Home Assistant has introduced native holiday integration in the 2024.1 release. I have therefore ended developing this custom integration.

Holidays

The holidays component is a Home Assistant helper that creates calendar entities with a list of public holidays in a country, based on the Python Holidays library. It's primary purpose is to work with garbage_collection helper to automatically move entities with manual_update automation blueprints. But it can also be used independently to show the next public holiday in a given country (or multiple countries).

Table of Contents

Installation

MANUAL INSTALLATION

  1. Download the latest release.
  2. Unpack the release and copy the custom_components/holidays directory into the custom_components directory of your Home Assistant installation.
  3. Restart Home Assistant.
  4. Add the Holidays helper

INSTALLATION VIA Home Assistant Community Store (HACS)

  1. Ensure that HACS is installed.
  2. Search for and install the "Holidays" integration.
  3. Restart Home Assistant.
  4. Go to Settings/Devices & Services/Helpers hit the + CREATE HELPER button and and add the Holidays helper.
  5. Configure the parameters
  6. If you would like to add more than 1 calendar, click on the + CREATE HELPER button again and add another Holidays helper instance.

Parameters

ParameterRequiredDescription
CountryYesCountry holidays - the country code (see holidays for the list of valid country codes).
Example: US
ObservedNoObserved - when holidays are celebrated on dates that are not the actual event's anniversary date (see holidays ).
SubdivisionNoState/Province/District... (see holidays ).
Pop named holidaysNoIgnore holidays (select from the list of holiday names) Example: "Columbus Day", "Veterans Day"

State and Attributes

state

The State contains the number of days to the next country holiday. It is 0 if today is a public holiday.

Attributes

AttributeDescription
next_dateThe date of the next holiday
next_holidayThe name of the next holiday
holidaysList of country holidays (last year, this year, and next year). This is used by the garbage_collection blueprints to offset collections if they fall on a public holiday (or if the holiday was earlier on in the week)