Notifier (Addon)

ARDI can be used to send out messages when either alerts occur or when values change.

This is done through the Notifier addon.

Installing

From your console on Ubuntu/Debian/Raspbian, type…

 sudo apt-get install ardi-notifier
 

Enabling

You enable the recorder addon from the Addon List, in Administration.

When you enable the Notification addon, a few new types are added to your system. These are used for managing your notification groups and contacts.

Configuring - Notification Methods

You can configure notification methods from the Notification Methods button on the Administration Page.

Simply click on the notification method(s) you'd like to use, If they need additional configuration details (for example, Twitter authentication details, SMS-provider username and password etc.), you'll be prompted for them.

Configuring - Groups

Each message is sent to a contact group. This is a group of users, represented by a type.

To add or remove a group, you delete the tags under the Notifications|Notification Group (you can easily find this by pressing 'Notifier|Groups' in the Sidebar.

To add users to a notification group, simply tag them with the appropriate tag.

Configuring - Contacts

Any asset with the “Contact” tag is treated as a recipient.

Certain notification methods - such as email - require your contact assets to have properties. For example, an email address is required for an email notification, a mobile phone number for SMS notifications etc.

Example

For example, to create a notification group called “High Priority” who get the most critical alarms, you would…

  • Go to the 'Notifier' section of the Sidebar
  • Click on 'Groups'
  • Add a new asset named 'High Priority' under the Notification Groups type.
  • Create assets for your recipients (if you don't have them already) and ensure that they all have the “High Priority” and “Contact” types.
  • Fill in the contact information for your users.

Configuring - Setting Up a Notification

Once the notification addon is installed, an additional button will appear next to your properties and your alerts on your detail pages.

If you've clicked the button next to an alert, a message will be sent each time the asset changes state, ie. when an alarm is raised.

If you clicked the button next to an asset, a message will be sent when the associated value changes. This is mostly useful for discrete properties such as enumerations.