guille-mas-coll / anniversaries

Anniversary Countdown Sensor for Home Assistant

Anniversaries

The 'anniversaries' component is a Home Assistant custom sensor which counts down to a recurring date such as birthdays, but can be used for any anniversary which occurs annually on the same date.

1.0.0 includes BREAKING CHANGES read the release notes.

Table of Contents

• Installation
  • Manual Installation
  • Installation via HACS
• Configuration
  • Configuration Parameters
• State and Attributes
  • State
  • Attributes
  • Notes about unit of measurement

Installation

MANUAL INSTALLATION

1. Download the anniversaries.zip file from the latest release.
2. Unpack the release and copy the custom_components/anniversaries directory into the custom_components directory of your Home Assistant installation.
3. Configure the anniversaries sensor.
4. Restart Home Assistant.

INSTALLATION VIA HACS

1. Ensure that HACS is installed.
2. Search for and install the "anniversaries" integration.
3. Configure the anniversaries sensor.
4. Restart Home Assistant.

Configuration

Anniversaries can be configured on the integrations menu or in configuration.yaml

Config Flow

In Configuration/Integrations click on the + button, select Anniversaries and configure the options on the form.

configuration.yaml

Add anniversaries sensor in your configuration.yaml. The following example adds two sensors - Shakespeare's birthday and wedding anniversary!

# Example configuration.yaml entry

anniversaries:
  sensors:
  - name: Shakespeare's Birthday
    date: '1564-04-23'
  - name: Shakespeare's Wedding Anniversary
    date: '1582-11-27'

CONFIGURATION PARAMETERS

Parameter	Optional	Description
name	No	Friendly name
date	No	date in format 'YYYY-MM-DD' (or 'MM-DD' if year is unknown)
icon_normal	Yes	Default icon Default: mdi:calendar-blank
icon_today	Yes	Icon if the anniversary is today Default: mdi:calendar-star
days_as_soon	Yes	Days in advance to display the icon defined in icon_soon Default: 1
icon_soon	Yes	Icon if the anniversary is 'soon' Default: mdi:calendar
date_format	Yes	formats the returned date Default: '%Y-%m-%d' for reference, see http://strftime.org/
show_half_anniversary	Yes	true or false. Enables the half_anniversary_date and days_until_half_anniversary attributes. Default: false

State and Attributes

State

• The number of days remaining to the next occurance.

Attributes

• years at next anniversary: number of years that will have passed at the next occurrence (NOT displayed if year is unknown)
• current years: number of years have passed since the first occurance (ie, current age) (NOT displayed if year is unknown)
• date: The date of the first occurence (or the date of the next occurence if year is unknown) (formatted by the date_format attribute if set)
• weeks_remaining: The number of weeks until the anniversary
• unit_of_measurement: 'Days' By default, this is displayed after the state. this is NOT translate-able. See below for work-around
• half_anniversary_date: The date of the next half anniversary (if enabled by show_half_anniversary)
• days_until_half_anniversary: The number of days until the next half anniversary

Notes about unit of measurement

Unit_of_measurement is not translate-able. You can, however, change the unit of measurement with a customization. There are two ways to do this:

• NOTE that each sensor would require it's own customization

This example would replace Days with Dias

• In customize.yaml:

  sensor.your_sensor_id:
    unit_of_measurement: Dias

• Use the Customizations from the Configuration menu:

  1. Select your sensor
  2. under "Pick an attribute to override" select unit_of_measurement
  3. Type Dias in the box
  4. Press save