This function adds a timer. When triggered, it will send an event to the event logger.

This function has the following parameter:

Parameter Name Mandatory Default Value Description
value true null The time value for the timer. It can be either the absolute time at which the trigger will be fired (YYYY-MM-DDTHH:MM:SS or HH:MM:SS) or period of time between pulses expressed in seconds between 1 and 86399 (1 sec up to a day).

Example:

API Call:

setTimer value=10

JSON Response:

{
  "data":{
    "timerId":8,
    "triggerCount":0,
    "value":10
  },
  "description":"Custom timer enqueued",
  "status":"SUCCESS"
}

The JSON response contains the following details:

  • data – The data to parse
    • timerId – The ID of the timer added
    • triggerCount – The number of times the timer triggered since it was added
    • value – The time value for the timer (see parameter table above)
  • description – Describes the result of parsing/executing the command
  • status – SUCCESS if the command was parsed and executed successfully, FAIL if not