Merge pull request #13 from Darknetzz/master

Added unique_id

Author: Miicroo

.gitignore

@@ -1 +1,2 @@
 **/.DS_Store
+.history

README.md

@@ -17,7 +17,7 @@ This is a HomeAssistant component for tracking birthdays, where the state of eac
 
 ## Set up
 Set up the component:
-~~~~
+```yaml
 # Example configuration.yaml entry
 birthdays:
   - name: 'Frodo Baggins'
@@ -27,17 +27,41 @@ birthdays:
   - name: Elvis
     date_of_birth: 1935-01-08
     icon: 'mdi:music'
-~~~~
+```
+
+You can also add a custom `unique_id` and attributes to each birthday, for instance to add an icon or other metadata.
+```yaml
+  - unique_id: bond_james_bond
+    name: James Bond
+    date_of_birth: 1920-05-25
+    icon: 'mdi:pistol'
+    attributes:
+      occupation: "Agent"
+      license_to_kill: "Yes"
+  - unique_id: einstein
+    name: 'Albert Einstein'
+    date_of_birth: 1879-03-14
+    icon: 'mdi:lightbulb-on'
+    attributes:
+      occupation: 'Theoretical physicist'
+      iq: 'Genius level'
+      sense_of_humor: 'Einsteinian'
+```
 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`](https://sv.wikipedia.org/wiki/Sven-G%C3%B6ran_Eriksson) will get entity_id `sven_goran_eriksson`.
+All entities that do not have a specified `unique_id` 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`](https://sv.wikipedia.org/wiki/Sven-G%C3%B6ran_Eriksson) will get entity_id `sven_goran_eriksson`.
+
+## Custom attributes
+You can add a unique id and custom attributes to each birthday, for instance to add an icon or other metadata.
+To do this, add a dictionary under the `attributes` key in the configuration (see example above). The dictionary can contain any key-value pairs you want, and will be exposed as attributes on the entity.
+Fetching the attributes can be done using `state_attr` in a template, for instance `{{ state_attr('birthdays.einstein', 'occupation') }}` will return `Theoretical physicist`.
 
 ## 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:
-~~~
+```yaml
 automation:
   trigger:
     platform: event
@@ -47,10 +71,10 @@ automation:
       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:
-~~~
+```yaml
 automation:
   trigger:
     platform: event
@@ -63,15 +87,17 @@ automation:
       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:
 ~~~
-template:
-  - sensor:
-      - name: "Next birthday"
-        state: >
+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 -%}
@@ -105,33 +131,10 @@ template:
                 {%- set ns.days = daysLeft -%}
               {%- endif -%}
             {%- endfor -%}
-            {%- for birthday in states.birthdays -%}
-              {%- set daysLeft = birthday.state | int -%}
-              {%- if daysLeft == ns.days -%}
-                {%- set ns.ages = ns.ages + [birthday.attributes.age_at_next_birthday] -%}
-              {%- endif -%}
-            {%- endfor -%}
-
-            {{ns.ages | join(', ')}}
-          birthday_message: >
-            {%- set ns = namespace(days=365, messages=[]) -%}
-            {%- for birthday in states.birthdays -%}
-              {%- set daysLeft = birthday.state | int -%}
-              {%- if daysLeft < ns.days -%}
-                {%- set ns.days = daysLeft -%}
-              {%- endif -%}
-            {%- endfor -%}
-            {%- for birthday in states.birthdays -%}
-              {%- set daysLeft = birthday.state | int -%}
-              {%- if daysLeft == ns.days -%}
-                {%- set ns.messages = ns.messages + [birthday.attributes.friendly_name + ' turns ' + (birthday.attributes.age_at_next_birthday | string) + ' today!'] -%}
-              {%- endif -%}
-            {%- endfor -%}
-
-            {{ns.messages | join('\n')}}
+            {{ ns.age }}
 ~~~
 and the automation:
-~~~
+```yaml
 automation:
   alias: Happy birthday
   trigger:
@@ -144,13 +147,13 @@ automation:
   action:
   - service: persistent_notification.create
     data_template:
-      title: Birthday!
-      message: '{{ state_attr(''sensor.next_birthday'', ''birthday_message'') }}'
-~~~
+      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:
-~~~
+```yaml
 # Example use in lovelace
 - type: entities
   title: Birthdays
@@ -159,4 +162,4 @@ I use the birthdays as a simple entity list in lovelace, given the above example
     - birthdays.frodo_baggins
     - birthdays.bilbo_baggins
     - birthdays.elvis
