genericEvent

Injects the genericEvent signal into the macro mechanism.

Note: This function requires an API license.

The genericEvent signal with the supplied value parameter is used in the macro mechanism to trigger macros.

This signal is also stored in the database. It can be obtained with the command getEvents. Special care must be taken when including xml specific characters. These are ‘&’, ‘<‘ en ‘>’. The ampersand (‘&’) character can not be sent by this command because it will be part of the URL. See next paragraph. The less-then (‘<‘) and greater-then (‘>’) character cannot be part of the return xml message in getEvents. These characters are converted to ‘<‘ and ‘>’ before they are stored in the database.

As the value of this event is in the query part of an URL, the ampersand character (‘&’) cannot be part of it. It must be URL Encoded. See i.e. http://www.w3schools.com/TAGS/ref_urlencode.asp. The best practive is to URL Encode the complete value.

This command is only available if the option XML is available.

Request

command=genericEvent&value=[string]&serverid=[UID]&deviceid=[UID]

Response

parameter type remarks
value [string] The value used for the generic event.
serverid [UID] unique server id
deviceid [UID] unique device id.
error code description remarks
0 Ok Ok, no error
-1 Not implemented. Function not implemented.
-2 No device  No device found for the supplied cameraid/deviceid.
-17 No server There's no server with the supplied id.
-53 Device connection lost Device has no connection.

Changelog

  • 2.2.1   – Handling of xml and html specific characters.
  • 1.12.1 – Added serverid and deviceid.
  • 1.11.1 – Added.