Driver Event OnInitialize#
The Driver Event task subscribes to driver lifecycle events and triggers workflow actions when specific driver states occur.
It replaces the event-handling functionality that was previously included in the Equipment Setup and Equipment Setup Result tasks.
Note
This task results from a split of the Equipment Setup and Equipment Setup Result tasks. It should be used along with: Equipment Configuration and Driver Command Connect.
Workflows#
| Data Flow | Control Flow |
|---|---|
Inputs#
| Name | Data Type | Description |
|---|---|---|
| Enable/Disable | any | Activates or deactivates the event subscription. |
Outputs#
| Name | Data Type | Description |
|---|---|---|
| Success | Boolean | Returns true when the task successfully subscribes to or processes the driver event. |
| Error | Error | Provides details if an error occurs while handling the event. |
Settings#
| Name | Data Type | Default | Description |
|---|---|---|---|
| Auto Enable | Boolean | true | AAutomatically activates the event subscription when the workflow starts. If set to false, the task subscribes only when manually enabled. |
| Event | String | OnInitialize | Driver lifecycle event to subscribe to. Supported events are: OnInitializeOnSetupOnHeartbeatOnCommunicationChange |
| Automatic Setup | Boolean | false | Valid only for the OnInitialize event. When enabled, automatically triggers a setup command for the driver to complete its initialization sequence. |
Behavior#
The Driver Command task allows the user to surface the lifecycle of the driver.
The Driver Event OnInitialize task listens for key driver lifecycle events and triggers workflow actions when those events occur.
It initiates the configuration and connection sequence for a driver.
A typical workflow using this task includes the following steps:
- Driver Event OnInitialize listens for the selected lifecycle event (for example,
OnInitializeorAutoSetup). - When the event occurs, it triggers the Equipment Configuration task to define driver parameters.
- After configuration, the Driver Command task issues the
connectcommand to establish communication with the equipment.
