Introduction
This page covers the ICD-001 External Trigger Command.
Contents
...
| Table of Contents | ||||||
|---|---|---|---|---|---|---|
|
...
External Trigger Example
| Code Block | ||
|---|---|---|
| ||
<!--MsgId is the unique id of the message being sent --> <!--TriggerId is the unique id of the external trigger to be enabled/disabled --> <!--Enable sets desired state of the trigger --> <?xml version="1.0" encoding="utf-8"?> <ExternalTriggerCommand MsgTimeStamp="2019-02-01T12:14:01+00:00" MsgId="1" TriggerId="1" Enable="true" Timeout="10" xmlns="ICDNAV001-ExternalTriggerCommand"> <Sender SenderId="SenderId1" NetworkAddress="127.0.0.1" NetworkPort="10000" /> </ExternalTriggerCommand> |
...
External Trigger Command Attributes
Attributes | Description | Type | Notes |
MsgId | Unique message Id | Long | This must be globally unique across all message types |
MsgTimeStamp | Date and time that the message was sent | DateTime | |
TriggerId
| Id of the external trigger | Integer |
|
Enable | Desired state of the trigger | Boolean | This is the state that needs to be applied to the trigger. Actions can be configured in Witness to respond to either the true or false state. True = Enable, False = Disable |
Timeout* | Optional attribute that provides the option to reverse a state once the timeout has expired | Integer | Timeout is in seconds |
Network Sender Element
Each incoming message can include an optional Sender element. This must include the IP address and port that the client is using to send instructions.
...
| Note |
|---|
Be aware that the state will be based on the last command message that was successfully received. If the third party system fails to send a trigger message and a timeout is not used then the state will remain unchanged indefinitely. If there is a concern over network reliability we would recommend that a timeout is used or the 3rd party software builds in message retry logic based on the response message sent from Witness. |
...
Related
...
Information
| Filter by label (Content by label) | ||||||
|---|---|---|---|---|---|---|
|
...