Notification

Require: IP-Symcon >= 5.1

This module enables multi-level notification, where the level increases after a defined time and is reset when acknowledged. Various actions can be performed when a new level is reached.

function scope

• Starting a multi-stage notification chain with a variable
• Actions can be set individually at each stage:
  • Execute scripts
  • Send push messages, e-mails or SMS
  • Make a phone call with an announcement (if the "Phone Announcement" module is installed)
  • Make an announcement over the loudspeaker (if the "Announcement" module is installed)
  • Send message via Telegram (if "TelegramBot" module is installed)
  • Increase to next level after certain time
• Acknowledgement via attached script or push message ends notifications
• Individual levels can be deactivated if required

software installation

Via the Module Store install the 'Notification' module.

Setting up instances in IP-Symcon

• Under "Add Instance" the 'Notification' module can be found using the quick filter.
  • More information about adding instances in the documentation of instances.
• Select a variable at 'Trigger
  • If this variable takes a value that is not neutral (false for boolean, 0 for integer and float, '' for string), the notification chain is started at level 1
• Add any number of levels to the notification levels list and configure them
  • Duration defines the time until the next level is activated
  • Actions are executed when a level is reached
  • Active defines whether the stage should be executed. Stages that are not active are skipped
  • 'Status' contains error messages if something is not correct when configuring the stage, otherwise "OK".

Set up actions

Each action has parameters for the action type, a recipient object, a recipient address, a title, a message and a message variable. The "action" defines what should be called. (e.g. A script or an email sent).
Further information like "title" and "message" will be sent to the set "recipient object". The content of the message is defined by the text in the configuration field "Message". This is concatenated with the text in the "Message variable".
For generic messages, the content of the message variable is available as '{variable}'. Likewise, line breaks can be inserted by '\n'. The recipient address has different functionality depending on the action.

Script

The script selected as recipient object will be executed. During this call the following system variables can be used:

Push

A push message is sent to all devices in the selected web front. This message links the acknowledgement script. So by tapping on the push message, the notification can be acknowledged. The recipient address has no effect with this action type. The message has a maximum length of 256 characters.

E-mail (SMTP)

An e-mail is sent via the selected SMTP instance. If a recipient address is specified, the email will be sent to that address. If no recipient address is specified, the e-mail will be sent to the specified recipient of the SMTP instance. If the 'Advanced Response' option is enabled, a block of links can be inserted with the keyword '{actions}', through which the available actions can be executed.

SMS

An SMS will be sent via the selected SMS instance to the phone number specified in the recipient address. If the 'Extended response' option is enabled, a link can be inserted with the '{actions}' keyword, through which the available actions can be performed. If a message is longer than 160 characters (limitation by SMS), it will be split up to 2 additional SMS (maximum 459 characters).

Telephone announcement (only available if the Telephone announcement module is installed)

The phone number specified in the recipient's address will be called and the title and the message will be read out. If the 'Extended answer' option is enabled, the corresponding action can be performed with the 0-9 keys. If desired, the '{actions}' keyword can be used to include the available actions in the message.

Passage (only available if the Announcement module is installed)

The title and message are read out using the selected instance. The recipient address has no effect with this action type.

Telegram (only available if the Telegram Bot module is installed)

The title and message are sent to the recipient using the selected instance. The recipient address can be either the name or the UserID of the Telegram recipient. If the recipient address is left empty, all recipients stored in the Telegram bot will be notified.

AdvancedReply

If extended reply is enabled, different actions can be defined in the corresponding list. To define what is additionally executed on an action, a triggering event can be created. The variable 'Response action' is selected as the triggering variable and 'On certain value' as the trigger. The desired action can now be selected as the value.

statusvariables

WebFront

• Via the WebFront "Reply action" can be executed to reset the notification.
• The WebFront can be used to switch the notification on/off via "Notification active".
• The current notification level is displayed.