Birthdays
This is a HomeAssistant component for tracking birthdays, where the state of each birthday is equal to how many days are left. All birthdays are updated at midnight.
Installation
HACS (recommended)
- Go to integrations
- Press the dotted menu in the top right corner
- Choose custom repositories
- Add the URL to this repository
- Choose category
Integration - Click add
Manual
- In your homeassistant config directory, create a new directory. The path should look like this: **my-ha-config-dir/custom_components
- Copy the contents of /custom_components in this git-repo to your newly created directory in HA
Set up
Set up the component:
# Example configuration.yaml entry
birthdays:
- name: 'Frodo Baggins'
date_of_birth: 1921-09-22
- name: 'Bilbo Baggins'
date_of_birth: 1843-09-22
- name: Elvis
date_of_birth: 1935-01-08
icon: 'mdi:music'
Restart homeassistant
Entities
All entities are exposed using the format birthdays.{name}. Any character that does not fit the pattern a-z, A-Z, 0-9, or _ will be changed. For instance Frodo Baggins will get entity_id frodo_baggins, and Swedish names like Sven-Göran Eriksson will get entity_id sven_goran_eriksson.
Automation
All birthdays are updated at midnight, and when a birthday occurs an event is sent on the HA bus that can be used for automations. The event is called birthday and contains the data name and age. Note that there will be two events fired if two persons have the same birthday.
Sending a push notification for each birthday (with PushBullet) looks like this:
automation:
trigger:
platform: event
event_type: 'birthday'
action:
service: notify.pushbullet
data_template:
title: 'Birthday!'
message: "{{ trigger.event.data.name }} turns {{ trigger.event.data.age }} today!"
If you want to trigger an automation based on a specific name or age, you can use the following:
automation:
trigger:
platform: event
event_type: 'birthday'
event_data:
name: Kalle
# age: 40
action:
service: notify.pushbullet
data_template:
title: 'Birthday!'
message: "{{ trigger.event.data.name }} turns {{ trigger.event.data.age }} today!"
If you want to have a notification sent to you at a specific time (instead of midnight), you can use a custom templated sensor and a time trigger. Create the sensor:
sensor:
- platform: template
sensors:
next_birthday:
friendly_name: "Next birthday"
value_template: >
{%- set ns = namespace(days=365) -%}
{%- for birthday in states.birthdays -%}
{%- set daysLeft = birthday.state | int -%}
{%- if daysLeft < ns.days -%}
{%- set ns.days = daysLeft -%}
{%- endif -%}
{%- endfor -%}
{{ ns.days }}
attribute_templates:
name: >
{%- set ns = namespace(days=365, name='') -%}
{%- for birthday in states.birthdays -%}
{%- set daysLeft = birthday.state | int -%}
{%- if daysLeft < ns.days -%}
{%- set ns.days = daysLeft -%}
{%- set ns.name = birthday.attributes.friendly_name -%}
{%- endif -%}
{%- endfor -%}
{{ ns.name }}
age: >
{%- set ns = namespace(days=365, age=0) -%}
{%- for birthday in states.birthdays -%}
{%- set daysLeft = birthday.state | int -%}
{%- if daysLeft < ns.days -%}
{%- set ns.days = daysLeft -%}
{%- set ns.age = birthday.attributes.age_at_next_birthday -%}
{%- endif -%}
{%- endfor -%}
{{ ns.age }}
and the automation:
automation:
trigger:
platform: time
at: "19:00:00"
condition:
condition: state
entity_id: sensor.next_birthday
state: 0
action:
service: notify.pushbullet
data_template:
title: 'Birthday!'
message: "{{ state_attr('sensor.next_birthday', 'name') }} turns {{ state_attr('sensor.next_birthday', 'age') }} today!"
Lovelace UI
I use the birthdays as a simple entity list in lovelace, given the above example I use:
# Example use in lovelace
- type: entities
title: Birthdays
show_header_toggle: false
entities:
- birthdays.frodo_baggins
- birthdays.bilbo_baggins
- birthdays.elvis