Version 2.0.1
Latest Version | Github Link | Compare Changes
Forked from Home Assistantās Confirmable Notifications
Features:
š² Sends notification to Home Assistant Companion
Up to 3 customisable, action buttons (Previously: Confirm and Dismiss Button)
āļø Timeout actions with custom duration, fired if no option response received
š§¹ Clear notification after timeout
šø Camera Snapshots
š Custom Notification Link
š Flexible script fields
š Supports iOS
š¤ Supports Android
Inspiration:
- Easy to create actionable notifications with a timeout feature.
- Simple script blueprint, to be used with other automations or scripts.
- Compatible with iOS and Android.
Notes:
- Use at your own risk, no guarantees provided; itās my first publicly shared blueprint.
- Instructions and explanations are provided for each input.
- Requirements:
Home Assistant 2023.11.0
or newer- iOS:
Home Assistant Companion 2023.4
or newer - Android:
Home Assistant Companion 2023.8.2
or newer
How To Use:
TL;DR
Create a notification script from this blueprint, then call the created notification script from other automations/scripts.
This blueprint is a script that makes configuration of notifications easier.
It is meant to be paired with a separate automation or script of your choosing.
Show/Hide: How to create a notification script
-
Create a new script using the blueprint youāve just imported by clicking on it:
-
Give your new script a meaningful name, and configure your required features.
Quick Example:- Name: āMy Test Notificationā
- Device to notify: āMy iPhoneā
- Message: āThis is a test notification!ā
-
Click on
Save Script
to ensure your new script is created. Once your script has been created and saved, theSave Script
button should slide out of your screen.
-
Now, test that your script is working!
You may do so from the dropdown menu found on the top right of your scriptās configuration page.
-
Optionally configure the other options based on your requirements.
Show/Hide: How to use this notification script from other automations or scripts
-
Ensure that you have a working script that has already been configured.
If you need help on creating your script, refer to the collapsible section above. -
Navigate to the automation or script that will trigger your notification.
In the following examples, an empty automation will be used as a guide, feel free to tweak as required. -
Add an action, this action can be nested in other conditional actions if required, as per normal automation or script behaviour.
-
Search for your script in the menu.
-
You may now save your automation
-
Test that your automation successfully sends the notification by running it manually.
Similar to testing your notification script, you can run the automation actions manually without having any triggers or conditions checked.
The actions can be run manually via the dropdown menu, on the top right of the configuration page.
-
Feel free to modify your automation, or create as many as you require.
Examples:
When the last user leaves home, send a notification to last user:
Show/Hide: Simple leave home alert
- Title:
My Awesome Home
- Message:
Turning off lights and appliances in 5 minutes
- First Action Text:
Leave it on
- First Action Action:
Do nothing
- Second Action Text:
Turn off now
- Second Action Action:
Run turn off script
- Timeout Duration:
5 minutes
- Timeout Action:
Run turn off script
- Clear on Timeout:
Clear Notification
Other examples:
Experimental Variants
Experimental variants are versions spun off to support specifically requested features.
These variants may or may not be merged to the main
branch
These variants might affect stability of other core features.
-
Multi-device Variant
Import Variant | Github Link | Compare Changes- Send notifications to multiple devices.
Changelog and previous versions
Version 2.0.1 - 20 Dec 2023
Import Version | Github Link | Compare Changes
- Fixed:
Custom Tag
andGroups
not being set properly.
See previous changelogs
Version 2 - 12 Dec 2023
Import Version | Github Link | Compare Changes
Version 2.0 Changelog
- Fixed: iOS showing
Failed to load attachment
- Refactor: Build payload in templates
- Deprecated:
š² Notification Strategy
due to refactor. - Deprecated:
š² Service to notify
due to refactor. - Added: Support for fields
- Added:
š·ļø Title
field - Added:
š¬ Message
field - Added:
š·ļø Subtitle
field - Added:
šø Attachment: Camera Entity: Camera Entity
field - Added: Options show/hide fields
- Added:
āļø Enable Timeout
andāļø Enable Timeout Action(s)
fields.
- Added:
- Added:
š Show on Android Auto
option. - Added:
āļø Enable Timeout Action(s)
option and field.
Notes:
- When enabling boolean fields with value of false, be sure to toggle them to true once, and then to false.
There seems to be a bug where the boolean value is not passed if itās enabled and value is false without the toggle.- If you rely on
š² Service to notify
, do not upgrade,Version 1.6.1
will be the last version supporting that feature.
Version 1.6.1 - 26 Oct 2023
Import Version | Github Link | Compare Changes
- Fixed: Camera Snapshots not showing
Version 1.6 - 26 Oct 2023
Import Version | Github Link | Compare Changes
Version 1.6 Changelog
- Added: Show/Hide options toggle
- Added: URI action options and iOS specific action options
- Added: Third option
Version 1.5 - 11 Oct 2023
Import Version | Github Link | Compare Changes
Version 1.5 Changelog
- Updated: Deprecated device selector
- Added: Notification Attachments
- Added: Notification Strategy
- Added: Prefix for option icons
- Updated: Blueprint descriptions
Version 1.4 - 7 Jul 2023
Import Version | Github Link | Compare Changes
Version 1.4 Changelog
- Reverted: Send clear notification command - for iOS compatibility.
- Added:
subtitle
,group
,visibility
. - Refactor:
tag
is no longer recommended, will useentity_id
by default. - Fixed: During a timeout, the script throws error into logs due to checking attribs of
None
type.
Version 1.3.2 - 28 Jun 2023
Import Version | Github Link | Compare Changes
Version 1.3.2 Changelog
- Added:
Action Icons
-ļ£æ iOS Only
- Thanks @ChrisMancini - Fixed: Missing default values for a couple of inputs
- Updated: Input description style
Known Issues:
- iOS Notifications do not respect
Clear after Timeout
, issue since version 1.3, slated for fix in version 1.4 (Mid July) - Scripts created from blueprint always defaults to
mode: single
, bug raised with Home Assistant and fixed, hopefully this will be resolved in future releases.
Update your instances manually if youāre facing any issues with sending multiple notifications within your timeout duration.
Version 1.3.1 - 10 Jun 2023
Import Version | Github Link | Compare Changes
Version 1.3.1 Changelog
- Fixed:
Enable Icon Color
- Updated:
Icon Color
hex template
Version 1.3 - 9 Jun 2023
Import Version | Github Link | Compare Changes
Version 1.3 Changelog
- Fixed: Incorrect property used for timeout enablement.
- Added: Icon Color picker - Breaking Change
- Added: Notification Link - set a redirection link when you tap on the notification.
- Added: Device side notification clearing - clearing notifications will no longer get stuck!
Again, thanks to joe.cole1 for the insights in this minor release.
Also, thanks to RemyyB for identifying the incorrect variable and raising a PR, sorry for taking a week to fix this.
( Color picker is easy enough to configure, so it shouldnāt be absolutely breaking to warrant a major)
Version 1.2 - 30 May 2023
Import Version | Github Link | Compare Changes
Version 1.2 Changelog
- Added:
Icon
andIcon color
(Android Only) - Huge thanks to joe.cole1 - Added:
Enable Timeout
, controls command response timeout feature - Again, huge thanks to joe.cole1 for the insight
Version 1.1 - 25 March 2023
Import Version | Github Link | Compare Changes
Version 1.1 Changelog
- Updated:
Clear on Timeout
as boolean field - Fixed:
Persistent
notifications not working - Fixed:
Clear on Timeout
did not clear if a timeout happened
Version 1.0 - 24 March 2023
Version 1.0 Changelog
- Initial Release