AlternateEventServer

Latest revision as of 15:32, 12 February 2018

Vera calls MiOS's event servers to report events, like sensor tripped, triggers, etc. MiOS's event servers send out text messages and emails to report these events.

Some very advanced users have asked to setup their own event server that Vera will call to report events. If you add your own, alternate event server, Vera will still send events to MiOS's event server unchanged, however Vera will also post the same event to the alternate server of your choice.

[edit] UI5

• On UI5 Vera will send the event as a standard HTTPS (secure) GET to yourserver/alert with the arguments passed on the URL, like this (assuming your server is myserver.me.com):

 https://myserver.me.com/alert?
PK_AccessPoint=[serial number of Vera; in Lua you can get it with luup.pk_accesspoint]
&HW_Key=[hardware key of Vera; in Lua you can get it with luup.hw_key]
&DeviceID=[device id that is associated with the alert]
&LocalDate=[the time the alert happened as human readable text]
&LocalTimestamp=[the time the alert happened as a unix timestamp in UTC]
&AlertType=[one of the alert types below]]
&SourceType=[one of the source types below]
&Argument=[an optional argument depending on the alert type]
&Format=[a file format, not normally used]
&Code=[a code for the alert, usually the variable that changed]
&Value=[the value corresponding to the code above]
&Description=[a human readable description of the event, or comments regarding it]
&Users=[a comma separated list of user id's that should be notified of the event]

The page on your event server must respond with a plain text response which should look like this:

HTTP/1.1 200 OK
Content-Length: n

PK_Alert:x

- x is some number to identify the alert recorded on the server. It can be any number, and just PK_Alert:0 if you don't assign a number to the alert. Whatever it is will be put in Vera's logs along with the alert for cross reference.
- n is the content length, which is 9 plus the length of x (e.g. for PK_Alert:0 the content length is 10). The Content-Length parameter is optional.

[edit] UI7

• On UI7 Vera will send the event as a standard HTTPS (secure) POST to yourserver/event/event/event, passing the data as a json, like this (assuming your server is myserver.me.com):

https://myserver.me.com/event/event/event

{
   "PK_Device":,      // Serial number of Vera; in Lua you can get it with luup.pk_accesspoint
   "PK_Account":,     // The account ID which the Vera unit is assigned to
   "LocalDate":"",    // The time when the alert was generated, as human readable text
   "Severity":,
   "EventType":,      // One of the alert types below
   "SourceType":,     // One of the source types below
   "Argument":,       // An optional argument depending on the alert type
   "Code":"",         // A code for the alert, usually the variable that changed
   "NewValue":"",     // The value corresponding to the code above
   "Description":"",  // A human readable description of the event, or comments regarding it
   "Users":"",        // A comma separated list of user IDs that should be notified of the event
   "Icon":"",
   "LocalTimestamp":, // The time when the alert was generated, as an Unix timestamp in UTC
   "DeviceID":,       // The ID of the device that generated the alert *
   "DeviceName":"",   // The name of the device that generated the alert *
   "DeviceType":"",   // The type of the device that generated the alert *
   "Room":"",         // The room where the device that generated the alert is *
   "Category":,       // The category of the device that generated the alert *
   "SubCategory":,    // The subcategory of the device that generated the alert *
   "Expiration":""    // When the alert expires
}

* This info appears in the alert only if it was generated by a device.

The page on your event server must respond with a plain text response which should look like this:

{
   "PK_Event":1234,
   "Key":"12345678"
}

PK_Event must be a number, i.e. not surrounded by double quotes.

There must be no characters between "PK_Event": and the number.

"PK_Event" and "Key" are case sensitive.

"PK_Event" can be any valid integer (e.g. 471993). "Key" can be any string, however, it's preferable to be a string representing a number (e.g. "85729059").

[edit] Setup

To use this alternate event logging set the top level user_data tag "AltEventServer" to the domain of your server. If your server is myserver.me.com, do this by changing the 'ip' to be the IP of Vera, and opening this URL:

http://ip:3480/data_request?id=variableset&Variable=AltEventServer&Value=myserver.me.com 

Then click Reload in Vera's UI to reload the engine with the changes. You can watch Vera send the data by logging into Vera's console as explained in Logon Vera SSH and then typing:

tail -f /var/log/cmh/LuaUPnP.log | grep 'RAServerSync::SendAlert' 

To stop logging to your own server, call the variableset again but leave the Value empty.

[edit] Alert Types

[edit] Source Types

[edit] File Formats