alarm.publish Action

This trigger action publishes an alarm value to Device Cloud.

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 is taken if there is an error publishing the alarm.

The right routing point (green) is the success route. This route is taken if the alarm is successfully published.

Form

Add alarm.publish

Parameters

Name

Type

Required

Description

Thing key

String

Yes

Identifies the thing with which the alarm state is associated. It can be the $(event.thing.key) event variable associated with the trigger event.

Alarm key

String

Yes

Identifies the alarm to publish.

Correlation ID

String

 

A string used to identify related data objects.

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.