Send a mobile notification when add-on update is available
Description​
Send a notification to the provided mobile devices whenever an update for the given Home Assistant add-on is available. Supports full notification customization, notification groups, auto-dismissal when the add-on is updated and button for starting the update directly from your notification tray, with optional notification after the update completed succesfully. This blueprint doesn't require any additional sensor to be manually set up, since it uses the built-in add-on sensors introduced with the Supervisor integration starting from Home Assistant Core 2021.4.0.
Requirements​
Home Assistant Supervisor + Integration
RequiredTo use this blueprint you must have an Home Assistant instance running installed as Home Assistant Managed OS or Home Assistant Supervised. You can learn more about Home Assistant installation methods in the
You must also have the Home Assistant Supervisor integration enabled and correctly set up. This is available and enabled by default starting from Home Assistant Core 2021.4.0.
Moreover, add-on sensors are disabled by default in the Supervisor integration. Please make sure to enable the following entities for the add-on you plan to track before setting up this blueprint:
sensor.<addon>_version
sensor.<addon>_newest_version
binary_sensor.<addon>_update_available
How to enable add-on entities​
- Navigate to Configuration -> Integrations in your Home Assistant UI. You can click the following button to navigate to the Integrations dashboard for your installation.
2. Click on Entities in the Home Assistant Supervisor card you find in the Integrations page. You'll be presented with a table of entities exposed by the Supervisor integration. 3. Select all the entities you want to use with this blueprint, then hit Enable Selected on the top right of the table. 4. You've succesfully enabled the add-on entities required by this blueprint.
Mobile App Integration
RequiredThis integration provides the service to send notification to mobile devices. This should be activated by default so unless you tweaked the default configuration you're good to go.
Home Assistant Companion App
RequiredThe official mobile app for Home Assistant. Make sure to have the Home Assistant Companion App installed and configured on mobile devices you plan to use for this automation.
Notify Group Integration
RequiredIf you want to simultaneously send the notification to multiple devices, you can define a notification group using this integration in your configuration.yaml
, then provide the service for the notification group in the Mobile devices notification service input. This integration should be enabled by default. More on how to setup notification groups in the official docs.
Inputs​
The add-on to monitor for updates.
The add-on name to be displayed in notifications.
The add-on current version sensor, exposed by the Supervisor.
The add-on newest version sensor, exposed by the Supervisor.
The add-on update available sensor, exposed by the Supervisor.
The notification service for mobile devices (eg. service.mobile_app_<your_device_id_here>). You can provide both a notify group or a single notify device here.
Title for the update notification. You can use {{ version }}, {{ newest_version }}, and {{ addon_name }} templates to include add-on current version, newest version and name respectively.
Message for the update notification. You can use {{ version }}, {{ newest_version }}, and {{ addon_name }} templates to include add-on current version, newest version and name respectively.
URL you will navigate to when tapping on the notification. Default to the add-on info page.
Color for the notifications. You can both type a friendly color name or an hex value.
Android notification channel. Allows to group notifications to then apply custom settings for sound, vibration, etc. Leave blank if you do not want to use this feature.
Android notification channel importance. Allows to define different priority levels for your notifications.
Notification group for the notifications sent with this automation. Use this to group notifications in the notification tray. Leave blank if you do not want to use this feature.
Add a button to the notification for updating the add-on.
Send a notification after the add-on update triggered by the update button succeed. The notification will use the same settings for group, channel, importance and color from the update available notification.
Title for the update success notification. You can use {{ version }}, {{ newest_version }}, and {{ addon_name }} templates to include add-on current version, newest version and name respectively.
Message for the update success notification. You can use {{ version }}, {{ newest_version }}, and {{ addon_name }} templates to include add-on current version, newest version and name respectively.
Additional Notes​
Please be aware that if you use notification groups which include both iOS and Android devices, some features (like Android Channels and notification groups) won't work. More details in the Home Assistant Companion App Docs.
Changelog​
- 2021-04-25: first blueprint version 🎉
- 2021-10-26: Standardize blueprints structure and inputs naming across the whole collection. Improve blueprint documentation. No functionality change.