alarm.publish action
This trigger action will publish an alarm value to the AEP.
Action
This trigger action is found under the Alarm heading.
Canvas
When dragged onto the canvas, the appearance of the action is a rectangle with two routing points.
The left routing point (red) is the failure route. This route will be taken if there is an error publishing the alarm.
The right routing point (green) is the success route. This route will be taken if the alarm is successfully published.
Form
Parameters
Name | Type | Required | Description |
---|---|---|---|
Thing key | String | Yes | Identifies the thing to which the alarm state is to be associated. It can be the thing key associated with the trigger event: $(event.thing.key). |
Alarm key | String | Yes | Identifies the alarm to publish. |
Correlation ID | String | A string used to identify related data objects. For more information on correlation ID, see Correlation ID. | |
Timestamp | String | The date and time of the alarm. | |
State | Integer | Yes | The alarm state to publish. |
Message | String | The message to publish. | |
Latitude | Float | Latitude coordinate of the alarm state event. | |
Longitude | Float | Longitude coordinate of the alarm state event. | |
Republish | Boolean | If false, will not republish a repeat state. |