Skip to content

Equipment Setup Result#

The Equipment Setup Result task is typically included in workflows that require equipment setup validation before driver communication begins. It communicates the outcome of an equipment setup process to the corresponding driver, and is automatically added to the workflow when the driver is created and is used only by that specific driver.

Although it is technically possible to include multiple instances of this task, only one Equipment Setup and one Equipment Setup Result task should exist per driver per controller.

Equipment Setup Result

Warning

This task is deprecated and will be removed starting with version 12. Its functionality, along with Equipment Setup have been split into three separate actions: Equipment Configuration, Driver Event OnInitialize and Driver Command Connect.

Workflows#

Data Flow Control Flow

Inputs#

Name Data Type IsTrigger Description
success any Yes Indicates that the setup process completed successfully.
failure any Yes Indicates that the setup process failed. The driver retries after a short delay.
Activate any Yes Activates the listener for system events.

Outputs#

This task does not have any outputs.

Settings#

This task has no additional settings beyond the standard task configuration options.

Behavior#

In the driver communication state model, the Equipment Setup Result task signals the driver about the setup result (if any).

Screenshot showing a system in the Communicating state.

  • When the setup was successful, the success input is triggered, the driver transitions to the Communicating state.
  • When the setup fails, the failure input is triggered, the driver transitions to the ConnectingFailed state and begins a retry cycle to reconnect to the equipment or device.

Remarks#

This task is only Effective while the driver is in Setup state.

This task uses a context-based data structure called a zone. For more information, see Zones page.