---
title: "Device Parameters"
slug: "device-parameters"
updated: 2025-01-09T15:50:46Z
published: 2025-01-09T15:50:46Z
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.ai-op.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Device Parameters

### Generic Parameters

The following parameters are common to all devices.

| Name | Definition |
| --- | --- |
| Created At (*created_at*) | Date the device was created. |
| Description (*description*) | Optional string used to help describe this device. |
| Enabled (*enabled*) | When `True`, a connection is formed with the endpoint and all of the device’s enabled tags begin to transfer data. (*Boolean*) **Possible Values** - True - False *Parameter is able to be mapped.* |
| Error Code (*error_code*) | Value that represents the current error of the device. (*Integer*) **Possible Values** - 0 (NONE) - 1 (FAILED_TO_CONNECT) - 5 (FAILED_TO_READ_DEVICE) - 6 (FAILED_TO_WRITE_DEVICE) - 7 (FAILED_TO_READ_DB) - 11 (FAILED_TO_INITIALIZE) - 12 (FAILED_TO_WRITE_MODEL_HISTORY) - 13 (FAILED_TO_WRITE_LONGTERM_HISTORY) - 999 (UNLICENSED) *Parameter is able to be mapped.* |
| Error Detail (*error_detail*) | A detailed description of the device’s current error. (*String*) |
| Error Message (*error_message*) | A brief description of the device’s current error. (*String*) |
| ID (id) | Unique ID. (*Integer*) |
| Name (*name*) | Unique name used to identify this device. |
| New Settings (*new_settings*) | Flag that is True when new device settings have been saved and are yet to be applied to the running device. (*Boolean*) |
| Overscans (*overscans*) | Number of times the device has taken longer than the scan rate to get a response. The overscan count is reset when the device is disabled. (*Integer*) *Parameter is able to be mapped.* |
| Protocol (*protocol_id*) | ID defining the protocol that this device is configured for. (*Integer*) |
| Scan Rate (*scan_rate*) | Time interval in seconds that the device will wait before it attempt to read/write. The device will loop at this scan rate indefinitely as long as it is enabled. (*Float*) **Default** - 1 (second) **Possible Values** - 0.1 - 3600 (seconds) *Parameter is able to be mapped.* |
| Slug (*slug*) | Unique UUID4 string representing this device. |
| Status (*status*) | Value that represents the current state of the device. (*Integer*) **Possible Values** - 0 (Inactive) - 1 (Running) - 2 (Failed) *Parameter is able to be mapped.* |
| Updated At (*updated_at*) | Date the device was last modified. |

### OPC-UA Parameters

The following parameters are specific to OPC-UA devices.

| Name | Definition |
| --- | --- |
| OPC-UA Endpoint (*opcua_endpoint*) | String representing the connection path to an OPC-UA server endpoint, typically in the format of *opc.tcp://hostname:port.*(*String*) **Examples** - *opc.tcp://192.168.10.10:4840* - *https://myopucahost:5112/UA/SampleServer* |
| OPC-UA Password (*opcua_password*) | Password used to authenticate the OPC-UA user. (*String*) |
| OPC-UA Security Mode (*opcua_security_mode*) | Determines which OPC-UA security mode should be used to connect. (*Integer*) **Possible Values** - 0 (None) - 1 (Sign) - 2 (Sign & Encrypt) |
| OPC-UA Security Policy (*opcua_security_policy*) | Determines which OPC-UA security policy should be used to connect. (*Integer*) **Possible Values** - 0 (Basic256) - 1 (Basic256Sha256) - 2 (Basic128Rsa15) |
| OPC-UA Timeout (*opcua_timeout*) | Determines how long a request should wait for a response. If the timeout is exceeded, an exception is thrown and the device will go into a failed state. (*Integer*) **Default** - 5 (seconds) **Possible Values** - 1 - 30 (seconds) |
| OPC-UA Token Type (*opcua_token_type*) | Determines which OPC-UA token type should be used to connect. (*Integer*) If token type is set to `UserName`, the opcua_username and opcua_password must be set. **Possible Values** - 0 (Anonymous) - 1 (UserName) |
| OPC-UA Username (*opcua_username*) | Username used to authenticate the OPC-UA user. (*String*) |

### Ethernet/IP Parameters

The following parameters are specific to Ethernet/IP devices.

| Name | Definition |
| --- | --- |
| Ethernet/IP Controller Slot (*ethernet_ip_controller_slot*) | PLC controller slot number used when communicating with an Allen Bradley PLC. (*Integer*) |
| Ethernet/IP Hostname (*ethernet_ip_hostname*) | Hostname or IP address used to connect to device. (*String*) |
| Ethernet/IP Timeout (*ethernet_ip_timeout*) | Determines how long a request should wait for a response. If the timeout is exceeded, an exception is thrown and the device will go into a failed state. (*Integer*) **Default** - 3 (seconds) **Possible Values** - 1 - 30 (seconds) |
| Ethernet/IP Type (*ethernet_ip_type*) | Ethernet/IP device type. (*Integer*) **Possible Values** - 0 (Logix) |