Execute Equipment Command#
This task executes a command on the equipment. The command must be defined in the driver definition. The task receives a set of inputs defined in the driver definition. If the equipment sends back a reply, it will be made available in the output.
Details#
| Fields | Details |
|---|---|
| Scope | Connect IoT |
| Workflow | Data flow Control flow |
IsProtocol flag |
Inputs#
| Name | Data Type | Description |
|---|---|---|
<custom list> | <custom> | Specific input values for each command. |
| correlationId | String | Optional identifier used to correlate the command with the event that triggered it. |
| Activate | any | Sends the command. |
Outputs#
| Name | Data Type | Description |
|---|---|---|
| reply | Object | The reply received from the equipment (if any). |
| Success | Boolean | If there was no problem emits a true. |
| Error | Error | Error that occurred during the processing of this task. |
Settings#
On the General tab, you have the usual settings and the following settings:
| Name | Data Type | Description |
|---|---|---|
| Equipment Command | AutomationCommand | The command to send |
| Clear Inputs (on activate) | Boolean | When true, the command parameter inputs are cleared after each activation, so the next activation sends the configured values unless new values arrive. Default false. |
| Timeout | Long | Time in milliseconds to wait for the command to complete before the task emits Error. Default 60000. |
Extended Data
This task shows extended data in the Settings and the Command Parameters tab when an Automation Command is selected. The extended data shown depends on the driver in use.
On the Command Settings tab, you have the following settings for each of the command parameters of the command:
| Name | Data Type | Description |
|---|---|---|
| Value | `String | The value to send if no other is supplied |
Behavior#
In this task you choose a driver when dropping it into the workflow (if you have more than one driver associated with the controller).
On activate, this task sends a command with a set of inputs to a device and receives a reply.
The correlationId input identifies the command so that it can be matched with the event that triggered it, which supports a request and reply pattern. Feed it with the occurrenceId emitted by an On Equipment Event task. When you leave correlationId empty, the task uses the name of the top-most zone of the workflow as the correlation identifier.
Remarks#
The entire received reply is emitted on the reply output. No processing is done to it.