Skip to main content

Programming

The driver adds actions to send messages and manage the inbox, and events for what happens to them. Some are named after your own setup: each template adds Send, Enable and Disable actions, each person and webhook adds Turn on and Turn off, and each button event name adds an event. They appear in Crestron Home programming after you save the setup, and keep working when you rename what they act on.

Actions​

ActionWhat it does
Send template nameSends that template.
Enable / Disable template nameSwitches that template on or off. A switched-off template isn't sent.
Turn on / Turn off person or webhook nameSwitches that person, webhook or ntfy topic on or off.
sendTemplate (template)Sends a template by name. Use it when the template name comes from elsewhere.
sendMessage (subject, body, level)Sends a message of your own. It goes to everyone whose level it reaches.
enableTemplate / disableTemplate (template)Switches a template on or off, by name. Use the named actions above unless the name comes from elsewhere.
enableNotifications / disableNotificationsThe master switch. Off, nothing is sent and nothing reaches the inbox.
enableRecipient / disableRecipient (person)Switches one person or webhook on or off, by name.
clearInboxClears every message that isn't protected.
markInboxReadMarks every message read.

Switching a template, a person or the master switch from programming is saved, and survives a restart.

Events​

EventFires when
Message receivedAny message is kept in the inbox.
Warning or critical message receivedA warning or critical message is kept in the inbox.
Critical message receivedA critical message is kept in the inbox.
Unread count changedA message arrives, is read or is cleared.
Inbox clearedThe inbox is cleared, from the panel, the setup app or programming.
Critical message acknowledged in PushoverSomeone acknowledges a critical Pushover message on their phone.
Button: event nameSomeone presses a message button that uses this event name, and confirms if asked.

Examples​

Tell people when the garage is left open. Make a template "Garage open", level warning, for the people who need to know. In programming, when the garage door's open state has lasted ten minutes, run Send Garage open.

Let them close it from the message. Give the template a button: text "Close it", ask first "Close the garage door?", event "Close garage". Program Button: Close garage to run the garage door's close command.

Play a chime when something urgent arrives. With the LCD Sonos Chime driver on the same processor, program Warning or critical message received to play a chime in the kitchen.

Stand down after an acknowledgement. Program Critical message acknowledged in Pushover to turn off a siren or a flashing light scene that the critical event started.