-~~~
+```

custom_components/birthdays/__init__.py

@@ -13,15 +13,20 @@
 
 _LOGGER = logging.getLogger(__name__)
 
+CONF_UNIQUE_ID = 'unique_id'
 CONF_NAME = 'name'
 CONF_DATE_OF_BIRTH = 'date_of_birth'
 CONF_ICON = 'icon'
+CONF_ATTRIBUTES = 'attributes'
+CONF_AGE_AT_NEXT_BIRTHDAY = 'age_at_next_birthday'
 DOMAIN = 'birthdays'
 
 BIRTHDAY_CONFIG_SCHEMA = vol.Schema({
-    vol.Required(CONF_NAME): cv.string,
-    vol.Required(CONF_DATE_OF_BIRTH): cv.date,
-    vol.Optional(CONF_ICON, default='mdi:cake'): cv.string,
+    vol.Optional(CONF_UNIQUE_ID): cv.string,
+    vol.Required(CONF_NAME) : cv.string,
+    vol.Required(CONF_DATE_OF_BIRTH) : cv.date,
+    vol.Optional(CONF_ICON, default = 'mdi:cake'): cv.string,
+    vol.Optional(CONF_ATTRIBUTES, default = {}) : vol.Schema({cv.string: cv.string}),
 })
 
 CONFIG_SCHEMA = vol.Schema({
@@ -33,10 +38,12 @@ async def async_setup(hass, config):
     devices = []
 
     for birthday_data in config[DOMAIN]:
+        unique_id = birthday_data.get(CONF_UNIQUE_ID)
         name = birthday_data[CONF_NAME]
         date_of_birth = birthday_data[CONF_DATE_OF_BIRTH]
         icon = birthday_data[CONF_ICON]
-        devices.append(BirthdayEntity(name, date_of_birth, icon, hass))
+        attributes = birthday_data[CONF_ATTRIBUTES]
+        devices.append(BirthdayEntity(unique_id, name, date_of_birth, icon, attributes, hass))
 
     component = EntityComponent(_LOGGER, DOMAIN, hass)
     await component.async_add_entities(devices)
@@ -45,28 +52,41 @@ async def async_setup(hass, config):
     tasks = [asyncio.create_task(device.update_data()) for device in devices]
     await asyncio.wait(tasks)
 
+    _LOGGER.debug(devices)
+
     return True
 
 
 class BirthdayEntity(Entity):
 
-    def __init__(self, name, date_of_birth, icon, hass):
+    def __init__(self, unique_id, name, date_of_birth, icon, attributes, hass):
         self._name = name
-        self._date_of_birth = date_of_birth
-        self._icon = icon
-        self._age_at_next_birthday = 0
+
+        if unique_id is not None:
+            self._unique_id = slugify(unique_id)
+        else: 
+            self._unique_id = slugify(name)
+
         self._state = None
-        name_in_entity_id = slugify(name)
-        self.entity_id = 'birthday.{}'.format(name_in_entity_id)
+        self._icon = icon
+        self._date_of_birth = date_of_birth
         self.hass = hass
 
+        self._extra_state_attributes = {
+            CONF_DATE_OF_BIRTH: str(self._date_of_birth),
+        }
+
+        if len(attributes) > 0 and attributes is not None:
+            for k,v in attributes.items():
+                self._extra_state_attributes[k] = v
+
     @property
     def name(self):
         return self._name
 
     @property
     def unique_id(self):
-        return '{}.{}'.format(self.entity_id, slugify(self._date_of_birth.strftime("%Y%m%d")))
+        return self._unique_id
 
     @property
     def state(self):
@@ -83,10 +103,7 @@ def icon(self):
 
     @property
     def extra_state_attributes(self):
-        return {
-            CONF_DATE_OF_BIRTH: str(self._date_of_birth),
-            'age_at_next_birthday': self._age_at_next_birthday,
-        }
+        return self._extra_state_attributes
 
     @property
     def unit_of_measurement(self):
@@ -115,12 +132,15 @@ async def update_data(self, *_):
 
         days_until_next_birthday = (next_birthday-today).days
 
-        self._age_at_next_birthday = next_birthday.year - self._date_of_birth.year
+        age = next_birthday.year - self._date_of_birth.year
+        self._extra_state_attributes[CONF_AGE_AT_NEXT_BIRTHDAY] = age
+
+        
         self._state = days_until_next_birthday
 
         if days_until_next_birthday == 0:
             # Fire event if birthday is today
-            self.hass.bus.async_fire(event_type='birthday', event_data={'name': self._name, 'age': self._age_at_next_birthday})
+            self.hass.bus.async_fire(event_type='birthday', event_data={'name': self._name, 'age': age})
 
         self.async_write_ha_state()
         async_call_later(self.hass, self._get_seconds_until_midnight(), self.update_data)