HSBuddy lets you send notifications to your mobile devices as part of your HS3 automation events. You can send notifications to a specific mobile device or to all mobile devices registered with your HS3 server.
This feature requires installing the HSBuddy plugin on your HomeSeer server, as detailed in the Installing HSBuddy section.
The HSBuddy application running in your phone or tablet registers with your HS3 server after a connection is established. As part of this registration, the device name and its push notification identifier are saved in the HSBuddy Plugin configuration. On your HS3 server website, go to the PLUG-INS menu and select Clients under HSBuddy. That page will show you a list of registered mobile devices, indicating which ones are able to receive push notifications.
When configuring Events in your HS3 server, you can add a step to any event to send a notification by following these steps:
You can use replacement variables to insert special values as part of the text of the notification. The table below describes the replacement variables that are supported. The variable names are case sensitive.
|$time||Current time||$time||3:02:15 AM|
|$$DVA:addr:||Value of device at address addr||$$DVA:R4:||15|
|$$DVC:code:||Value of device with code code||$$DVC:ABC123:||15|
|$$DVR:ref:||Value of device with reference number ref||$$DVR:58:||15|
|$$DSA:addr:||Status of device at address addr||$$DVA:R4:||Dim 15%|
|$$DSC:code:||Status of device with code code||$$DVC:ABC123:||Dim 15%|
|$$DSR:ref:||Status of device with reference number ref||$$DVR:58:||Dim 15%|
|$$DTA:addr:||String of device at address addr||$$DVA:R4:||Some text|
|$$DTC:code:||String of device with code code||$$DVC:ABC123:||Some text|
|$$DTR:ref:||String of device with reference number ref||$$DVR:58:||Some text|
|$$COUNTER:name:||Value of counter called name||$$COUNTER:MyCounter:||123|
|$$TIMER:name:||Value of timer called name||$$TIME:MyTimer:||01:30:00|
|$$VAR:name:||Value of global variable called name||$$VAR:MyVariable:||Any value|
When sending a notification there are a few additional options you can configure:
Send with high priority - This option is applicable to Android devices only. When selected, the notification will be marked as high priority. In Android 6+ devices, when the device is in doze mode, notification delivery may be delayed to conserve battery. High priority notifications will wake up a sleeping device when necessary. Google may impose a limit on how many high priority notifications may be delivered to a device daily, after which subsequent notifications will be downgraded to normal priority. Use this option carefully.
Collapse repeated notifications - When this option is selected, only the latest instance of the notification will be visible in a device. If multiple notifications are received, earlier notifications are collapsed.
Suppress when app is in foreground - When this option is selected, notifications will not be shown if the app is in the foreground when the notification is received. Normally, notifications will be shown as a pop-up in the app.
You can configure what happens when you interact with a notification from your device. There are 2 type of actions that can be associated with a notification:
|Launch app||Opens up HSBuddy on its default startup screen||Not available as action button|
|Show device||Opens up HSBuddy in the detail view of a specific device|
|Show event||Opens up HSBuddy in the detail view of a specific event|
|Show camera||Opens up HSBuddy in the fullscreen view of a specific camera||It may include a camera snapshot (see below)|
|Show dashboard||Opens up HSBuddy into a given dashboard||Dashboard must have been previously downloaded to the device|
|Show favorite devices||Opens up HSBuddy into a given favorite list||List must have been previously downloaded to the device|
|Control device||Sets a device to a given value without opening HSBuddy|
|Run event||Runs an event without opening HSBuddy|
When you set the default action of a notification to open up a camera, you will be given the option to include a snapshot of the camera along with the notification. The snapshot will be taken at the time the notification is generated.
You can send notifications to your HSBuddy clients via a script or using the JSON API. You can use the plug-in function called
SendNotification which takes the following parameters:
||ID of the destination client or null/empty to send it to all clients|
||Text of the notification. You can use replacement variables (see previous section)|
You can obtain the ID of your HSBuddy clients by going to the Clients page in HS3 (under PLUG-INS -> HSBuddy) and click on the following icon:
The following is an example JSON API call to send a notification.
1. Traffic blockers may need additional configuration
If you use a traffic blocker on your HS3 server, it may block requests initiated by the Plug-in to deliver push notifications to your mobile devices. If you are using a traffic blocker and the notifications aren’t working, make sure the following domain is added to the whitelist of allowed websites: https://onesignal.com