Alerts

From MiOS
(Difference between revisions)
Jump to: navigation, search
 
Line 21: Line 21:
  
 
* DEVICE_ID - device # that generates the alert;
 
* DEVICE_ID - device # that generates the alert;
* ALERT_TYPE - "user created trigger" alert;
+
* ALERT_TYPE - should be 3, DO NOT CHANGE;
* ALERT_SOURCE - trigger event type message in detailed description;
+
* ALERT_SOURCE - should be 3, DO NOT CHANGE;
 
* ALERT_DESCRIPTION - URL encoded message used as description for the alert;
 
* ALERT_DESCRIPTION - URL encoded message used as description for the alert;
 
* USERS_LIST - a list with user ID separated by commas that should be notify[left blank if no user notification is required].
 
* USERS_LIST - a list with user ID separated by commas that should be notify[left blank if no user notification is required].

Latest revision as of 14:13, 2 October 2014

[edit] Introduction

3rd party developers can now use the alert system in plugins. They can generate different alert types with or without user notification. Alert messages generated by a device can be seen in "Logs" tab for that device.

caption

Let's take as example the HomeCare plugin. Users should be notify when a sensor has not been tripped for a specified amount of time. Here is how "Alerts" page for HomeCare plugin looks like:

caption


As you can see the source of this notification is our HomeCare plugin, type for it is "user created trigger" and desctiption is the one we added in plugin.

And here is the detailed message for this notification:

caption

[edit] Alert HTTP Request

http://IP:3480/data_request?id=add_alert&device=DEVICE_ID&type=3&source=3&description=ALERT_DESCRIPTION&users=USERS_LIST

  • DEVICE_ID - device # that generates the alert;
  • ALERT_TYPE - should be 3, DO NOT CHANGE;
  • ALERT_SOURCE - should be 3, DO NOT CHANGE;
  • ALERT_DESCRIPTION - URL encoded message used as description for the alert;
  • USERS_LIST - a list with user ID separated by commas that should be notify[left blank if no user notification is required].
Personal tools