Skip to content

Execute Equipment Command#

Screenshot showing an equipment command execution interface with fields for command input.

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.

Screenshot showing an execute equipment command interface with fields for driver-defined inputs.

Inputs#

Name Data Type Description
<custom list> <custom> Specific input values for each command.
Activate any Sends the command.

Outputs#

Name Data Type Values 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 Default Description
Equipment Command AutomationCommand The command to send

Screenshot showing settings for executing equipment command.

On the Input Tab, you have the following settings for each of the command parameters of the command:

Name Data Type Default Description
Default Value `String The value to send if no other is supplied

Screenshot showing a table with columns labeled "Name", "Data Type", and "Default" in the Settings section.

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.

Remarks#

The entire received reply is emitted on the reply output. No processing is done to it.