--- alias: user-guide-automation-driver-definition-create tags: - connect iot description: "Create a new automation driver definition by configuring equipment properties, events, and commands within a wizard" --- # Create Automation Driver Definition :lock: AutomationDriverDefinition.**Create** ## Overview This operation is used to create a new **Automation Driver Definition** that defines the interface data for equipment communication within the automation environment. ## Setup No specific setup is required other than to meet the preconditions of the operation. ## Preconditions * An **Automation Protocol** has been created and approved for the equipment communication type. * The user has appropriate permissions to create Automation Driver Definitions. * The equipment interface specifications (properties, events, commands) are documented and available. ## Sequence of Steps ### Step 1: Start the New Driver Definition Wizard 1. Navigate to the Automation Driver Definition page. 2. Select **New** on the top ribbon. 3. Choose the version level to create: * **Entity** - Create a completely new driver definition * **Revision** - Create a new revision of an existing driver definition * **Version** - Create a version associated to an existing revision For more information, see [Creating Entity Objects](../../../general/creating_entity_objects.md), [[revisions-index]], and [[versions-index]]. ### Step 2: Configure Change Set 1. Specify the Change Set field on the first page of the wizard. 2. Alternatively, bypass this field if it's already defined in Entities Administration. ![Wizard1][Wizard1] ### Step 3: Enter General Data 1. Provide a **Name** for the Automation Driver Definition. 2. Specify the **Revision Name**. 3. Optionally, provide a **Description** explaining the driver's purpose. 4. Select a **Type** for classification purposes. 5. Select the **Automation Protocol** that will be used to communicate with the equipment. 6. Choose the **Entity Type** that will be used as context for this implementation (typically a Resource). !!! info If you are creating a new version, the revision that was selected when you started the process will be the revision to which this version will be associated. If you are creating a new entity or revision (with a new version associated to it), provide a name for the revision or it will be automatically generated for you. For more information, see [Revision Naming](../../../../general/revisions#Naming/). ![Wizard2][Wizard2] ### Step 4: Define Equipment Properties 1. Click the :material-plus: sign to add a new property to the grid. 2. Fill in the following attributes for each property: * **Name** - Unique identifier for the property * **Description** - Explanation of the property's purpose in the equipment * **Property Device ID** - Equipment-specific identifier for this property * **Type** - Data type of the property in the system * **Writable and Readable** - Property accessibility permissions in the equipment * **Protocol Data Type** - Equipment-specific data type for this property 3. Configure any protocol-specific extended data as required by your selected Automation Protocol. For details, see [Protocol-Specific Information](../automation-protocol/automation-protocol-protocols/index.md). For detailed information about properties, see [Automation Property](automation_property.md). ![Wizard3][Wizard3] ### Step 5: Define Equipment Events 1. Click the :material-plus: sign to add a new event to the grid. 2. Fill in the following attributes for each event: * **Name** - Unique identifier for the event * **Description** - Explanation of what this event represents in the equipment * **Event Device ID** - Equipment-specific identifier for this event * **Enabled** - Whether the system should process this event (set to `false` to ignore) 3. Configure any protocol-specific extended data as required. For details, see [Protocol-Specific Information](../automation-protocol/automation-protocol-protocols/index.md). For detailed information about events, see [Automation Events](automation_event.md). ![Wizard4][Wizard4] ### Step 6: Map Event Properties 1. For each event listed, click the :material-plus: sign to add associated properties. 2. Select one of the properties defined in Step 4 that should be included when this event fires. 3. Configure any protocol-specific extended data as required. For details, see [Protocol-Specific Information](../automation-protocol/automation-protocol-protocols/index.md). ![Wizard5][Wizard5] ### Step 7: Define Equipment Commands 1. Click the :material-plus: sign to add a new command to the grid. 2. Fill in the following attributes for each command: * **Name** - Unique identifier for the command * **Description** - Explanation of what this command does in the equipment * **Command Device ID** - Equipment-specific identifier for this command 3. Configure any protocol-specific extended data as required. For details, see [Protocol-Specific Information](../automation-protocol/automation-protocol-protocols/index.md). For detailed information about commands, see [Automation Command](automation_command.md). ![Wizard6][Wizard6] ### Step 8: Configure Command Parameters 1. For each command listed, click the :material-plus: sign to add parameters. 2. Fill in the following attributes for each parameter: * **Name** - Unique identifier for the parameter * **Description** - Explanation of what this parameter controls * **Type** - Data type of the parameter in the system * **Default Value** - Default value for the parameter * **Mandatory** - Whether this parameter is required or optional * **Protocol Data Type** - Equipment-specific data type for this parameter 3. Configure any protocol-specific extended data as required. For details, see [Protocol-Specific Information](../automation-protocol/automation-protocol-protocols/index.md). ![Wizard7][Wizard7] ### Step 9: Create the Driver Definition 1. Select the **Create** button to complete the process. 2. The Automation Driver Definition will be created with **Created** status and is ready for use. ![Entity][Entity] [Wizard1]: images/new_automation_driver_definition_1.png [Wizard2]: images/new_automation_driver_definition_2.png [Wizard3]: images/new_automation_driver_definition_3.png [Wizard4]: images/new_automation_driver_definition_4.png [Wizard5]: images/new_automation_driver_definition_5.png [Wizard6]: images/new_automation_driver_definition_6.png [Wizard7]: images/new_automation_driver_definition_7.png [Entity]: images/new_automation_driver_definition_8.png