Publish Alarm
The Publish Alarm action publishes an alarm for the specified thing by sending a alarm.publish TR50 command to the deviceWISE Cloud.
Parameter descriptions
Parameter
|
Description
|
---|---|
Command Aggregator | An option to use the Command
Aggregator when this command is sent to
the deviceWISE Cloud. The options are Trueor False.For more information, see TR50 Command
Aggregator When the TR50 Command Aggregator is enabled and this Command Aggregator parameter is set to True, multiple alarm.publish TR50 commands will be grouped as a alarm.batch TR50 command. |
S&F Profile | The S&F profile to use if the
data from the action can not be sent to
the deviceWISE Cloud.
If the default "None" is selected, then the optional TR50 S&F feature will not be used for this action If the data for this action is stored in a S&F queue, then the action's Store and Forward Route will be used to determine the next action to execute. For more information, see TR50 S&F Profile Management tab. |
Input tab
Input | Description |
---|---|
Key |
The alarm key. Alarms can be defined in a thing definition. |
State | The state of the alarm, which is one of the values defined for the alarm when it was defined in a thing definition. |
Message | (Optional) A message that will be displayed with the alarm information. |
Republish | (Optional) Can be True or False. If false, the alarm will not republish a repeat state. |
Latitude | (Optional) The latitude value to include with the alarm information. |
Longitude | (Optional) The longitude value to include with the alarm information. |
ThingKey | (Optional) If not specified, the thing key for the gateway is used. |
Correlation ID | (Optional) An optional value that can be used to associate several alarms, locations and properties. |
Timestamp | (Optional) The timestamp to include
with the alarm information.
If the timestamp is not included, the time the action is executed is used. |
Connection Name | The TR50 connection name of the
connection to perform this action
on.
(Optional) If not specified, the name of the connection used is Default. |
Output tab
Output | Description |
---|---|
Error Message | If the action is not successful, an error message indicating the problem is returned. |