HSBuddy

A mobile client for HomeSeer

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.

How does it work?

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.

You must give HSBuddy app on your mobile phone permission to receive notifications. Please follow the instructions relevant to your mobile device brand and model, for Apple iOS or Google Android

Sending notifications

When configuring Events in your HS3 server, you can add a step to any event to send a notification by following these steps:

  1. From the drop-down of available actions, choose the one called HSBuddy: Send Push Notification
  2. From the second drop-down of available devices, choose the mobile device you want to deliver the notification to. You can also choose –All Devices– if you want the notification to be delivered to all registered mobile devices.
  3. Enter the message for your notification in the text box

Event configuration

Using replacement variables

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.

Variable Replacement Example Output
$date Curent date $date 6/1/2009
$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

Delivery options

When sending a notification there are a few additional options you can configure:

Notification actions

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:

Available actions

Action type Description Note
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  

Camera snapshots

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.

Camera snapshot

Script and JSON API access

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:

Parameter Description
P1 ID of the destination client or null/empty to send it to all clients
P2 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: ID

The following is an example JSON API call to send a notification.

http://localhost/JSON?P1=73D45EBF-A969-4504-8451-EC57DE73CEA6&P2=HelloWorld&function=SendNotification&plugin=HSBuddy&request=pluginfunction

Known issues

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