PLEASE READ CAREFULLY, THERE ARE CHANGES YOU NEED TO MAKE!
I am sorry for the inconvenience, I think going forward we have much more stable position.
BREAKING CHANGE
- You need to update the YAML configuration (or you can remove config from YAML completely and configure the sensors from Configuration/Integration page) - try it, it is cool I think.
- The
monthly_day_order_number
option was renamed toweekday_order_number
for better clarity. So if you usemonthly
frequency, you need to change the name of this parameter. - The implementation of permanent fix for #18 has two implications:
a) Change of theentity_id
is only possible if the sensor is configured from the Integration page. Previously, you could also change it if the sensor was configured in YAML - this is no longer possible. So if you need to change the entity_id (e.g. Japan), please migrate your config from YAML to Integration Page.
b) As a leftovers from the 'quick fix' for #18, there might be orphaned entities in the Configuration/Entity Registry. They will be typically using the default entity_ids, so new entities will be created with _2 at the end. To fix that, you need to remove the entities manually (see bellow).
CONFIG CHANGE
Old
sensor:
- platform: garbage_collection
name: 'Waste'
....
- platform: garbage_collection
name: 'Another waste'
....
New
garbage_collection:
sensors:
- name: 'Waste'
....
- name: 'Another waste'
....
RECOMMENDED UPDATE PROCEDURE
- Update integration
- Comment the integration configuration in YAML
- Restart HA
- Go to Configuration/Entity Registry and remove the Orphaned
garbage_collection
entities - Now you can either configure the sensors from Configuration/Integrations (hit the
+
button, selectGarbage Collection
and configure) - in such case, the sensors are added dynamically, no restart is required. Parameter changes are possible from the Integration page as well (the gear icon on top) - ...or, change the YAML configuration - restart Home Assistant.
NEW FATURES
- Configuration is now possible from Configuration/Integrations using Config Flow wizard. The configuration through YAML is still supported as well.
- Adding
annual
frequency for scheduling birthdays or similar annual events (Feature request #20) - Readme has been updated for better clarity.
Note: This has been major code re-factoring. Big thanks to @ludeeus for showing me the direction!