Litmus Edge 4.4.x - DeviceHub: Create Device Driver Examples

Create Device - AB CompactLogix Ethernet Advanced

POST {{edgeUrl}}/devicehub/v2

CompactLogix Ethernet Driver Advanced

Access Mode:

• Logical: The driver uses ID-based tag requests to improve communication performance.
• Symbolic: The driver uses string-based tag requests as a fallback for older firmware.

If Logical mode is selected, choose a Project Changes behavior. If a project change option is selected, it may reduce the driver’s performance.

• Don't monitor: If the PLC project is changed, the user must manually restart the driver to trigger a tag instance upload.
• Switch to symbolic on project change: If a project change is detected, the driver will change to symbolic mode and wait for a reconnection to upload tag instance IDs.
• Upload project on project change: If a project change is detected, the driver will upload tag instance IDs immediately. Read and write operations to the PLC will be paused for the duration of the upload.

Driver ID: 86933B9C-37D5-4926-9C6B-EDF94E5F6DC5 Group: Allen Bradley

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - slotNumber SignedInteger — This is a slot no of device - accessMode SignedInteger — Logical: This mode uses ID-based tag requests to improve communication performance. The driver must be restarted if the PLC program is changed. Symbolic: This mode uses string-based tag requests. Options: 0, 1 - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - fwVersion UnsignedInteger — If set to Auto, the driver will attempt to determine the firmware version upon connection. Specify the firmware version if there is a connection issue. Options: 0, 1, 2 - PLCProgramChangeAction UnsignedInteger — Specify whether the driver will monitor the PLC project for changes. If a project change option is selected, it may reduce the driver’s performance. If Upload project is selected, read/writes to the PLC will be paused for the duration of the upload. If Switch to symbolic is selected, communication will be in symbolic mode. However, the next time the driver connects to the PLC, it will use logical mode. Options: 0, 1, 2 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB CompactLogix Ethernet Advanced Device",
    "Description": "",
    "DriverID": "86933B9C-37D5-4926-9C6B-EDF94E5F6DC5",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "slotNumber",
        "Value": "0"
      },
      {
        "Key": "accessMode",
        "Value": "0"
      },
      {
        "Key": "fwVersion",
        "Value": "0"
      },
      {
        "Key": "PLCProgramChangeAction",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "rockwell-compact-logix-adv_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB CompactLogix Ethernet Advanced Device",
            "DriverID": "86933B9C-37D5-4926-9C6B-EDF94E5F6DC5",
            "Description": ""
        }
    }
}

Create Device - AB CompactLogix Ethernet FreeTag

POST {{edgeUrl}}/devicehub/v2

AB CompactLogix Ethernet FreeTag

Driver ID: 2FB8D1F6-5675-11EB-AE93-0242AC130002 Group: Allen Bradley

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - slotNumber SignedInteger — This is a slot no of device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB CompactLogix Ethernet FreeTag Device",
    "Description": "",
    "DriverID": "2FB8D1F6-5675-11EB-AE93-0242AC130002",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "slotNumber",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "rockwell-compact-logix_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB CompactLogix Ethernet FreeTag Device",
            "DriverID": "2FB8D1F6-5675-11EB-AE93-0242AC130002",
            "Description": ""
        }
    }
}

Create Device - AB ControlLogix Unsolicited (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

AB ControlLogix Unsolicited (Gen1.3)

Driver ID: 9479F114-86F0-4E77-8118-9A721340EC3C Group: Allen Bradley

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB ControlLogix Unsolicited (Gen1.3) Device",
    "Description": "",
    "DriverID": "9479F114-86F0-4E77-8118-9A721340EC3C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "rockwell device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB ControlLogix Unsolicited (Gen1.3) Device",
            "DriverID": "9479F114-86F0-4E77-8118-9A721340EC3C",
            "Description": ""
        }
    }
}

Create Device - AB DF1 Ethernet

POST {{edgeUrl}}/devicehub/v2

AB DF1 Ethernet Driver

Driver ID: 2683ED51-D9E7-4A15-ABFB-C526B382E28B Group: Allen Bradley

Required properties: - SourceID SignedInteger — SRC Byte - DestinationID SignedInteger — DST Byte - networkAddress String — PLC IP - networkPort SignedInteger — PLC Port - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - PlcType SignedInteger — PLC Type Options: 0, 1 - ReadTimeout SignedInteger — Read Timeout (ms) - RetryCount SignedInteger — Read Retries (0 for no retry) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB DF1 Ethernet Device",
    "Description": "",
    "DriverID": "2683ED51-D9E7-4A15-ABFB-C526B382E28B",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "SourceID",
        "Value": "0"
      },
      {
        "Key": "DestinationID",
        "Value": "0"
      },
      {
        "Key": "PlcType",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "ReadTimeout",
        "Value": "1000"
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "rockwell-df1-eth_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB DF1 Ethernet Device",
            "DriverID": "2683ED51-D9E7-4A15-ABFB-C526B382E28B",
            "Description": ""
        }
    }
}

Create Device - AB DF1 Serial

POST {{edgeUrl}}/devicehub/v2

Rockwell DF1 Serial Driver

Driver ID: E8D1F27A-924C-4B8E-9382-8B2B6ABB695F Group: Allen Bradley

Required properties: - SourceID SignedInteger — SRC Byte - DestinationID SignedInteger — DST Byte - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - ReadTimeout SignedInteger — Read Timeout (ms) - PlcType SignedInteger — PLC Type Options: 0, 1 - RetryCount SignedInteger — Read Retries (0 for no retry) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB DF1 Serial Device",
    "Description": "",
    "DriverID": "E8D1F27A-924C-4B8E-9382-8B2B6ABB695F",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "SourceID",
        "Value": "0"
      },
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "ReadTimeout",
        "Value": "1000"
      },
      {
        "Key": "PlcType",
        "Value": "0"
      },
      {
        "Key": "DestinationID",
        "Value": "1"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "RetryCount",
        "Value": "2"
      },
      {
        "Key": "name",
        "Value": "rockwell-df1-serial_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB DF1 Serial Device",
            "DriverID": "E8D1F27A-924C-4B8E-9382-8B2B6ABB695F",
            "Description": ""
        }
    }
}

Create Device - AB EthernetIP Ethernet

POST {{edgeUrl}}/devicehub/v2

AB EthernetIP Ethernet

Driver ID: 2FB8D1F6-5675-11EB-AE93-0242AC130003 Group: Allen Bradley

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - slotNumber SignedInteger — This is a slot no of device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB EthernetIP Ethernet Device",
    "Description": "",
    "DriverID": "2FB8D1F6-5675-11EB-AE93-0242AC130003",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "slotNumber",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "rockwell-micrologix_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB EthernetIP Ethernet Device",
            "DriverID": "2FB8D1F6-5675-11EB-AE93-0242AC130003",
            "Description": ""
        }
    }
}

Create Device - AB Logix Ethernet

POST {{edgeUrl}}/devicehub/v2

AB Logix Ethernet

Route: Use the Route field to enter the routing path for your configuration. To connect directly to a CPU, enter 1, [Slot Number]. A typical DH+ path is configured as [Backplane], [Slot], [Port], [Station]. A typical ControlNet path is [IP Address], [Backplane], [Slot], [Port], [Node].

Access Mode:

• Logical: The driver uses ID-based tag requests to improve communication performance.
• Symbolic: The driver uses string-based tag requests as a fallback for older firmware.

If Logical mode is selected, choose a Project Changes behavior. If a project change option is selected, it may reduce the driver’s performance.

• Don't monitor: If the PLC project is changed, the user must manually restart the driver to trigger a tag instance upload.
• Switch to symbolic on project change: If a project change is detected, the driver will change to symbolic mode and wait for a reconnection to upload tag instance IDs.
• Upload project on project change: If a project change is detected, the driver will upload tag instance IDs immediately. Read and write operations to the PLC will be paused for the duration of the upload.

Driver ID: 0170E3C7-3D54-4710-A8FA-F953AE626353 Group: Allen Bradley

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - route String — The path describes the route the message takes to get to the destination. Use this format: port, next_address, port, next_address. - accessMode SignedInteger — Logical: This mode uses ID-based tag requests to improve communication performance. The driver must be restarted if the PLC program is changed. Symbolic: This mode uses string-based tag requests. Options: 0, 1 - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - fwVersion UnsignedInteger — If set to Auto, the driver will attempt to determine the firmware version upon connection. Specify the firmware version if there is a connection issue. Options: 0, 1, 2 - PLCProgramChangeAction UnsignedInteger — Specify whether the driver will monitor the PLC project for changes. If a project change option is selected, it may reduce the driver’s performance. If Upload project is selected, read/writes to the PLC will be paused for the duration of the upload. If Switch to symbolic is selected, communication will be in symbolic mode. However, the next time the driver connects to the PLC, it will use logical mode. Options: 0, 1, 2 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB Logix Ethernet Device",
    "Description": "",
    "DriverID": "0170E3C7-3D54-4710-A8FA-F953AE626353",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "route",
        "Value": "1,0"
      },
      {
        "Key": "accessMode",
        "Value": "0"
      },
      {
        "Key": "fwVersion",
        "Value": "0"
      },
      {
        "Key": "PLCProgramChangeAction",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "ab-logix_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB Logix Ethernet Device",
            "DriverID": "0170E3C7-3D54-4710-A8FA-F953AE626353",
            "Description": ""
        }
    }
}

Create Device - AB Logix Serial

POST {{edgeUrl}}/devicehub/v2

AB Logix Serial

Driver ID: 6F794B0D-C363-41E1-9828-5DDB2E1C587E Group: Allen Bradley

Required properties: - PLCType SignedInteger Options: 0, 1, 2 - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - readTimeout SignedInteger — Read Timeout (ms) - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB Logix Serial Device",
    "Description": "",
    "DriverID": "6F794B0D-C363-41E1-9828-5DDB2E1C587E",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "PLCType",
        "Value": "0"
      },
      {
        "Key": "readTimeout",
        "Value": "1000"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "ab-logix-serial_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB Logix Serial Device",
            "DriverID": "6F794B0D-C363-41E1-9828-5DDB2E1C587E",
            "Description": ""
        }
    }
}

Create Device - AB Micro800 Ethernet

POST {{edgeUrl}}/devicehub/v2

AB Micro800 Ethernet

Driver ID: D654F142-8343-4354-B2AA-A838B93AF988 Group: Allen Bradley

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - globalVariablesCSV String — FTP path for CSV file exported from CCW - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AB Micro800 Ethernet Device",
    "Description": "",
    "DriverID": "D654F142-8343-4354-B2AA-A838B93AF988",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "globalVariablesCSV",
        "Value": ""
      },
      {
        "Key": "name",
        "Value": "ab-micro800_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AB Micro800 Ethernet Device",
            "DriverID": "D654F142-8343-4354-B2AA-A838B93AF988",
            "Description": ""
        }
    }
}

Create Device - ABB Robot Web Services

POST {{edgeUrl}}/devicehub/v2

ABB Robot Web Services Controller

Driver ID: 97A7485B-816E-4F89-8155-48617608CC28 Group: Robot

Required properties: - clientCertificate String — Client Certificate (PEM) - username String — Username - bearerToken String — Client Token - networkAddress String — Server Hostname or IP - networkPort SignedInteger — Server Port - oauth2ClientID String — Client Identifier registered to the application - oauth2TokenEndpoint String — Authorization Server URL - clientPrivateKey String — Client Private Key (PEM) - password String — Password - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - oauth2Scopes String — Access request scope(s) (space separated values) - certificateAuthority String — CA Chain (PEM) - pathParams String — Common HTTP Path Parameters (JSON) - headers String — Common HTTP Headers (JSON) - certificateVerification SignedInteger — Verify server certificate Options: 0, 1 - requestTimeout SignedInteger — Request timeout, msec - requestRetryWaitMS SignedInteger — Pause between retries, msec - authSchemeOverride String — Authorization header scheme/prefix override - enableTLS SignedInteger — Enable TLS / HTTPS Options: 0, 1 - websocketTimeout SignedInteger — WebSocket Subscription Timeout, S - queryParams String — Common HTTP Query Parameters (JSON or Parameter string) - urlPath String — Common URL Path - enableMutualTLS SignedInteger — Enable mTLS / Client Certificate Options: 0, 1 - oauth2ClientSecret String — Client Secret registered to the application - requestRetryCount SignedInteger — Retry request count - oauth2TokenParams String — Additional token endpoint parameters (JSON or Parameter string) - authenticationType SignedInteger — Authentication Type Options: 0, 1, 2, 3, 4 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My ABB Robot Web Services Device",
    "Description": "",
    "DriverID": "97A7485B-816E-4F89-8155-48617608CC28",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "oauth2Scopes",
        "Value": ""
      },
      {
        "Key": "certificateAuthority",
        "Value": ""
      },
      {
        "Key": "clientCertificate",
        "Value": "<certificate>"
      },
      {
        "Key": "pathParams",
        "Value": ""
      },
      {
        "Key": "headers",
        "Value": ""
      },
      {
        "Key": "username",
        "Value": "admin"
      },
      {
        "Key": "certificateVerification",
        "Value": "0"
      },
      {
        "Key": "requestTimeout",
        "Value": "2000"
      },
      {
        "Key": "requestRetryWaitMS",
        "Value": "100"
      },
      {
        "Key": "bearerToken",
        "Value": "password"
      },
      {
        "Key": "authSchemeOverride",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "enableTLS",
        "Value": "1"
      },
      {
        "Key": "websocketTimeout",
        "Value": "30"
      },
      {
        "Key": "networkPort",
        "Value": "80"
      },
      {
        "Key": "queryParams",
        "Value": "json=1"
      },
      {
        "Key": "urlPath",
        "Value": "/example/path"
      },
      {
        "Key": "oauth2ClientID",
        "Value": "placeholder_oauth2clientid"
      },
      {
        "Key": "enableMutualTLS",
        "Value": "1"
      },
      {
        "Key": "oauth2ClientSecret",
        "Value": ""
      },
      {
        "Key": "requestRetryCount",
        "Value": "0"
      },
      {
        "Key": "oauth2TokenEndpoint",
        "Value": "/example/path"
      },
      {
        "Key": "oauth2TokenParams",
        "Value": ""
      },
      {
        "Key": "clientPrivateKey",
        "Value": "<certificate>"
      },
      {
        "Key": "authenticationType",
        "Value": "0"
      },
      {
        "Key": "password",
        "Value": "password"
      },
      {
        "Key": "name",
        "Value": "abb-robot-web_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My ABB Robot Web Services Device",
            "DriverID": "97A7485B-816E-4F89-8155-48617608CC28",
            "Description": ""
        }
    }
}

Create Device - ABB Robot Web Services (No TLS)

POST {{edgeUrl}}/devicehub/v2

ABB Robot Web Services Controller

Driver ID: 97A7485B-816E-4F89-8155-48617608CC28 Group: Robot

Required properties: - clientCertificate String — Client Certificate (PEM) - username String — Username - bearerToken String — Client Token - networkAddress String — Server Hostname or IP - networkPort SignedInteger — Server Port - oauth2ClientID String — Client Identifier registered to the application - oauth2TokenEndpoint String — Authorization Server URL - clientPrivateKey String — Client Private Key (PEM) - password String — Password - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - oauth2Scopes String — Access request scope(s) (space separated values) - certificateAuthority String — CA Chain (PEM) - pathParams String — Common HTTP Path Parameters (JSON) - headers String — Common HTTP Headers (JSON) - certificateVerification SignedInteger — Verify server certificate Options: 0, 1 - requestTimeout SignedInteger — Request timeout, msec - requestRetryWaitMS SignedInteger — Pause between retries, msec - authSchemeOverride String — Authorization header scheme/prefix override - enableTLS SignedInteger — Enable TLS / HTTPS Options: 0, 1 - websocketTimeout SignedInteger — WebSocket Subscription Timeout, S - queryParams String — Common HTTP Query Parameters (JSON or Parameter string) - urlPath String — Common URL Path - enableMutualTLS SignedInteger — Enable mTLS / Client Certificate Options: 0, 1 - oauth2ClientSecret String — Client Secret registered to the application - requestRetryCount SignedInteger — Retry request count - oauth2TokenParams String — Additional token endpoint parameters (JSON or Parameter string) - authenticationType SignedInteger — Authentication Type Options: 0, 1, 2, 3, 4 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My ABB Robot Web Services Device (No TLS)",
    "Description": "",
    "DriverID": "97A7485B-816E-4F89-8155-48617608CC28",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "pathParams",
        "Value": ""
      },
      {
        "Key": "headers",
        "Value": ""
      },
      {
        "Key": "requestTimeout",
        "Value": "2000"
      },
      {
        "Key": "requestRetryWaitMS",
        "Value": "100"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "enableTLS",
        "Value": "0"
      },
      {
        "Key": "websocketTimeout",
        "Value": "30"
      },
      {
        "Key": "networkPort",
        "Value": "80"
      },
      {
        "Key": "queryParams",
        "Value": "json=1"
      },
      {
        "Key": "urlPath",
        "Value": "/example/path"
      },
      {
        "Key": "requestRetryCount",
        "Value": "0"
      },
      {
        "Key": "authenticationType",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "abb-robot-web_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My ABB Robot Web Services Device (No TLS)",
            "DriverID": "97A7485B-816E-4F89-8155-48617608CC28",
            "Description": ""
        }
    }
}

Create Device - ABB Totalflow DB2 (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

ABB Totalflow DB2 (Gen1.3)

Driver ID: EFE0CCA0-E2C0-4BAC-A535-766ECE45F66D Group: ABB

Required properties: - networkAddress String — IP Address of the device. - networkPort SignedInteger — Network port of the device. - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My ABB Totalflow DB2 (Gen1.3) Device",
    "Description": "",
    "DriverID": "EFE0CCA0-E2C0-4BAC-A535-766ECE45F66D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "name",
        "Value": "ABB"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My ABB Totalflow DB2 (Gen1.3) Device",
            "DriverID": "EFE0CCA0-E2C0-4BAC-A535-766ECE45F66D",
            "Description": ""
        }
    }
}

Create Device - ABB Totalflow DB2 Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

ABB Totalflow DB2 Serial (Gen1.3)

Driver ID: 15E3CB87-6179-4306-B68E-43038FE02127 Group: ABB

Required properties: - stopBits SignedInteger — Serial communication stopbits parameter. - name String — Device Name that describes your asset. - stationId SignedInteger — Station id/ slot number - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - parity SignedInteger — serial communication parity parameter. Options: 0, 1, 2 - deviceFile String — Local Serial connection file path.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My ABB Totalflow DB2 Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "15E3CB87-6179-4306-B68E-43038FE02127",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "ABB"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My ABB Totalflow DB2 Serial (Gen1.3) Device",
            "DriverID": "15E3CB87-6179-4306-B68E-43038FE02127",
            "Description": ""
        }
    }
}

Create Device - AutomationDirect Productivity Series Ethernet

POST {{edgeUrl}}/devicehub/v2

AutomationDirect Productivity Series Ethernet

Experimental

Driver ID: 257321A4-3069-4DF4-95F0-1599777C6FB4 Group: AutomationDirect

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - tagsCSV String — Name of the exported .csv tag file from Productivity Suite software which was uploaded to /ftp-data/devicehub/ - readTimeout SignedInteger — Read Timeout (ms) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My AutomationDirect Productivity Series Ethernet Device",
    "Description": "",
    "DriverID": "257321A4-3069-4DF4-95F0-1599777C6FB4",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "tagsCSV",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "readTimeout",
        "Value": "3000"
      },
      {
        "Key": "name",
        "Value": "ad-productivity-series-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My AutomationDirect Productivity Series Ethernet Device",
            "DriverID": "257321A4-3069-4DF4-95F0-1599777C6FB4",
            "Description": ""
        }
    }
}

Create Device - B&R PVI Ethernet

POST {{edgeUrl}}/devicehub/v2

B&R PVI Ethernet Driver

Driver ID: AA0D80DF-21C0-4C57-9320-C74CD64FF0BA Group: B&R

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My B&R PVI Ethernet Device",
    "Description": "",
    "DriverID": "AA0D80DF-21C0-4C57-9320-C74CD64FF0BA",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "name",
        "Value": "bnr_pvi_ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My B&R PVI Ethernet Device",
            "DriverID": "AA0D80DF-21C0-4C57-9320-C74CD64FF0BA",
            "Description": ""
        }
    }
}

Create Device - BacnetIP

POST {{edgeUrl}}/devicehub/v2

BACnet IP Driver

The driver implements the Client for communications protocol for Building Automation and Control (BAC) networks that leverage the ASHRAE, ANSI, and ISO 16484-5 standard protocol. The driver supports the IP data link layer.

Features:

• Discovering devices in the network (make sure devices to discover can receive the broadcast IP packets)
• Browsing the address space of the device
• Reading and writing "Present Value" (Property Identifier 85, The current value of the object)
• Read uses the services ReadProperty & ReadPropertyMultiple
• Write uses the services WriteProperty & WritePropertyMultiple

Driver ID: 83935618-A9BB-11EB-BCBC-0242AC130002 Group: BACnet

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - targetDeviceID SignedInteger — Target device ID - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - destinationAddress String — Destination address in hex string format. - destinationNetwork SignedInteger — Destination network. - instanceDeviceId SignedInteger — Instance device ID. If 0 will be random. - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My BacnetIP Device",
    "Description": "",
    "DriverID": "83935618-A9BB-11EB-BCBC-0242AC130002",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "destinationAddress",
        "Value": ""
      },
      {
        "Key": "destinationNetwork",
        "Value": "0"
      },
      {
        "Key": "instanceDeviceId",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "targetDeviceID",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "bacnet_ip_cpp_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My BacnetIP Device",
            "DriverID": "83935618-A9BB-11EB-BCBC-0242AC130002",
            "Description": ""
        }
    }
}

Create Device - BacnetMSTP

POST {{edgeUrl}}/devicehub/v2

BACnet MS/TP Driver

            The driver implements the Client for communications protocol for Building Automation and Control (BAC) networks that leverage the ASHRAE, ANSI, and ISO 16484-5 standard protocol. The driver supports the MS/TP data link layer.

            ## Features:
            * Browsing the address space of the device
            * Reading and writing properties of the objects

Driver ID: 83935618-A9BB-11EB-BCBC-0242AC132222 Group: BACnet

Required properties: - DeviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - ResponseTimeout SignedInteger — Response timeout, ms - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - BaudRate String — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7 - DataBits String — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - Parity String — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - StopBits String — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My BacnetMSTP Device",
    "Description": "",
    "DriverID": "83935618-A9BB-11EB-BCBC-0242AC132222",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "BaudRate",
        "Value": "0"
      },
      {
        "Key": "DataBits",
        "Value": "0"
      },
      {
        "Key": "DeviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "Parity",
        "Value": "0"
      },
      {
        "Key": "ResponseTimeout",
        "Value": "1000"
      },
      {
        "Key": "StopBits",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "bacnet_mstp_cpp_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My BacnetMSTP Device",
            "DriverID": "83935618-A9BB-11EB-BCBC-0242AC132222",
            "Description": ""
        }
    }
}

Create Device - Beckhoff TwinCAT2 Ethernet Absolute (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Beckhoff TwinCAT2 Ethernet Absolute

Driver ID: CBB394D8-42AB-42AC-84CD-480458835DAE Group: Beckhoff

Required properties: - name String — Device Name that describes your asset. - adsPort SignedInteger — ADS Port for the Twincat device. - amsId String — AMS Net ID for the Twincat device. - localAmsId String — Local AMS NET ID for the Twincat device. - networkAddress String — IP Address of the Twincat device. - networkPort SignedInteger — Network port of the Twincat device.

Optional properties: - description String — Description of the device or an asset. - maxRequestTags SignedInteger — Maximum Tags/Symbols per Request - maxArrayBrowseSize SignedInteger — Maximum Array Elements shown during Browse

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Beckhoff TwinCAT2 Ethernet Absolute (Gen1.3) Device",
    "Description": "",
    "DriverID": "CBB394D8-42AB-42AC-84CD-480458835DAE",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Device Name"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "adsPort",
        "Value": "502"
      },
      {
        "Key": "amsId",
        "Value": "0.0.0.0.1.1"
      },
      {
        "Key": "localAmsId",
        "Value": "0.0.0.0.1.1"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "maxRequestTags",
        "Value": "500"
      },
      {
        "Key": "maxArrayBrowseSize",
        "Value": "1000"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Beckhoff TwinCAT2 Ethernet Absolute (Gen1.3) Device",
            "DriverID": "CBB394D8-42AB-42AC-84CD-480458835DAE",
            "Description": ""
        }
    }
}

Create Device - Beckhoff TwinCAT3 Ethernet Absolute (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Beckhoff TwinCAT3 Ethernet Absolute

Driver ID: DABE4A08-6858-4A0C-B94E-A3BB45FE8147 Group: Beckhoff

Required properties: - adsPort SignedInteger — ADS Port for the Twincat device. - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the Twincat device. - amsId String — AMS Net ID for the Twincat device. - localAmsId String — Local AMS NET ID for the Twincat device. - networkAddress String — IP Address of the Twincat device.

Optional properties: - maxArrayBrowseSize SignedInteger — Maximum Array Elements shown during Browse - description String — Description of the device or an asset. - maxRequestTags SignedInteger — Maximum Tags/Symbols per Request

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Beckhoff TwinCAT3 Ethernet Absolute (Gen1.3) Device",
    "Description": "",
    "DriverID": "DABE4A08-6858-4A0C-B94E-A3BB45FE8147",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "adsPort",
        "Value": "502"
      },
      {
        "Key": "maxArrayBrowseSize",
        "Value": "1000"
      },
      {
        "Key": "name",
        "Value": "Device Name"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "amsId",
        "Value": "0.0.0.0.1.1"
      },
      {
        "Key": "localAmsId",
        "Value": "0.0.0.0.1.1"
      },
      {
        "Key": "maxRequestTags",
        "Value": "500"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Beckhoff TwinCAT3 Ethernet Absolute (Gen1.3) Device",
            "DriverID": "DABE4A08-6858-4A0C-B94E-A3BB45FE8147",
            "Description": ""
        }
    }
}

Create Device - Beckhoff TwinCAT3 Ethernet Symbolic (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Beckhoff TwinCAT3 Ethernet Symbolic

Driver ID: 9AA30E17-BE0A-4B7E-BFB8-CE09D4188021 Group: Beckhoff

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the Twincat device. - adsPort SignedInteger — ADS Port for the Twincat device. - localAmsId String — Local AMS NET ID for the Twincat device. - networkAddress String — IP Address of the Twincat device. - amsId String — AMS Net ID for the Twincat device.

Optional properties: - maxArrayBrowseSize SignedInteger — Maximum Array Elements shown during Browse - description String — Description of the device or an asset. - maxRequestTags SignedInteger — Maximum Tags/Symbols per Request

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Beckhoff TwinCAT3 Ethernet Symbolic (Gen1.3) Device",
    "Description": "",
    "DriverID": "9AA30E17-BE0A-4B7E-BFB8-CE09D4188021",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Device Name"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "adsPort",
        "Value": "502"
      },
      {
        "Key": "localAmsId",
        "Value": "0.0.0.0.1.1"
      },
      {
        "Key": "maxArrayBrowseSize",
        "Value": "1000"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "amsId",
        "Value": "0.0.0.0.1.1"
      },
      {
        "Key": "maxRequestTags",
        "Value": "500"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Beckhoff TwinCAT3 Ethernet Symbolic (Gen1.3) Device",
            "DriverID": "9AA30E17-BE0A-4B7E-BFB8-CE09D4188021",
            "Description": ""
        }
    }
}

Create Device - Brother Speedio Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Brother Speedio Ethernet

Driver ID: 99C745DC-4BB3-4408-B966-58805E56FECC Group: Brother Industries, Ltd

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Brother Speedio Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "99C745DC-4BB3-4408-B966-58805E56FECC",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Brother Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Brother Speedio Ethernet (Gen1.3) Device",
            "DriverID": "99C745DC-4BB3-4408-B966-58805E56FECC",
            "Description": ""
        }
    }
}

Create Device - Brother TC Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Brother TC Ethernet (Gen1.3)

Experimental

Driver ID: 5CAE67E3-C73D-4465-A515-AC65CFC91AAE Group: Brother Industries, Ltd

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Brother TC Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "5CAE67E3-C73D-4465-A515-AC65CFC91AAE",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Brother Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Brother TC Ethernet (Gen1.3) Device",
            "DriverID": "5CAE67E3-C73D-4465-A515-AC65CFC91AAE",
            "Description": ""
        }
    }
}

Create Device - CAN Raw (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

CAN Raw (Gen1.3)

Driver ID: 6A849294-D48A-4CE7-977F-96B1B6499A19 Group: CAN Bus

Required properties: - name String — Device Name that describes your asset. - interface String — Local interface of the SocketCAN compatible device. - channel String — Local data channel of the CAN Bus device. - bitRate SignedInteger — CAN Bus bitrate parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My CAN Raw (Gen1.3) Device",
    "Description": "",
    "DriverID": "6A849294-D48A-4CE7-977F-96B1B6499A19",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Can Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "interface",
        "Value": "socketcan"
      },
      {
        "Key": "channel",
        "Value": "can0"
      },
      {
        "Key": "bitRate",
        "Value": "1000000"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My CAN Raw (Gen1.3) Device",
            "DriverID": "6A849294-D48A-4CE7-977F-96B1B6499A19",
            "Description": ""
        }
    }
}

Create Device - CIP Ethernet

POST {{edgeUrl}}/devicehub/v2

CIP Ethernet

Driver ID: 60B722BA-4539-4D5D-9D2F-7C63F7FADBFB Group: ODVA

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - readTimeout SignedInteger — Read Timeout (ms) - serviceType UnsignedInteger Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My CIP Ethernet Device",
    "Description": "",
    "DriverID": "60B722BA-4539-4D5D-9D2F-7C63F7FADBFB",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "readTimeout",
        "Value": "3000"
      },
      {
        "Key": "serviceType",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "cip-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My CIP Ethernet Device",
            "DriverID": "60B722BA-4539-4D5D-9D2F-7C63F7FADBFB",
            "Description": ""
        }
    }
}

Create Device - CODESYS V2 Ethernet Absolute (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

CODESYS V2 Ethernet Absolute (Gen1.3)

Driver ID: 05FA3FB9-7FB1-45FB-8160-B2606F5DABFC Group: CodeSys Devices

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the Codesys system. - networkAddress String — IP Address of the Codesys system.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My CODESYS V2 Ethernet Absolute (Gen1.3) Device",
    "Description": "",
    "DriverID": "05FA3FB9-7FB1-45FB-8160-B2606F5DABFC",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Codesys Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My CODESYS V2 Ethernet Absolute (Gen1.3) Device",
            "DriverID": "05FA3FB9-7FB1-45FB-8160-B2606F5DABFC",
            "Description": ""
        }
    }
}

Create Device - CODESYS V2 Ethernet Symbolic (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

CODESYS V2 Ethernet Symbolic (Gen1.3)

Driver ID: 94B2C05D-8998-4755-A0B6-B3EFAC078A2D Group: CodeSys Devices

Required properties: - networkPort SignedInteger — Network port of the Codesys system. - Byteorder SignedInteger — Level 7 Motorola Byte Order. Options: 0, 1 - name String — Device Name that describes your asset. - path String — Register file path of device. - networkAddress String — IP Address of the Codesys system. - addressingMode SignedInteger — Offline/Online. Options: 0, 1 - protocol SignedInteger — Protocol. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My CODESYS V2 Ethernet Symbolic (Gen1.3) Device",
    "Description": "",
    "DriverID": "94B2C05D-8998-4755-A0B6-B3EFAC078A2D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "Byteorder",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "Codesys V2 Device"
      },
      {
        "Key": "path",
        "Value": "/example/path"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "addressingMode",
        "Value": "0"
      },
      {
        "Key": "protocol",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My CODESYS V2 Ethernet Symbolic (Gen1.3) Device",
            "DriverID": "94B2C05D-8998-4755-A0B6-B3EFAC078A2D",
            "Description": ""
        }
    }
}

Create Device - CSV Stream

POST {{edgeUrl}}/devicehub/v2

CSV Stream Driver

Driver ID: 17B16A98-C42B-4C46-80F7-8BA06A1F6B3C Group: Generic

Required properties: - Port SignedInteger — Server Port - Terminator String — Line Terminator - Certificate String — Certificate (PEM) - Address String — Server Address - PrivateKey String — Private Key (PEM) - CAChain String — Certificate Authority (PEM) - Interface String — Server Interface - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - Role SignedInteger — Transport Role Options: 0 - MinTLS SignedInteger — Minimum TLS Version Options: 0, 1, 2, 3 - MaxPDU SignedInteger — Maximum Message Size - Delimiter String — Field Delimiter - EnableTLS SignedInteger — Enable TLS Options: 0, 1 - ClientAuth SignedInteger — Enable Client Authentication (mTLS) Options: 0, 1 - Timeout SignedInteger — Connection Timeout (ms) - Transport SignedInteger — Transport Type Options: 0 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My CSV Stream Device",
    "Description": "",
    "DriverID": "17B16A98-C42B-4C46-80F7-8BA06A1F6B3C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "Role",
        "Value": "0"
      },
      {
        "Key": "Port",
        "Value": "1234"
      },
      {
        "Key": "MinTLS",
        "Value": "2"
      },
      {
        "Key": "MaxPDU",
        "Value": "65536"
      },
      {
        "Key": "Terminator",
        "Value": "\\n"
      },
      {
        "Key": "Certificate",
        "Value": "<certificate>"
      },
      {
        "Key": "Delimiter",
        "Value": ","
      },
      {
        "Key": "Address",
        "Value": "192.168.1.100"
      },
      {
        "Key": "EnableTLS",
        "Value": "1"
      },
      {
        "Key": "ClientAuth",
        "Value": "1"
      },
      {
        "Key": "PrivateKey",
        "Value": "<certificate>"
      },
      {
        "Key": "CAChain",
        "Value": "<certificate>"
      },
      {
        "Key": "Interface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "Timeout",
        "Value": "10000"
      },
      {
        "Key": "Transport",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "csv-stream_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My CSV Stream Device",
            "DriverID": "17B16A98-C42B-4C46-80F7-8BA06A1F6B3C",
            "Description": ""
        }
    }
}

Create Device - CSV Stream (No TLS)

POST {{edgeUrl}}/devicehub/v2

CSV Stream Driver

Driver ID: 17B16A98-C42B-4C46-80F7-8BA06A1F6B3C Group: Generic

Required properties: - Port SignedInteger — Server Port - Terminator String — Line Terminator - Certificate String — Certificate (PEM) - Address String — Server Address - PrivateKey String — Private Key (PEM) - CAChain String — Certificate Authority (PEM) - Interface String — Server Interface - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - Role SignedInteger — Transport Role Options: 0 - MinTLS SignedInteger — Minimum TLS Version Options: 0, 1, 2, 3 - MaxPDU SignedInteger — Maximum Message Size - Delimiter String — Field Delimiter - EnableTLS SignedInteger — Enable TLS Options: 0, 1 - ClientAuth SignedInteger — Enable Client Authentication (mTLS) Options: 0, 1 - Timeout SignedInteger — Connection Timeout (ms) - Transport SignedInteger — Transport Type Options: 0 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My CSV Stream Device (No TLS)",
    "Description": "",
    "DriverID": "17B16A98-C42B-4C46-80F7-8BA06A1F6B3C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "Role",
        "Value": "0"
      },
      {
        "Key": "Port",
        "Value": "1234"
      },
      {
        "Key": "MaxPDU",
        "Value": "65536"
      },
      {
        "Key": "Terminator",
        "Value": "\\n"
      },
      {
        "Key": "Delimiter",
        "Value": ","
      },
      {
        "Key": "Address",
        "Value": "192.168.1.100"
      },
      {
        "Key": "EnableTLS",
        "Value": "1"
      },
      {
        "Key": "Timeout",
        "Value": "10000"
      },
      {
        "Key": "Transport",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "csv-stream_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My CSV Stream Device (No TLS)",
            "DriverID": "17B16A98-C42B-4C46-80F7-8BA06A1F6B3C",
            "Description": ""
        }
    }
}

Create Device - Cutler-Hammer ELC Ethernet

POST {{edgeUrl}}/devicehub/v2

Cutler-Hammer ELC Ethernet Driver

Driver ID: 6BF05DB2-2BD5-4780-83BE-ACB878EFC042 Group: Cutler-Hammer

Required properties: - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - stationId SignedInteger — This is a station no of device. - networkAddress String — The IP address of the device on the network. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - requestTimeoutMs SignedInteger — Response Timeout (ms) - Zero-Based Addressing SignedInteger Options: 0, 1 - overrideStationID SignedInteger Options: 0, 1 - maxRequestSize SignedInteger — Maximum block size retrieved per request (# bytes) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Cutler-Hammer ELC Ethernet Device",
    "Description": "",
    "DriverID": "6BF05DB2-2BD5-4780-83BE-ACB878EFC042",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "requestTimeoutMs",
        "Value": "1000"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "Zero-Based Addressing",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "overrideStationID",
        "Value": "0"
      },
      {
        "Key": "maxRequestSize",
        "Value": "512"
      },
      {
        "Key": "name",
        "Value": "cutler-hammer-elc-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Cutler-Hammer ELC Ethernet Device",
            "DriverID": "6BF05DB2-2BD5-4780-83BE-ACB878EFC042",
            "Description": ""
        }
    }
}

Create Device - Cutler-Hammer ELC Serial

POST {{edgeUrl}}/devicehub/v2

Cutler-Hammer ELC Serial Driver

Driver ID: 77155198-9657-456C-99AB-D10F55322193 Group: Cutler-Hammer

Required properties: - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - stationId SignedInteger — This is a station no of device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - Zero-Based Addressing SignedInteger Options: 0, 1 - maxRequestSize SignedInteger — Maximum block size retrieved per request (# bytes) - requestTimeoutMs SignedInteger — Response Timeout (ms) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Cutler-Hammer ELC Serial Device",
    "Description": "",
    "DriverID": "77155198-9657-456C-99AB-D10F55322193",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "dataBits",
        "Value": "7"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "Zero-Based Addressing",
        "Value": "0"
      },
      {
        "Key": "maxRequestSize",
        "Value": "512"
      },
      {
        "Key": "stationId",
        "Value": "0"
      },
      {
        "Key": "requestTimeoutMs",
        "Value": "1000"
      },
      {
        "Key": "name",
        "Value": "cutler-hammer-elc-serial_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Cutler-Hammer ELC Serial Device",
            "DriverID": "77155198-9657-456C-99AB-D10F55322193",
            "Description": ""
        }
    }
}

Create Device - Danfoss FC/TSC

POST {{edgeUrl}}/devicehub/v2

Danfoss FC/TSC

Driver ID: 28B130B3-530E-4644-99EF-4FDC06C758DF Group: Danfoss

Required properties: - networkAddress String — VFD's IP Address - networkPort SignedInteger — TCP/IP port - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Danfoss FC/TSC Device",
    "Description": "",
    "DriverID": "28B130B3-530E-4644-99EF-4FDC06C758DF",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "name",
        "Value": "danfoss-fc-tsc_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Danfoss FC/TSC Device",
            "DriverID": "28B130B3-530E-4644-99EF-4FDC06C758DF",
            "Description": ""
        }
    }
}

Create Device - Delta DVP Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Delta DVP Ethernet (Gen1.3)

Driver ID: 9F48C353-AEA4-4CE3-AE15-686A557CEFB5 Group: Delta PLC

Required properties: - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device. - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Delta DVP Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "9F48C353-AEA4-4CE3-AE15-686A557CEFB5",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "delta device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Delta DVP Ethernet (Gen1.3) Device",
            "DriverID": "9F48C353-AEA4-4CE3-AE15-686A557CEFB5",
            "Description": ""
        }
    }
}

Create Device - DeviceHub Agent

POST {{edgeUrl}}/devicehub/v2

DeviceHub Agent

Driver ID: 6C3031AE-E667-4849-A302-6D074FE5DFD3 Group: OPCUA

Required properties: - networkPort SignedInteger — Listen port - dataValidityPeriod SignedInteger — The time period after which the data become invalid - networkAddress String — Listen host (Caution! If unsure set it to 0.0.0.0) - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My DeviceHub Agent Device",
    "Description": "",
    "DriverID": "6C3031AE-E667-4849-A302-6D074FE5DFD3",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "41250"
      },
      {
        "Key": "dataValidityPeriod",
        "Value": "60"
      },
      {
        "Key": "networkAddress",
        "Value": "0.0.0.0"
      },
      {
        "Key": "name",
        "Value": "devicehub-agent_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My DeviceHub Agent Device",
            "DriverID": "6C3031AE-E667-4849-A302-6D074FE5DFD3",
            "Description": ""
        }
    }
}

Create Device - DNP3 Ethernet

POST {{edgeUrl}}/devicehub/v2

DNP3 Ethernet

Driver ID: 96B7A2BE-1EA8-4DC0-8809-EBF867ADFFFF Group: Emerson

Required properties: - class1PollPeriod SignedInteger - class2PollPeriod SignedInteger - class3PollPeriod SignedInteger - networkAddress String — Device IP Address - networkPort SignedInteger — TCP/IP Port - masterAddress SignedInteger — Master Station Address - outstationAddress SignedInteger — DNP3 Outstation Address - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - enableTimeSync SignedInteger Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My DNP3 Ethernet Device",
    "Description": "",
    "DriverID": "96B7A2BE-1EA8-4DC0-8809-EBF867ADFFFF",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "class1PollPeriod",
        "Value": "5"
      },
      {
        "Key": "class2PollPeriod",
        "Value": "5"
      },
      {
        "Key": "class3PollPeriod",
        "Value": "5"
      },
      {
        "Key": "enableTimeSync",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "masterAddress",
        "Value": "0"
      },
      {
        "Key": "outstationAddress",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "dnp3-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My DNP3 Ethernet Device",
            "DriverID": "96B7A2BE-1EA8-4DC0-8809-EBF867ADFFFF",
            "Description": ""
        }
    }
}

Create Device - DNP3 Ethernet with FB Extensions

POST {{edgeUrl}}/devicehub/v2

DNP3 Ethernet with FB Extensions

Driver ID: 2FBB1709-E94F-4244-BFC8-779C4D504ADA Group: Emerson

Required properties: - masterAddress SignedInteger — Master Station Address - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - outstationAddress SignedInteger — DNP3 Outstation Address - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - class123PollPeriod SignedInteger — Class123 Polling period - enableTimeSync SignedInteger — Enable Time Sync Options: 0, 1 - password String — Password - user String - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My DNP3 Ethernet with FB Extensions Device",
    "Description": "",
    "DriverID": "2FBB1709-E94F-4244-BFC8-779C4D504ADA",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "class123PollPeriod",
        "Value": "30"
      },
      {
        "Key": "enableTimeSync",
        "Value": "0"
      },
      {
        "Key": "masterAddress",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "outstationAddress",
        "Value": "1"
      },
      {
        "Key": "password",
        "Value": ""
      },
      {
        "Key": "user",
        "Value": ""
      },
      {
        "Key": "name",
        "Value": "DNP3 Ethernet with FB Extensions_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My DNP3 Ethernet with FB Extensions Device",
            "DriverID": "2FBB1709-E94F-4244-BFC8-779C4D504ADA",
            "Description": ""
        }
    }
}

Create Device - DNP3 Master

POST {{edgeUrl}}/devicehub/v2

DNP3 Master Driver

Driver ID: 12EC6276-32E0-41C1-812B-FA9746ECF42F Group: DNP3

Required properties: - masterAddress SignedInteger — Master Station Address - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - outstationAddress SignedInteger — DNP3 Outstation Address - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - class123PollPeriod SignedInteger — Class123 Polling period - enableTimeSync SignedInteger — Enable Time Sync Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My DNP3 Master Device",
    "Description": "",
    "DriverID": "12EC6276-32E0-41C1-812B-FA9746ECF42F",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "class123PollPeriod",
        "Value": "30"
      },
      {
        "Key": "enableTimeSync",
        "Value": "0"
      },
      {
        "Key": "masterAddress",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "outstationAddress",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "DNP3_Master_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My DNP3 Master Device",
            "DriverID": "12EC6276-32E0-41C1-812B-FA9746ECF42F",
            "Description": ""
        }
    }
}

Create Device - EBC Ethernet

POST {{edgeUrl}}/devicehub/v2

AutomationDirect EBC

Driver ID: 386981A0-FB2A-447C-93A6-9373D82AA32A Group: AutomationDirect

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - readTimeout SignedInteger — Read Timeout (ms) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My EBC Ethernet Device",
    "Description": "",
    "DriverID": "386981A0-FB2A-447C-93A6-9373D82AA32A",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "readTimeout",
        "Value": "1000"
      },
      {
        "Key": "name",
        "Value": "ebc-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My EBC Ethernet Device",
            "DriverID": "386981A0-FB2A-447C-93A6-9373D82AA32A",
            "Description": ""
        }
    }
}

Create Device - ELC Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

ELC Serial (Gen1.3)

Driver ID: E48B9CBE-DBBB-420C-BDF0-8BAED607DFE0 Group: Cutler-Hammer

Required properties: - baudRate SignedInteger — Serial communication baudrate parameter. - parity SignedInteger — Serial communication parity parameter Options: 0, 1, 2 - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My ELC Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "E48B9CBE-DBBB-420C-BDF0-8BAED607DFE0",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "delta device"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "dataBits",
        "Value": "7"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My ELC Serial (Gen1.3) Device",
            "DriverID": "E48B9CBE-DBBB-420C-BDF0-8BAED607DFE0",
            "Description": ""
        }
    }
}

Create Device - Enron Modbus

POST {{edgeUrl}}/devicehub/v2

Enron Modbus

Driver ID: 410EFF34-68C9-4630-AB8D-A8E438995FD3 Group: Modbus

Required properties: - protocolMode SignedInteger — Protocol Mode Options: 0, 1 - requestTimeoutMs SignedInteger — Request timeout, msec - networkAddress String — PLC IP - networkPort SignedInteger — PLC Port - overrideStationID SignedInteger — Override registers' Station ID setting Options: 0, 1 - bytesAndWordsOrder SignedInteger — Bytes And Words Order Options: 0, 1, 2, 3 - overrideBWOrder SignedInteger — Override registers' "Bytes And Words Order" setting Options: 0, 1 - protocolBaseYear UnsignedInteger — Base year for date conversion - transportType SignedInteger — Transport Type Options: 0, 1 - connectionTimeoutSec SignedInteger — Connection timeout, sec - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - stationID SignedInteger — Station ID - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - retryRequestCount SignedInteger — Retry request count - pauseBetweenRetriesMs SignedInteger — Pause between retries, msec - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Enron Modbus Device",
    "Description": "",
    "DriverID": "410EFF34-68C9-4630-AB8D-A8E438995FD3",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "protocolMode",
        "Value": "0"
      },
      {
        "Key": "requestTimeoutMs",
        "Value": "2000"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "overrideStationID",
        "Value": "0"
      },
      {
        "Key": "bytesAndWordsOrder",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "overrideBWOrder",
        "Value": "0"
      },
      {
        "Key": "protocolBaseYear",
        "Value": "2000"
      },
      {
        "Key": "transportType",
        "Value": "0"
      },
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "connectionTimeoutSec",
        "Value": "5"
      },
      {
        "Key": "retryRequestCount",
        "Value": "0"
      },
      {
        "Key": "pauseBetweenRetriesMs",
        "Value": "0"
      },
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "stationID",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "Enron-Modbus_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Enron Modbus Device",
            "DriverID": "410EFF34-68C9-4630-AB8D-A8E438995FD3",
            "Description": ""
        }
    }
}

Create Device - EUROMAP 63

POST {{edgeUrl}}/devicehub/v2

EUROMAP 63

Driver ID: D9EB6EC4-6A99-4E26-8358-1C3A1B9A8078 Group: Euromap63

Required properties: - name String — This is a Device Name.

Optional properties: - sessionDir String — Communication Sessions are initiated by placing Session Request files in a particular Directory - sessionMin SignedInteger - sessionMax SignedInteger - sessionTimeout SignedInteger - datFileTimeout SignedInteger - keepFiles SignedInteger — If enabled, the driver will not delete RSP and DAT files for troubleshooting Options: 0, 1 - description String — This is a description of device.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My EUROMAP 63 Device",
    "Description": "",
    "DriverID": "D9EB6EC4-6A99-4E26-8358-1C3A1B9A8078",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "sessionDir",
        "Value": "/data/euromap63"
      },
      {
        "Key": "sessionMin",
        "Value": "1"
      },
      {
        "Key": "sessionMax",
        "Value": "4"
      },
      {
        "Key": "sessionTimeout",
        "Value": "10"
      },
      {
        "Key": "datFileTimeout",
        "Value": "60"
      },
      {
        "Key": "keepFiles",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "euromap63_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My EUROMAP 63 Device",
            "DriverID": "D9EB6EC4-6A99-4E26-8358-1C3A1B9A8078",
            "Description": ""
        }
    }
}

Create Device - Excel (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Excel (Gen1.3)

Driver ID: 7AC52EDC-EBA9-4669-82CF-8EA99323E697 Group: Excel

Required properties: - name String — Device Name that describes your asset. - path String — Path to Excel file.

Optional properties: - description String — Description of the device or an asset. - cellPublishingOption SignedInteger — Cell Publishing Option parameter. Options: 0, 1

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Excel (Gen1.3) Device",
    "Description": "",
    "DriverID": "7AC52EDC-EBA9-4669-82CF-8EA99323E697",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Excel"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "path",
        "Value": "/example/path"
      },
      {
        "Key": "cellPublishingOption",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Excel (Gen1.3) Device",
            "DriverID": "7AC52EDC-EBA9-4669-82CF-8EA99323E697",
            "Description": ""
        }
    }
}

Create Device - Fanuc CNC Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Fanuc CNC Ethernet

Driver ID: 588C8307-33D1-4526-85BD-FECC82C82C2E Group: Fanuc Corporation

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Fanuc CNC Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "588C8307-33D1-4526-85BD-FECC82C82C2E",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Fanuc CNC Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Fanuc CNC Ethernet (Gen1.3) Device",
            "DriverID": "588C8307-33D1-4526-85BD-FECC82C82C2E",
            "Description": ""
        }
    }
}

Create Device - FB107 Ethernet

POST {{edgeUrl}}/devicehub/v2

FB107

Driver ID: 41D18BCA-6BB1-450F-88C9-35B27E6210D0 Group: Emerson

Required properties: - operatorID String — Operator ID - password SignedInteger — Password - deviceAddress SignedInteger — FB107 Station Address - hostGroup SignedInteger — Host Station Group - hostAddress SignedInteger — Host Station Address - networkAddress String — Device IP Address - networkPort SignedInteger — TCP/IP Port - deviceGroup SignedInteger — FB107 Station Group - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - nextRequestDelay SignedInteger — Delay before next Request (ms) - responseTimeout SignedInteger — Response timeout (ms) - optimizations SignedInteger Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My FB107 Ethernet Device",
    "Description": "",
    "DriverID": "41D18BCA-6BB1-450F-88C9-35B27E6210D0",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "operatorID",
        "Value": "LOI"
      },
      {
        "Key": "password",
        "Value": "1000"
      },
      {
        "Key": "deviceAddress",
        "Value": "240"
      },
      {
        "Key": "hostGroup",
        "Value": "1"
      },
      {
        "Key": "hostAddress",
        "Value": "239"
      },
      {
        "Key": "nextRequestDelay",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "deviceGroup",
        "Value": "240"
      },
      {
        "Key": "responseTimeout",
        "Value": "3000"
      },
      {
        "Key": "optimizations",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "fb107-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My FB107 Ethernet Device",
            "DriverID": "41D18BCA-6BB1-450F-88C9-35B27E6210D0",
            "Description": ""
        }
    }
}

Create Device - Fuji NB serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Fuji NB Serial (Gen1.3)

Driver ID: E9DA2966-C794-4282-854C-F624F84DCB75 Group: Fuji Devices

Required properties: - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Fuji NB serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "E9DA2966-C794-4282-854C-F624F84DCB75",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "fuji device"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Fuji NB serial (Gen1.3) Device",
            "DriverID": "E9DA2966-C794-4282-854C-F624F84DCB75",
            "Description": ""
        }
    }
}

Create Device - Fuji SPH2000 Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Fuji SPH2000 Ethernet (Gen1.3)

Driver ID: 2BB297DF-B51E-4E0B-ABE9-52267DFBDAFB Group: Fuji Devices

Required properties: - networkAddress String — IP Address of the device. - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Fuji SPH2000 Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "2BB297DF-B51E-4E0B-ABE9-52267DFBDAFB",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "Fuji device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Fuji SPH2000 Ethernet (Gen1.3) Device",
            "DriverID": "2BB297DF-B51E-4E0B-ABE9-52267DFBDAFB",
            "Description": ""
        }
    }
}

Create Device - GE EGD Ethernet

POST {{edgeUrl}}/devicehub/v2

GE EGD Ethernet

Experimental

Driver ID: CDFACE5B-7202-4FA9-B0D9-37256AB1F9C3 Group: GE Fanuc

Required properties: - networkInterface String - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - producerExchange1Destination String - producerExchange1ID UnsignedInteger - producerExchange1Size UnsignedInteger - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE EGD Ethernet Device",
    "Description": "",
    "DriverID": "CDFACE5B-7202-4FA9-B0D9-37256AB1F9C3",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkInterface",
        "Value": "10.17.11.242/22"
      },
      {
        "Key": "networkPort",
        "Value": "18246"
      },
      {
        "Key": "producerExchange1Destination",
        "Value": "192.168.0.1"
      },
      {
        "Key": "producerExchange1ID",
        "Value": "1"
      },
      {
        "Key": "producerExchange1Size",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "ge-egd-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE EGD Ethernet Device",
            "DriverID": "CDFACE5B-7202-4FA9-B0D9-37256AB1F9C3",
            "Description": ""
        }
    }
}

Create Device - GE Ethernet Absolute

POST {{edgeUrl}}/devicehub/v2

GE Ethernet Absolute

Driver ID: 4561ACD1-343B-40A1-9DD6-51F0EB4FBF28 Group: GE Fanuc

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - slotNumber SignedInteger — Slot# in Rack0 - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - readTimeout SignedInteger — Read Timeout (ms) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE Ethernet Absolute Device",
    "Description": "",
    "DriverID": "4561ACD1-343B-40A1-9DD6-51F0EB4FBF28",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "readTimeout",
        "Value": "3000"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "slotNumber",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "ge-abs-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE Ethernet Absolute Device",
            "DriverID": "4561ACD1-343B-40A1-9DD6-51F0EB4FBF28",
            "Description": ""
        }
    }
}

Create Device - GE Ethernet Symbolic

POST {{edgeUrl}}/devicehub/v2

GE Ethernet Symbolic

Driver ID: 85F8517C-0453-4B78-8B0C-74ED738A9EC4 Group: GE Fanuc

Required properties: - slotNumber SignedInteger — Slot# in Rack0 - networkAddress String — The IP address of the device on the network. - networkPort SignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - readTimeout SignedInteger — Read Timeout (ms) - globalVariablesCSV String — FTP path to .SNF file - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE Ethernet Symbolic Device",
    "Description": "",
    "DriverID": "85F8517C-0453-4B78-8B0C-74ED738A9EC4",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "slotNumber",
        "Value": "0"
      },
      {
        "Key": "readTimeout",
        "Value": "3000"
      },
      {
        "Key": "globalVariablesCSV",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "name",
        "Value": "ge-sym-ethernet_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE Ethernet Symbolic Device",
            "DriverID": "85F8517C-0453-4B78-8B0C-74ED738A9EC4",
            "Description": ""
        }
    }
}

Create Device - GE Fanuc 90-30 Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

GE Fanuc 90-30 Ethernet (Gen1.3)

Driver ID: 4C9B19DF-60AA-4667-A1A3-62CBA2F1B2CF Group: GE Fanuc

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE Fanuc 90-30 Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "4C9B19DF-60AA-4667-A1A3-62CBA2F1B2CF",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Fanuc Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE Fanuc 90-30 Ethernet (Gen1.3) Device",
            "DriverID": "4C9B19DF-60AA-4667-A1A3-62CBA2F1B2CF",
            "Description": ""
        }
    }
}

Create Device - GE Fanuc CMM Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

GE Fanuc CMM Serial (Gen1.3) Serial

Driver ID: 5F7ED114-AFBE-45DE-B86A-035DE603A82B Group: GE Fanuc

Required properties: - deviceFile String — Local Serial connection file path. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter Options: 0, 1, 2 - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE Fanuc CMM Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "5F7ED114-AFBE-45DE-B86A-035DE603A82B",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "GE Fanuc Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE Fanuc CMM Serial (Gen1.3) Device",
            "DriverID": "5F7ED114-AFBE-45DE-B86A-035DE603A82B",
            "Description": ""
        }
    }
}

Create Device - GE Fanuc RX3i Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

GE Fanuc RX3i Serial (Gen1.3)

Driver ID: F2AEC18F-3D63-4661-9E84-83E6FCB087AE Group: GE Fanuc

Required properties: - stationId SignedInteger — Station no./ slot no. of PLC - stopBits SignedInteger — Serial communication stopbits parameter. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE Fanuc RX3i Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "F2AEC18F-3D63-4661-9E84-83E6FCB087AE",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "GE Fanuc Device"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE Fanuc RX3i Serial (Gen1.3) Device",
            "DriverID": "F2AEC18F-3D63-4661-9E84-83E6FCB087AE",
            "Description": ""
        }
    }
}

Create Device - GE Fanuc SNP Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

GE Fanuc SNP Serial (Gen1.3)

Driver ID: A72B91B9-6666-41E8-9C3F-8B3B96A76ECE Group: GE Fanuc

Required properties: - deviceFile String — Local Serial connection file path. - stationId SignedInteger — Station Id/Slot number of PLC - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My GE Fanuc SNP Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "A72B91B9-6666-41E8-9C3F-8B3B96A76ECE",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "GE Fanuc Device"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My GE Fanuc SNP Serial (Gen1.3) Device",
            "DriverID": "A72B91B9-6666-41E8-9C3F-8B3B96A76ECE",
            "Description": ""
        }
    }
}

Create Device - Generator

POST {{edgeUrl}}/devicehub/v2

Generator driver

Driver ID: 5BC98836-CFD4-11E9-BB65-2A2AE2DBCCE4 Group: Simulator

Required properties: - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Generator Device",
    "Description": "",
    "DriverID": "5BC98836-CFD4-11E9-BB65-2A2AE2DBCCE4",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "generator_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Generator Device",
            "DriverID": "5BC98836-CFD4-11E9-BB65-2A2AE2DBCCE4",
            "Description": ""
        }
    }
}

Create Device - Generic Device

POST {{edgeUrl}}/devicehub/v2

Generic Device Driver

Driver ID: 2ED8A8E1-1DF4-481A-9033-03F6E8E9456E Group: Generic

Required properties: - networkPort SignedInteger — Port - clientCertificate String — Client Certificate (PEM) - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - connectionPayload String — Connection Request (Hex String) - clientPrivateKey String — Client Private Key (PEM) - networkAddress String — IP Address - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - enableTLS SignedInteger — Enable TLS Options: 0, 1 - MultipleConnections SignedInteger — Enable if using multiple streams Options: 0, 1 - enableMutualTLS SignedInteger — Enable mTLS / Client Certificate Options: 0, 1 - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataByteOrder SignedInteger — Default Data Endianness Options: 0, 1, 2, 3 - sessionParams Text — Session Parameters (JSON) - connectionRequest SignedInteger — If enabled this field is used to enter the command that initiates the connection with the device Options: 0, 1 - certificateAuthority String — CA Chain (PEM) - RetryCount SignedInteger — Retry request count - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - Transport SignedInteger — Transport Type Options: 0, 1, 2 - responseIndex SignedInteger — Response Parsing - Start Index - protocolByteOrder SignedInteger — Protocol Endianness Options: 0, 1, 2, 3 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - ReadTimeout SignedInteger — Request timeout, msec - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - certificateVerification SignedInteger — Verify server certificate Options: 0, 1 - PauseBetweenRetries SignedInteger — Pause between retries, msec - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Generic Device Device",
    "Description": "",
    "DriverID": "2ED8A8E1-1DF4-481A-9033-03F6E8E9456E",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "1234"
      },
      {
        "Key": "clientCertificate",
        "Value": "<certificate>"
      },
      {
        "Key": "enableTLS",
        "Value": "1"
      },
      {
        "Key": "MultipleConnections",
        "Value": "1"
      },
      {
        "Key": "enableMutualTLS",
        "Value": "1"
      },
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "baudRate",
        "Value": "3"
      },
      {
        "Key": "connectionPayload",
        "Value": "placeholder_connectionpayload"
      },
      {
        "Key": "dataByteOrder",
        "Value": "0"
      },
      {
        "Key": "sessionParams",
        "Value": ""
      },
      {
        "Key": "connectionRequest",
        "Value": "1"
      },
      {
        "Key": "certificateAuthority",
        "Value": ""
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "Transport",
        "Value": "0"
      },
      {
        "Key": "clientPrivateKey",
        "Value": "<certificate>"
      },
      {
        "Key": "responseIndex",
        "Value": "0"
      },
      {
        "Key": "protocolByteOrder",
        "Value": "0"
      },
      {
        "Key": "parity",
        "Value": "1"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "dataBits",
        "Value": "3"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "certificateVerification",
        "Value": "0"
      },
      {
        "Key": "PauseBetweenRetries",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "generic-device_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Generic Device Device",
            "DriverID": "2ED8A8E1-1DF4-481A-9033-03F6E8E9456E",
            "Description": ""
        }
    }
}

Create Device - Generic Device (No TLS)

POST {{edgeUrl}}/devicehub/v2

Generic Device Driver

Driver ID: 2ED8A8E1-1DF4-481A-9033-03F6E8E9456E Group: Generic

Required properties: - networkPort SignedInteger — Port - clientCertificate String — Client Certificate (PEM) - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - connectionPayload String — Connection Request (Hex String) - clientPrivateKey String — Client Private Key (PEM) - networkAddress String — IP Address - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - enableTLS SignedInteger — Enable TLS Options: 0, 1 - MultipleConnections SignedInteger — Enable if using multiple streams Options: 0, 1 - enableMutualTLS SignedInteger — Enable mTLS / Client Certificate Options: 0, 1 - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataByteOrder SignedInteger — Default Data Endianness Options: 0, 1, 2, 3 - sessionParams Text — Session Parameters (JSON) - connectionRequest SignedInteger — If enabled this field is used to enter the command that initiates the connection with the device Options: 0, 1 - certificateAuthority String — CA Chain (PEM) - RetryCount SignedInteger — Retry request count - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - Transport SignedInteger — Transport Type Options: 0, 1, 2 - responseIndex SignedInteger — Response Parsing - Start Index - protocolByteOrder SignedInteger — Protocol Endianness Options: 0, 1, 2, 3 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - ReadTimeout SignedInteger — Request timeout, msec - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - certificateVerification SignedInteger — Verify server certificate Options: 0, 1 - PauseBetweenRetries SignedInteger — Pause between retries, msec - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Generic Device Device (No TLS)",
    "Description": "",
    "DriverID": "2ED8A8E1-1DF4-481A-9033-03F6E8E9456E",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "1234"
      },
      {
        "Key": "enableTLS",
        "Value": "1"
      },
      {
        "Key": "MultipleConnections",
        "Value": "1"
      },
      {
        "Key": "KeepAlive",
        "Value": "5"
      },
      {
        "Key": "dataByteOrder",
        "Value": "0"
      },
      {
        "Key": "sessionParams",
        "Value": ""
      },
      {
        "Key": "connectionRequest",
        "Value": "1"
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "Transport",
        "Value": "0"
      },
      {
        "Key": "protocolByteOrder",
        "Value": "0"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "PauseBetweenRetries",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "generic-device_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Generic Device Device (No TLS)",
            "DriverID": "2ED8A8E1-1DF4-481A-9033-03F6E8E9456E",
            "Description": ""
        }
    }
}

Create Device - Heidenhain 530 Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Heidenhain 530 Ethernet (Gen1.3)

Driver ID: BC328283-3630-479E-A503-0EC999898B3E Group: Heidenhain

Required properties: - networkAddress String — IP Address of the device. - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Heidenhain 530 Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "BC328283-3630-479E-A503-0EC999898B3E",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "Heidenhain Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Heidenhain 530 Ethernet (Gen1.3) Device",
            "DriverID": "BC328283-3630-479E-A503-0EC999898B3E",
            "Description": ""
        }
    }
}

Create Device - Heidenhain 640 Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Heidenhain 640 Ethernet (Gen1.3)

Driver ID: 479A3869-9394-4F8B-869D-EB19454146AD Group: Heidenhain

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Heidenhain 640 Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "479A3869-9394-4F8B-869D-EB19454146AD",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "Heidenhain Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Heidenhain 640 Ethernet (Gen1.3) Device",
            "DriverID": "479A3869-9394-4F8B-869D-EB19454146AD",
            "Description": ""
        }
    }
}

Create Device - HID Device (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

HID Device (Gen1.3)

This driver will publish the value of a string of ASCII characters only after a carriage return (\n) is sent.

Driver ID: A06BEA40-76CD-4EFE-9E52-E56A6F2AE434 Group: HID Devices

Required properties: - deviceFile String — Local Serial connection file path. - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My HID Device (Gen1.3) Device",
    "Description": "",
    "DriverID": "A06BEA40-76CD-4EFE-9E52-E56A6F2AE434",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "deviceFile",
        "Value": "/dev/hidraw0"
      },
      {
        "Key": "name",
        "Value": "hid device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My HID Device (Gen1.3) Device",
            "DriverID": "A06BEA40-76CD-4EFE-9E52-E56A6F2AE434",
            "Description": ""
        }
    }
}

Create Device - Hitachi serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Hitachi Serial (Gen1.3)

Driver ID: FAE5C1D8-A774-4D9A-A186-5ADAEDA0B31D Group: Hitachi Devices

Required properties: - deviceFile String — Local Serial connection file path. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Hitachi serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "FAE5C1D8-A774-4D9A-A186-5ADAEDA0B31D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "hitachi device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "7"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Hitachi serial (Gen1.3) Device",
            "DriverID": "FAE5C1D8-A774-4D9A-A186-5ADAEDA0B31D",
            "Description": ""
        }
    }
}

Create Device - IEC60870-5-102 Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

IEC60870-5-102 Ethernet (Gen1.3)

Driver ID: 94290D6F-4197-4DBF-9847-1848F9840F63 Group: IEC

Required properties: - networkPort SignedInteger — Network port of the device. - linkAddress SignedInteger — Link Address. - asduAddrSize SignedInteger — Size of ASDU Address. - name String — Device Name that describes your asset. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My IEC60870-5-102 Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "94290D6F-4197-4DBF-9847-1848F9840F63",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "linkAddress",
        "Value": "3"
      },
      {
        "Key": "asduAddrSize",
        "Value": "2"
      },
      {
        "Key": "name",
        "Value": "IEC Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My IEC60870-5-102 Ethernet (Gen1.3) Device",
            "DriverID": "94290D6F-4197-4DBF-9847-1848F9840F63",
            "Description": ""
        }
    }
}

Create Device - IEC60870-5-104 Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

IEC60870-5-104 Ethernet (Gen1.3)

Driver ID: EFD8528C-5C90-4454-81F9-6DC851F63936 Group: IEC

Required properties: - name String — Device Name that describes your asset. - networkAddress String — IP Address of the device. - networkPort SignedInteger — Network port of the device. - stationId SignedInteger — Station id/ slot number

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My IEC60870-5-104 Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "EFD8528C-5C90-4454-81F9-6DC851F63936",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "IEC Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "stationId",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My IEC60870-5-104 Ethernet (Gen1.3) Device",
            "DriverID": "EFD8528C-5C90-4454-81F9-6DC851F63936",
            "Description": ""
        }
    }
}

Create Device - IEC61850 MMS Client

POST {{edgeUrl}}/devicehub/v2

IEC61850 MMS Client Driver

Driver ID: 69E7E8D0-0D2C-4F2A-AB84-7A989BB83C14 Group: IEC

Required properties: - networkAddress String — The IP address of the device on the network. - networkPort UnsignedInteger — The TCP or UDP port used to communicate with the device, depending on the protocol. Defaults to the standard port for the selected protocol but must match the port configured on the device. - requestTimeout UnsignedInteger — Request timeout, msec - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - AuthMethod String — Authorization method Options: 0, 1, 2 - CA Certificate String — CA certificate used to validate peer certificates (PEM format) - Certificate String — Client certificate (PEM format) - Password String — Password - PrivateKey String — Client private key (PEM format) - allowOnlyKnownCertificates String — If set to true only known certificates are accepted. Connections with unknown certificates are rejected even if they are signed by a trusted authority. Options: 0, 1 - chainValidation String — Enables the validation of the certificate trust chain. Options: 0, 1 - timeValidation String — Enables the verification of validity times for certificates and CRLs. Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My IEC61850 MMS Client Device",
    "Description": "",
    "DriverID": "69E7E8D0-0D2C-4F2A-AB84-7A989BB83C14",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "AuthMethod",
        "Value": "0"
      },
      {
        "Key": "CA Certificate",
        "Value": ""
      },
      {
        "Key": "Certificate",
        "Value": "<certificate>"
      },
      {
        "Key": "Password",
        "Value": ""
      },
      {
        "Key": "PrivateKey",
        "Value": "<certificate>"
      },
      {
        "Key": "allowOnlyKnownCertificates",
        "Value": "0"
      },
      {
        "Key": "chainValidation",
        "Value": "1"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "102"
      },
      {
        "Key": "requestTimeout",
        "Value": "5000"
      },
      {
        "Key": "timeValidation",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "iec61850mms_client_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My IEC61850 MMS Client Device",
            "DriverID": "69E7E8D0-0D2C-4F2A-AB84-7A989BB83C14",
            "Description": ""
        }
    }
}

Create Device - Ignition Module

POST {{edgeUrl}}/devicehub/v2

Ignition Module

Driver ID: C7B2183F-2BB8-415E-83A3-AA3FF8A20BF5 Group: Ignition

Required properties: - writeRequestItemsCount SignedInteger — Write request max items count - networkPort SignedInteger — Port - interface String — Interface - enableTLS SignedInteger — Enable TLS Authentication Options: 0, 1 - browseRequestItemsCount SignedInteger — Browse request max items count - user String — User - password String — Password - TLScert String — Certificate (PEM) - TLSpkey String — Private Key (PEM) - natsConnectionName String — NATS connection name - natsRequestTimeout SignedInteger — Request timeout, ms - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - publishStat Boolean — Publish driver statistics in the log - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Ignition Module Device",
    "Description": "",
    "DriverID": "C7B2183F-2BB8-415E-83A3-AA3FF8A20BF5",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "writeRequestItemsCount",
        "Value": "50"
      },
      {
        "Key": "networkPort",
        "Value": "4778"
      },
      {
        "Key": "interface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "enableTLS",
        "Value": "1"
      },
      {
        "Key": "browseRequestItemsCount",
        "Value": "500"
      },
      {
        "Key": "publishStat",
        "Value": "false"
      },
      {
        "Key": "user",
        "Value": "admin"
      },
      {
        "Key": "password",
        "Value": "password"
      },
      {
        "Key": "TLScert",
        "Value": "placeholder_tlscert"
      },
      {
        "Key": "TLSpkey",
        "Value": "placeholder_tlspkey"
      },
      {
        "Key": "natsConnectionName",
        "Value": "IgnitionAgent"
      },
      {
        "Key": "natsRequestTimeout",
        "Value": "5000"
      },
      {
        "Key": "name",
        "Value": "Ignition-module_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Ignition Module Device",
            "DriverID": "C7B2183F-2BB8-415E-83A3-AA3FF8A20BF5",
            "Description": ""
        }
    }
}

Create Device - Ignition Module (No TLS)

POST {{edgeUrl}}/devicehub/v2

Ignition Module

Driver ID: C7B2183F-2BB8-415E-83A3-AA3FF8A20BF5 Group: Ignition

Required properties: - writeRequestItemsCount SignedInteger — Write request max items count - networkPort SignedInteger — Port - interface String — Interface - enableTLS SignedInteger — Enable TLS Authentication Options: 0, 1 - browseRequestItemsCount SignedInteger — Browse request max items count - user String — User - password String — Password - TLScert String — Certificate (PEM) - TLSpkey String — Private Key (PEM) - natsConnectionName String — NATS connection name - natsRequestTimeout SignedInteger — Request timeout, ms - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - publishStat Boolean — Publish driver statistics in the log - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Ignition Module Device (No TLS)",
    "Description": "",
    "DriverID": "C7B2183F-2BB8-415E-83A3-AA3FF8A20BF5",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "writeRequestItemsCount",
        "Value": "50"
      },
      {
        "Key": "networkPort",
        "Value": "4778"
      },
      {
        "Key": "interface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "enableTLS",
        "Value": "1"
      },
      {
        "Key": "browseRequestItemsCount",
        "Value": "500"
      },
      {
        "Key": "publishStat",
        "Value": "false"
      },
      {
        "Key": "user",
        "Value": "admin"
      },
      {
        "Key": "password",
        "Value": "password"
      },
      {
        "Key": "natsConnectionName",
        "Value": "IgnitionAgent"
      },
      {
        "Key": "natsRequestTimeout",
        "Value": "5000"
      },
      {
        "Key": "name",
        "Value": "Ignition-module_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Ignition Module Device (No TLS)",
            "DriverID": "C7B2183F-2BB8-415E-83A3-AA3FF8A20BF5",
            "Description": ""
        }
    }
}

Create Device - IND256x

POST {{edgeUrl}}/devicehub/v2

IND256x Driver

Driver ID: 897D81B8-CB6F-4144-A985-1588A021A645 Group: Mettler Toledo

Required properties: - networkPort SignedInteger — Port - connectionPayload String — Connection Request (Hex String) - networkAddress String — IP Address - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - Transport SignedInteger — Transport Type Options: 0, 1, 2 - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - connectionRequest SignedInteger — If enabled this field is used to enter the command that initiates the connection with the device Options: 0, 1 - protocolByteOrder SignedInteger — Protocol Endianness Options: 0, 1, 2, 3 - MultipleConnections SignedInteger — Enable if using multiple streams Options: 0, 1 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - ReadTimeout SignedInteger — Request timeout, msec - RetryCount SignedInteger — Retry request count - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - responseIndex SignedInteger — Response Parsing - Start Index - dataByteOrder SignedInteger — Default Data Endianness Options: 0, 1, 2, 3 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - sessionParams Text — Session Parameters (JSON) - PauseBetweenRetries SignedInteger — Pause between retries, msec - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My IND256x Device",
    "Description": "",
    "DriverID": "897D81B8-CB6F-4144-A985-1588A021A645",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "Transport",
        "Value": "0"
      },
      {
        "Key": "networkPort",
        "Value": "1234"
      },
      {
        "Key": "baudRate",
        "Value": "3"
      },
      {
        "Key": "connectionRequest",
        "Value": "1"
      },
      {
        "Key": "connectionPayload",
        "Value": "placeholder_connectionpayload"
      },
      {
        "Key": "protocolByteOrder",
        "Value": "0"
      },
      {
        "Key": "MultipleConnections",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "1"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "responseIndex",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "dataByteOrder",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "3"
      },
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "sessionParams",
        "Value": ""
      },
      {
        "Key": "PauseBetweenRetries",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "ind256x_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My IND256x Device",
            "DriverID": "897D81B8-CB6F-4144-A985-1588A021A645",
            "Description": ""
        }
    }
}

Create Device - Industrial OT Server

POST {{edgeUrl}}/devicehub/v2

Industrial OT Server Driver

Driver ID: A206D802-2E0B-4C14-A38A-353F666FCF0C Group: MQTT

Required properties: - User String — User - Password String — Password - MqttSSLPort SignedInteger — MQTT SSL Port - CertificateAuthority String — CA Chain (PEM) - MqttPort SignedInteger — MQTT Port - MqttInterface String — MQTT Interface - MqttSSLInterface String — MQTT SSL Interface - ServerCertificate String — Broker Certificate (PEM) - ServerPrivateKey String — Broker Private Key (PEM) - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - MinTLSVersion SignedInteger — Minimum TLS Version Options: 0, 1, 2, 3 - EnableMqtt SignedInteger — Enable MQTT at Port Options: 0, 1 - EnableMqttSSL SignedInteger — Enable MQTT SSL at Port Options: 0, 1 - RequireClientCertificate SignedInteger — Require Client CA Options: 0, 1 - EnableUserPassword SignedInteger — Enable Authentification (User/Password) Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Industrial OT Server Device",
    "Description": "",
    "DriverID": "A206D802-2E0B-4C14-A38A-353F666FCF0C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "User",
        "Value": "admin"
      },
      {
        "Key": "Password",
        "Value": "password"
      },
      {
        "Key": "MqttSSLPort",
        "Value": "8883"
      },
      {
        "Key": "CertificateAuthority",
        "Value": "<certificate>"
      },
      {
        "Key": "MinTLSVersion",
        "Value": "2"
      },
      {
        "Key": "EnableMqtt",
        "Value": "0"
      },
      {
        "Key": "MqttPort",
        "Value": "1883"
      },
      {
        "Key": "MqttInterface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "EnableMqttSSL",
        "Value": "1"
      },
      {
        "Key": "MqttSSLInterface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "ServerCertificate",
        "Value": "<certificate>"
      },
      {
        "Key": "ServerPrivateKey",
        "Value": "<certificate>"
      },
      {
        "Key": "RequireClientCertificate",
        "Value": "1"
      },
      {
        "Key": "EnableUserPassword",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "Industrial-OT-server_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Industrial OT Server Device",
            "DriverID": "A206D802-2E0B-4C14-A38A-353F666FCF0C",
            "Description": ""
        }
    }
}

Create Device - Industrial OT Server (No TLS)

POST {{edgeUrl}}/devicehub/v2

Industrial OT Server Driver

Driver ID: A206D802-2E0B-4C14-A38A-353F666FCF0C Group: MQTT

Required properties: - User String — User - Password String — Password - MqttSSLPort SignedInteger — MQTT SSL Port - CertificateAuthority String — CA Chain (PEM) - MqttPort SignedInteger — MQTT Port - MqttInterface String — MQTT Interface - MqttSSLInterface String — MQTT SSL Interface - ServerCertificate String — Broker Certificate (PEM) - ServerPrivateKey String — Broker Private Key (PEM) - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - MinTLSVersion SignedInteger — Minimum TLS Version Options: 0, 1, 2, 3 - EnableMqtt SignedInteger — Enable MQTT at Port Options: 0, 1 - EnableMqttSSL SignedInteger — Enable MQTT SSL at Port Options: 0, 1 - RequireClientCertificate SignedInteger — Require Client CA Options: 0, 1 - EnableUserPassword SignedInteger — Enable Authentification (User/Password) Options: 0, 1 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Industrial OT Server Device (No TLS)",
    "Description": "",
    "DriverID": "A206D802-2E0B-4C14-A38A-353F666FCF0C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "EnableMqtt",
        "Value": "0"
      },
      {
        "Key": "MqttPort",
        "Value": "1883"
      },
      {
        "Key": "MqttInterface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "EnableMqttSSL",
        "Value": "0"
      },
      {
        "Key": "EnableUserPassword",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "Industrial-OT-server_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Industrial OT Server Device (No TLS)",
            "DriverID": "A206D802-2E0B-4C14-A38A-353F666FCF0C",
            "Description": ""
        }
    }
}

Create Device - JTEKT Toyopuc CMP-Link Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

JTEKT Toyopuc CMP-Link Ethernet (Gen1.3)

Driver ID: 5C8E41C3-6DF1-47B5-AD2E-9C5FD0FF803C Group: Toyopuc

Required properties: - name String — Device Name that describes your asset. - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My JTEKT Toyopuc CMP-Link Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "5C8E41C3-6DF1-47B5-AD2E-9C5FD0FF803C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "toyopuc device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My JTEKT Toyopuc CMP-Link Ethernet (Gen1.3) Device",
            "DriverID": "5C8E41C3-6DF1-47B5-AD2E-9C5FD0FF803C",
            "Description": ""
        }
    }
}

Create Device - Keyence KV10 Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Keyence KV10 Serial (Gen1.3)

Driver ID: 29530297-998F-4E0A-9137-ABEDA478AF2D Group: Keyence

Required properties: - deviceFile String — Local Serial connection file path. - stopBits SignedInteger — Serial communication stopbits parameter. - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Keyence KV10 Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "29530297-998F-4E0A-9137-ABEDA478AF2D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "keyence"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Keyence KV10 Serial (Gen1.3) Device",
            "DriverID": "29530297-998F-4E0A-9137-ABEDA478AF2D",
            "Description": ""
        }
    }
}

Create Device - Keyence Nano

POST {{edgeUrl}}/devicehub/v2

Keyence Nano Driver

Driver ID: CC3EDEED-0DBD-47B5-A057-7CD2F04668EA Group: Keyence

Required properties: - networkPort SignedInteger — Port - networkAddress String — IP Address - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - ReadTimeout SignedInteger — Request timeout, msec - RetryCount SignedInteger — Retry request count - PauseBetweenRetries SignedInteger — Pause between retries, msec - Transport SignedInteger — Transport Type Options: 0 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Keyence Nano Device",
    "Description": "",
    "DriverID": "CC3EDEED-0DBD-47B5-A057-7CD2F04668EA",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "8501"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "PauseBetweenRetries",
        "Value": "0"
      },
      {
        "Key": "Transport",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "keyence-nano_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Keyence Nano Device",
            "DriverID": "CC3EDEED-0DBD-47B5-A057-7CD2F04668EA",
            "Description": ""
        }
    }
}

Create Device - Keyence Nano Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Keyence Nano Ethernet (Gen1.3)

Driver ID: F43FC385-C0CC-4E0D-AABF-C1686F3AA6E3 Group: Keyence

Required properties: - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device. - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Keyence Nano Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "F43FC385-C0CC-4E0D-AABF-C1686F3AA6E3",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "keyence"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Keyence Nano Ethernet (Gen1.3) Device",
            "DriverID": "F43FC385-C0CC-4E0D-AABF-C1686F3AA6E3",
            "Description": ""
        }
    }
}

Create Device - Keyence Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Keyence Serial (Gen1.3)

Driver ID: E2875F18-40FA-408A-8CE2-F40E022E3DED Group: Keyence

Required properties: - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Keyence Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "E2875F18-40FA-408A-8CE2-F40E022E3DED",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "keyence"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Keyence Serial (Gen1.3) Device",
            "DriverID": "E2875F18-40FA-408A-8CE2-F40E022E3DED",
            "Description": ""
        }
    }
}

Create Device - Koyo Click Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Koyo Click Serial (Gen1.3)

Driver ID: 27522C78-CBE8-4BF0-BD26-43DAD7E02F0C Group: Koyo

Required properties: - stationId SignedInteger — Station id/slot number - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - deviceFile String — Local Serial connection file path. - stopBits SignedInteger — Serial communication stopbits parameter. - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Koyo Click Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "27522C78-CBE8-4BF0-BD26-43DAD7E02F0C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "Koyo Device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Koyo Click Serial (Gen1.3) Device",
            "DriverID": "27522C78-CBE8-4BF0-BD26-43DAD7E02F0C",
            "Description": ""
        }
    }
}

Create Device - Koyo Direct Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Koyo Direct Serial

Driver ID: DEABEBA3-7E58-4774-A475-39F81ECF486B Group: Koyo

Required properties: - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - name String — Device Name that describes your asset. - stationId SignedInteger — Station id/slot number - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Koyo Direct Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "DEABEBA3-7E58-4774-A475-39F81ECF486B",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "Koyo Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Koyo Direct Serial (Gen1.3) Device",
            "DriverID": "DEABEBA3-7E58-4774-A475-39F81ECF486B",
            "Description": ""
        }
    }
}

Create Device - Koyo Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Koyo Ethernet (Gen 1.3)

Driver ID: 1A483B03-463F-4218-B464-F796343C6D5F Group: Koyo

Required properties: - networkPort SignedInteger — Network port of the device. - networkAddress String — IP Address of the device. - name String — Device Name that describes your asset.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Koyo Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "1A483B03-463F-4218-B464-F796343C6D5F",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "koyo device"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Koyo Ethernet (Gen1.3) Device",
            "DriverID": "1A483B03-463F-4218-B464-F796343C6D5F",
            "Description": ""
        }
    }
}

Create Device - LioN-X

POST {{edgeUrl}}/devicehub/v2

LioN-X OPC UA Client Driver

The driver implements the Client according to OPC UA Specification version 1.04 (IEC62541 standard).

Features:

• Discovering Servers and Endpoint (make sure the DNS name of the discovered server can be resolved by LE or replace it with the IP address)
• Browsing the address space of the server
• Reading, subscribing, and writing "Value" (Attribute ID 13, The value of a variable)

Driver ID: D5E201DC-35DE-44AD-B9DB-EB6AD70432C0 Group: Lumberg Automation

Required properties: - AuthMode String — Auth Mode Options: 0, 1, 2 - DefaultRoot String — Start node to browse the server - DriverMode String — Driver Mode Options: 0, 1 - OverrideRegistersSamplingInterval String — Override registers sampling interval Options: 0, 1 - SecurityMode String — Security Mode Options: 0, 1, 2 - SecurityPolicy String — Security Policy Options: 0, 1, 2, 3, 4, 5 - ServerURL String — Server URL - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - DisableApplicationUriCheck String — Flag used to disable the certificate ApplicationUri match check. Options: 0, 1 - DisableEncryptedPasswordCheck String — Flag used to disable the check if the password of a UserPassword identity token is encrypted properly. Options: 0, 1 - DisableErrorCertificateChainIncomplete String — Flag used to disable the certificate validation error BadCertificateChainIncomplete. Options: 0, 1 - DisableErrorCertificateHostNameInvalid String — Flag used to disable the check if the hostname the client connected to matches one of the hostnames or IP addresses in the server certificate. Options: 0, 1 - DisableErrorCertificateRevocationUnknown String — Flag used to disable the client certificate validation error BadCertificateRevocationUnknown. Options: 0, 1 - DisableErrorCertificateTimeInvalid String — Flag used to disable the certificate validation error CertificateTimeInvalid. Options: 0, 1 - DisableErrorCertificateUntrusted String — Flag used to disable the certificate validation error BadCertificateUntrusted. Options: 0, 1 - LifetimeCount SignedInteger — The subscription lifetime count (SubscriptionLifetime = LifetimeCount * PublishingInterval) - MaxKeepAliveCount SignedInteger — If the server has no notifications pending for the period of time defined by * (MaxKeepAliveCount * PublishingInterval), the server will send a keep alive message to the client - MaxNotificationsPerPublish SignedInteger — The maximum number of notifications that the client wishes to receive in a single publish response - Password String — Password - Priority SignedInteger — The relative priority of this subscription within the session - PublishingInterval SignedInteger — The cyclic rate in milliseconds at which the subscription is being requested to return notifications to the client - RegistersSamplingInterval Float — The interval in milliseconds that defines the fastest rate at which the MonitoredItem(s) should be accessed and evaluated (0 - fastest practical rate). - SessionCertificate String — Session Certificate - SessionPrivateKey String — Session Private Key - UserCertificate String — User Auth Certificate (PEM format) - UserName String — User Name - UserPrivateKey String — User Auth Private Key (PEM format) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My LioN-X Device",
    "Description": "",
    "DriverID": "D5E201DC-35DE-44AD-B9DB-EB6AD70432C0",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "AuthMode",
        "Value": "0"
      },
      {
        "Key": "DefaultRoot",
        "Value": "ns=0;i=84"
      },
      {
        "Key": "DisableApplicationUriCheck",
        "Value": "0"
      },
      {
        "Key": "DisableEncryptedPasswordCheck",
        "Value": "0"
      },
      {
        "Key": "DisableErrorCertificateChainIncomplete",
        "Value": "0"
      },
      {
        "Key": "DisableErrorCertificateHostNameInvalid",
        "Value": "0"
      },
      {
        "Key": "DisableErrorCertificateRevocationUnknown",
        "Value": "0"
      },
      {
        "Key": "DisableErrorCertificateTimeInvalid",
        "Value": "0"
      },
      {
        "Key": "DisableErrorCertificateUntrusted",
        "Value": "0"
      },
      {
        "Key": "DriverMode",
        "Value": "0"
      },
      {
        "Key": "LifetimeCount",
        "Value": "2400"
      },
      {
        "Key": "MaxKeepAliveCount",
        "Value": "10"
      },
      {
        "Key": "MaxNotificationsPerPublish",
        "Value": "0"
      },
      {
        "Key": "OverrideRegistersSamplingInterval",
        "Value": "1"
      },
      {
        "Key": "Password",
        "Value": ""
      },
      {
        "Key": "Priority",
        "Value": "0"
      },
      {
        "Key": "PublishingInterval",
        "Value": "500"
      },
      {
        "Key": "RegistersSamplingInterval",
        "Value": "0"
      },
      {
        "Key": "SecurityMode",
        "Value": "0"
      },
      {
        "Key": "SecurityPolicy",
        "Value": "0"
      },
      {
        "Key": "ServerURL",
        "Value": "192.168.1.100"
      },
      {
        "Key": "SessionCertificate",
        "Value": "<certificate>"
      },
      {
        "Key": "SessionPrivateKey",
        "Value": "<certificate>"
      },
      {
        "Key": "UserCertificate",
        "Value": ""
      },
      {
        "Key": "UserName",
        "Value": ""
      },
      {
        "Key": "UserPrivateKey",
        "Value": ""
      },
      {
        "Key": "name",
        "Value": "LioN-X_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My LioN-X Device",
            "DriverID": "D5E201DC-35DE-44AD-B9DB-EB6AD70432C0",
            "Description": ""
        }
    }
}

Create Device - LS Master-K CPU Direct Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

LS Master-K CPU Direct Serial (Gen1.3)

Driver ID: CAC8E388-0230-4EA3-99D0-9B4FE42F9328 Group: LS Industrial System

Required properties: - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - name String — Device Name that describes your asset. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My LS Master-K CPU Direct Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "CAC8E388-0230-4EA3-99D0-9B4FE42F9328",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "name",
        "Value": "LS Master Device"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My LS Master-K CPU Direct Serial (Gen1.3) Device",
            "DriverID": "CAC8E388-0230-4EA3-99D0-9B4FE42F9328",
            "Description": ""
        }
    }
}

Create Device - LS XBM Cnet Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

LS XBM Cnet Serial (Gen1.3)

Driver ID: 9F2C6E7B-363A-4933-8B14-3FDBE3348276 Group: LS Industrial System

Required properties: - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - stationId SignedInteger — Station Id/ Slot number - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My LS XBM Cnet Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "9F2C6E7B-363A-4933-8B14-3FDBE3348276",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "LS Master Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My LS XBM Cnet Serial (Gen1.3) Device",
            "DriverID": "9F2C6E7B-363A-4933-8B14-3FDBE3348276",
            "Description": ""
        }
    }
}

Create Device - LS XBM Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

LS XBM Serial (Gen1.3)

Driver ID: 111BCF84-25D5-4C53-9588-D22CFF50F6C5 Group: LS Industrial System

Required properties: - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - deviceFile String — Local Serial connection file path. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My LS XBM Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "111BCF84-25D5-4C53-9588-D22CFF50F6C5",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "LS Master Device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My LS XBM Serial (Gen1.3) Device",
            "DriverID": "111BCF84-25D5-4C53-9588-D22CFF50F6C5",
            "Description": ""
        }
    }
}

Create Device - Microsoft SQL Server Client

POST {{edgeUrl}}/devicehub/v2

Microsoft SQL Client Driver

CDC (Change Data Capture)

• In order to detect data changes for Table queries, CDC must be enabled on the DB and configured within the Tag settings

• CDC queries will likely require "ValidateQuery" to be disabled, in order to use T-SQL specific syntax

• Init Query: one-shot query to initialize a "state", which will be compared before polling

• (e.g. SELECT sys.fn_cdc_get_max_lsn() AS __$start_lsn)
• determine which column in the last row of output represents the state, and configure "ParseState" accordingly

• if the DB permits, the state may be stored as session/global variable on the server

  • in this case, state parsing is not required

• Change Query: compare previous "state", and if changes detected, re-issue "Data Query"

• (e.g. SELECT * FROM cdc.dbo_tablexyz_CT WHERE __$start_lsn > @lastState)
• "@lastState" is a special string reserved for injecting the previous state value
• state parsing (either by column idx or column name) must be the same as "Init Query"

• any result from "Change Query" will indicate that changes have occurred

• Data Query: regardless of CDC, this should retrieve the entire data set of interest

• (e.g. SELECT * FROM tablexyz)
• on initial poll, the "Data Query" is executed regardless of the results of "Change Query"
• after initial publish, subsequent payloads will include an additional "Changes" field
  • this will include the results of the "Change Query"

Driver ID: EAE46646-63D5-4C94-970B-A046B4D6DE85 Group: Historian

Required properties: - Address String — SQL Server Address - Port SignedInteger — SQL Server Port - Username String - Password String - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - ReadOnlyMode SignedInteger — ReadOnly Protections Options: 0, 1 - AppName String — Client Application ID - MinTLSVersion SignedInteger — Minimum TLS Version Options: 0, 1, 2, 3 - RequestTimeout SignedInteger — Request Timeout (S) - KeepAlive SignedInteger — TCP Keep-Alive (S) (0 to disable) - PacketSize SignedInteger — Maximum Packet Size - HostName String — Client Workstation ID - ServerCertificate String — CA Chain (PEM) - Instance String — Server Instance Path - Database String — Server Database Name - Encryption SignedInteger — Encryption Mode Options: 0, 1, 2, 3 - ValidateQuery SignedInteger — Parse Queries and Validate Syntax (MySQL Syntax Only) Options: 0, 1 - ConnectionTimeout SignedInteger — Connection Timeout (S) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Microsoft SQL Server Client Device",
    "Description": "",
    "DriverID": "EAE46646-63D5-4C94-970B-A046B4D6DE85",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "Address",
        "Value": "192.168.1.100"
      },
      {
        "Key": "ReadOnlyMode",
        "Value": "0"
      },
      {
        "Key": "AppName",
        "Value": "devicehub"
      },
      {
        "Key": "MinTLSVersion",
        "Value": "0"
      },
      {
        "Key": "RequestTimeout",
        "Value": "10"
      },
      {
        "Key": "KeepAlive",
        "Value": "30"
      },
      {
        "Key": "PacketSize",
        "Value": "4096"
      },
      {
        "Key": "Port",
        "Value": "502"
      },
      {
        "Key": "Username",
        "Value": "admin"
      },
      {
        "Key": "Password",
        "Value": "password"
      },
      {
        "Key": "HostName",
        "Value": ""
      },
      {
        "Key": "ServerCertificate",
        "Value": ""
      },
      {
        "Key": "Instance",
        "Value": ""
      },
      {
        "Key": "Database",
        "Value": "master"
      },
      {
        "Key": "Encryption",
        "Value": "0"
      },
      {
        "Key": "ValidateQuery",
        "Value": "0"
      },
      {
        "Key": "ConnectionTimeout",
        "Value": "5"
      },
      {
        "Key": "name",
        "Value": "mssql-client_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Microsoft SQL Server Client Device",
            "DriverID": "EAE46646-63D5-4C94-970B-A046B4D6DE85",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi A Series Serial

POST {{edgeUrl}}/devicehub/v2

Mitsubishi A Series Serial Driver

Driver ID: EDB59BDF-3459-48C2-9E8E-6F5CAAA3E343 Group: Mitsubishi

Required properties: - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - PlcType SignedInteger — PLC Type Options: 0, 1, 2 - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - ReadTimeout SignedInteger — Serial Read Timeout (ms) - RetryCount SignedInteger — Read Retries (0 for no retry) - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - WriteDelay SignedInteger — Wait time before resetting RTS during serial write (ms) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi A Series Serial Device",
    "Description": "",
    "DriverID": "EDB59BDF-3459-48C2-9E8E-6F5CAAA3E343",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "PlcType",
        "Value": "0"
      },
      {
        "Key": "ReadTimeout",
        "Value": "200"
      },
      {
        "Key": "RetryCount",
        "Value": "2"
      },
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "0"
      },
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "WriteDelay",
        "Value": "3"
      },
      {
        "Key": "name",
        "Value": "mitsubishi-a-ser_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi A Series Serial Device",
            "DriverID": "EDB59BDF-3459-48C2-9E8E-6F5CAAA3E343",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi FX2N serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi FX2N serial (Gen1.3)

Driver ID: 1AED6791-3AE4-4642-BF16-47AE5C71EEC6 Group: Mitsubishi

Required properties: - deviceFile String — Local Serial connection file path. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi FX2N serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "1AED6791-3AE4-4642-BF16-47AE5C71EEC6",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "dataBits",
        "Value": "7"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "parity",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi FX2N serial (Gen1.3) Device",
            "DriverID": "1AED6791-3AE4-4642-BF16-47AE5C71EEC6",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi FX2N-10GM/20GM Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi FX2N-10GM/20GM Serial (Gen1.3)

Driver ID: 547F2D33-0081-424A-978D-0CE3C6676410 Group: Mitsubishi

Required properties: - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - deviceFile String — Local Serial connection file path. - dataBits SignedInteger — Serial communication databits parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi FX2N-10GM/20GM Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "547F2D33-0081-424A-978D-0CE3C6676410",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi FX2N-10GM/20GM Serial (Gen1.3) Device",
            "DriverID": "547F2D33-0081-424A-978D-0CE3C6676410",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi FX3G ASCII Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi FX3G ASCII Ethernet (Gen1.3)

Driver ID: 0D25A6F3-55DE-41CF-89CE-7BBA69A5A34D Group: Mitsubishi

Required properties: - name String — Device Name that describes your asset. - networkAddress String — IP Address of the device. - networkPort SignedInteger — Network port of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi FX3G ASCII Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "0D25A6F3-55DE-41CF-89CE-7BBA69A5A34D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "mitsubish device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi FX3G ASCII Ethernet (Gen1.3) Device",
            "DriverID": "0D25A6F3-55DE-41CF-89CE-7BBA69A5A34D",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi FX3G Binary Ethernet (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi FX3G Binary Ethernet (Gen1.3)

Driver ID: 793F3159-4523-4DCB-80A2-24B0F9432D0C Group: Mitsubishi

Required properties: - name String — Device Name that describes your asset. - networkAddress String — IP Address of the device. - networkPort SignedInteger — Network port of the device.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi FX3G Binary Ethernet (Gen1.3) Device",
    "Description": "",
    "DriverID": "793F3159-4523-4DCB-80A2-24B0F9432D0C",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi FX3G Binary Ethernet (Gen1.3) Device",
            "DriverID": "793F3159-4523-4DCB-80A2-24B0F9432D0C",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi FX3U Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi FX3U Serial (Gen1.3)

Driver ID: AB084A0D-92A7-47C7-B4BC-825863223ABD Group: Mitsubishi

Required properties: - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi FX3U Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "AB084A0D-92A7-47C7-B4BC-825863223ABD",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "7"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "parity",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi FX3U Serial (Gen1.3) Device",
            "DriverID": "AB084A0D-92A7-47C7-B4BC-825863223ABD",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi FX5U Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi FX5U Serial (Gen1.3)

Driver ID: 7DA81F7B-CAF9-4E23-BE23-4D8B78B94E5F Group: Mitsubishi

Required properties: - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - stationId SignedInteger — Station no of device. - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi FX5U Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "7DA81F7B-CAF9-4E23-BE23-4D8B78B94E5F",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "stationId",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi FX5U Serial (Gen1.3) Device",
            "DriverID": "7DA81F7B-CAF9-4E23-BE23-4D8B78B94E5F",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi iQ-F Ethernet

POST {{edgeUrl}}/devicehub/v2

Mitsubishi iQ-F Ethernet Driver

Driver ID: A6BBE2F9-39D1-49D0-A05A-947B5D837911 Group: Mitsubishi

Required properties: - networkPort SignedInteger — PLC Port - stationId SignedInteger — Station No. of PLC - networkId SignedInteger — Network No. of PLC - networkAddress String — PLC IP - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - maxPDUSize SignedInteger — Maximum block size of PLC memory per request (# bytes) - RetryCount SignedInteger — Read Retries (0 for no retry) - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - encoding SignedInteger — Encoding Format Options: 0, 1 - ReadTimeout SignedInteger — Read Timeout (ms) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi iQ-F Ethernet Device",
    "Description": "",
    "DriverID": "A6BBE2F9-39D1-49D0-A05A-947B5D837911",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "maxPDUSize",
        "Value": "1920"
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "stationId",
        "Value": "255"
      },
      {
        "Key": "encoding",
        "Value": "0"
      },
      {
        "Key": "networkId",
        "Value": "0"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "mitsubishi-iqf-eth_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi iQ-F Ethernet Device",
            "DriverID": "A6BBE2F9-39D1-49D0-A05A-947B5D837911",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi iQ-R Ethernet

POST {{edgeUrl}}/devicehub/v2

Mitsubishi iQ-R Ethernet Driver

Driver ID: 8A7DDEFC-94E5-46D2-BE41-68318B641856 Group: Mitsubishi

Required properties: - networkPort SignedInteger — PLC Port - stationId SignedInteger — Station No. of PLC - networkId SignedInteger — Network No. of PLC - networkAddress String — PLC IP - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - RetryCount SignedInteger — Read Retries (0 for no retry) - encoding SignedInteger — Encoding Format Options: 0, 1 - maxPDUSize SignedInteger — Maximum block size of PLC memory per request (# bytes) - ReadTimeout SignedInteger — Read Timeout (ms) - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi iQ-R Ethernet Device",
    "Description": "",
    "DriverID": "8A7DDEFC-94E5-46D2-BE41-68318B641856",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "encoding",
        "Value": "0"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "maxPDUSize",
        "Value": "1920"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "stationId",
        "Value": "255"
      },
      {
        "Key": "networkId",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "name",
        "Value": "mitsubishi-iqr-eth_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi iQ-R Ethernet Device",
            "DriverID": "8A7DDEFC-94E5-46D2-BE41-68318B641856",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi Q/L Ethernet

POST {{edgeUrl}}/devicehub/v2

Mitsubishi Q/L Ethernet Driver

Driver ID: 341C7310-967F-4BAC-9C80-2C93BB9B068B Group: Mitsubishi

Required properties: - networkPort SignedInteger — PLC Port - networkId SignedInteger — Network No. of PLC - networkAddress String — PLC IP - stationId SignedInteger — Station No. of PLC - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - encoding SignedInteger — Encoding Format Options: 0, 1 - ReadTimeout SignedInteger — Read Timeout (ms) - RetryCount SignedInteger — Read Retries (0 for no retry) - KeepAlive SignedInteger — TCP Keep-Alive (s) (0 to disable) - maxPDUSize SignedInteger — Maximum block size of PLC memory per request (# bytes) - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi Q/L Ethernet Device",
    "Description": "",
    "DriverID": "341C7310-967F-4BAC-9C80-2C93BB9B068B",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "encoding",
        "Value": "0"
      },
      {
        "Key": "ReadTimeout",
        "Value": "2000"
      },
      {
        "Key": "RetryCount",
        "Value": "0"
      },
      {
        "Key": "KeepAlive",
        "Value": "60"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "maxPDUSize",
        "Value": "1920"
      },
      {
        "Key": "networkId",
        "Value": "0"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "stationId",
        "Value": "255"
      },
      {
        "Key": "name",
        "Value": "mitsubishi-ql-eth_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi Q/L Ethernet Device",
            "DriverID": "341C7310-967F-4BAC-9C80-2C93BB9B068B",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi Q06 Serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi Q06 Serial (Gen1.3)

Driver ID: 66042B77-7B8F-486C-B8A6-E045A94D8D49 Group: Mitsubishi

Required properties: - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi Q06 Serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "66042B77-7B8F-486C-B8A6-E045A94D8D49",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "parity",
        "Value": "0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi Q06 Serial (Gen1.3) Device",
            "DriverID": "66042B77-7B8F-486C-B8A6-E045A94D8D49",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi QJ71E71

POST {{edgeUrl}}/devicehub/v2

Mitsubishi QJ71E71 Ethernet Driver

Driver ID: C35CD544-F1D7-4911-B38A-AD21AABE9744 Group: Mitsubishi

Required properties: - stationId SignedInteger — Station No. of device - networkAddress String — IP Address of device - networkPort SignedInteger — TCP/IP port of device - networkId SignedInteger — Network No. of device - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi QJ71E71 Device",
    "Description": "",
    "DriverID": "C35CD544-F1D7-4911-B38A-AD21AABE9744",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "stationId",
        "Value": "1"
      },
      {
        "Key": "networkAddress",
        "Value": "192.168.1.100"
      },
      {
        "Key": "networkPort",
        "Value": "502"
      },
      {
        "Key": "networkId",
        "Value": "1"
      },
      {
        "Key": "name",
        "Value": "mitsubishi-qj71e71_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi QJ71E71 Device",
            "DriverID": "C35CD544-F1D7-4911-B38A-AD21AABE9744",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi_Q00_01H_serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi_Q00_01H_serial (Gen1.3)

Driver ID: 5E339CD5-2C29-4E7E-AF1A-6A022B97211D Group: Mitsubishi

Required properties: - name String — Device Name that describes your asset. - deviceFile String — Local Serial connection file path. - baudRate SignedInteger — Serial communication baudrate parameter. - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi_Q00_01H_serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "5E339CD5-2C29-4E7E-AF1A-6A022B97211D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi_Q00_01H_serial (Gen1.3) Device",
            "DriverID": "5E339CD5-2C29-4E7E-AF1A-6A022B97211D",
            "Description": ""
        }
    }
}

Create Device - Mitsubishi_Q02_02H_serial (Gen1.3)

POST {{edgeUrl}}/devicehub/v2

Mitsubishi_Q02_02H_serial (Gen1.3)

Driver ID: EAA09420-76AB-41E9-B8D4-00778BE65B8D Group: Mitsubishi

Required properties: - parity SignedInteger — Serial communication parity parameter. Options: 0, 1, 2 - name String — Device Name that describes your asset. - baudRate SignedInteger — Serial communication baudrate parameter. - dataBits SignedInteger — Serial communication databits parameter. - stopBits SignedInteger — Serial communication stopbits parameter. - deviceFile String — Local Serial connection file path.

Optional properties: - description String — Description of the device or an asset.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Mitsubishi_Q02_02H_serial (Gen1.3) Device",
    "Description": "",
    "DriverID": "EAA09420-76AB-41E9-B8D4-00778BE65B8D",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "mitsubishi device"
      },
      {
        "Key": "baudRate",
        "Value": "9600"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "description",
        "Value": ""
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyS0"
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Mitsubishi_Q02_02H_serial (Gen1.3) Device",
            "DriverID": "EAA09420-76AB-41E9-B8D4-00778BE65B8D",
            "Description": ""
        }
    }
}

Create Device - Modbus ASCII

POST {{edgeUrl}}/devicehub/v2

Modbus ASCII

Driver ID: 7E0EB9A6-D638-11E9-BB65-2A2AE2DBCCE4 Group: Modbus

Required properties: - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - stationId SignedInteger — This is a station no of device. - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - Zero-Based Addressing SignedInteger Options: 0, 1 - discreteGap SignedInteger — If this setting is > 0 for performance optimization it spans over address gaps when grouping tags - requestTimeoutMs SignedInteger — Response Timeout (ms) - maxDiscrete SignedInteger — Maximum number of Coil and Contact Registers allowed in a single request. Must be greater than Coil and Contact Allowable Gap Size - maxAnalog SignedInteger — Maximum number of Input and Holding Registers allowed in a single request. Must be greater than Input and Holding Allowable Gap Size. - analogGap SignedInteger — If this setting is > 0 for performance optimization it spans over address gaps when grouping tags - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Modbus ASCII Device",
    "Description": "",
    "DriverID": "7E0EB9A6-D638-11E9-BB65-2A2AE2DBCCE4",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "Zero-Based Addressing",
        "Value": "0"
      },
      {
        "Key": "discreteGap",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "stationId",
        "Value": "0"
      },
      {
        "Key": "requestTimeoutMs",
        "Value": "2000"
      },
      {
        "Key": "maxDiscrete",
        "Value": "2000"
      },
      {
        "Key": "maxAnalog",
        "Value": "125"
      },
      {
        "Key": "analogGap",
        "Value": "0"
      },
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "name",
        "Value": "modbus-ascii_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Modbus ASCII Device",
            "DriverID": "7E0EB9A6-D638-11E9-BB65-2A2AE2DBCCE4",
            "Description": ""
        }
    }
}

Create Device - Modbus ASCII Advanced

POST {{edgeUrl}}/devicehub/v2

Modbus ASCII Advanced

Use this driver instead of the Modbus ASCII driver when multiple stations are connected to the RS-485 bus. The Station ID setting can be customized at the tag level with this driver. The device connection status is defined by the last received response.

Driver ID: 5E0CFCEA-9AF0-4BE5-A8C2-C811A254D452 Group: Modbus

Required properties: - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - Zero-Based Addressing SignedInteger Options: 0, 1 - discreteGap SignedInteger — If this setting is > 0 for performance optimization it spans over address gaps when grouping tags - analogGap SignedInteger — If this setting is > 0 for performance optimization it spans over address gaps when grouping tags - Delay Between Polls SignedInteger — Delay between Poll requests (ms) - requestTimeoutMs SignedInteger — Response Timeout (ms) - maxDiscrete SignedInteger — Maximum number of Coil and Contact Registers allowed in a single request. Must be greater than Coil and Contact Allowable Gap Size - maxAnalog SignedInteger — Maximum number of Input and Holding Registers allowed in a single request. Must be greater than Input and Holding Allowable Gap Size. - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Modbus ASCII Advanced Device",
    "Description": "",
    "DriverID": "5E0CFCEA-9AF0-4BE5-A8C2-C811A254D452",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "8"
      },
      {
        "Key": "stopBits",
        "Value": "1"
      },
      {
        "Key": "Zero-Based Addressing",
        "Value": "0"
      },
      {
        "Key": "discreteGap",
        "Value": "0"
      },
      {
        "Key": "analogGap",
        "Value": "0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "Delay Between Polls",
        "Value": "0"
      },
      {
        "Key": "requestTimeoutMs",
        "Value": "2000"
      },
      {
        "Key": "maxDiscrete",
        "Value": "2000"
      },
      {
        "Key": "maxAnalog",
        "Value": "125"
      },
      {
        "Key": "name",
        "Value": "modbus-ascii-adv_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Modbus ASCII Advanced Device",
            "DriverID": "5E0CFCEA-9AF0-4BE5-A8C2-C811A254D452",
            "Description": ""
        }
    }
}

Create Device - Modbus Multi-Station RTU to TCP Converter

POST {{edgeUrl}}/devicehub/v2

Modbus Multi-Station RTU to TCP Converter

Use this driver to connect to Modbus RS-485 multi-station architectures in conjunction with multiple instances of the Modbus TCP driver. This driver will handle all serial communication with the RS-485 stations and expose them using a TCP server. You cannot add tags to this driver. Instead, all tags should be added to the Modbus TCP driver instances. This allows you to reuse tag names across different station IDs.

In the Modbus TCP driver instances, set the device parameters as follows:

Driver ID: 4F0F523B-293C-4704-8282-6C2073C76C10 Group: Modbus

Required properties: - port SignedInteger — Bind Port for TCP server - maxTCPConnections SignedInteger — Maximum number of simultaneous TCP connections - retryRequestCount SignedInteger — Maximum number of request retries - pauseBetweenRequests SignedInteger — Pause between requests (ms) - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - networkInterface String — Bind network interface for TCP server - responseTimeout SignedInteger — Response timeout (ms) - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.

Optional properties: - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. Options: 0, 1, 2 - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. Options: 0, 1, 2, 3 - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - description String — Optional free-text notes about this device, such as its physical location or purpose.

Request Body

GraphQL Query

mutation CreateDevice($input: CreateDeviceRequest!) {
  CreateDevice(input: $input) {
    ID
    Name
    DriverID
    Description
  }
}

Variables

{
  "input": {
    "Name": "My Modbus Multi-Station RTU to TCP Converter Device",
    "Description": "",
    "DriverID": "4F0F523B-293C-4704-8282-6C2073C76C10",
    "AliasTopics": false,
    "Debug": false,
    "MetaData": [],
    "StoppedState": false,
    "StatusRegister": null,
    "Properties": [
      {
        "Key": "stopBits",
        "Value": "0"
      },
      {
        "Key": "port",
        "Value": "502"
      },
      {
        "Key": "maxTCPConnections",
        "Value": "32"
      },
      {
        "Key": "retryRequestCount",
        "Value": "3"
      },
      {
        "Key": "pauseBetweenRequests",
        "Value": "10"
      },
      {
        "Key": "deviceFile",
        "Value": "/dev/ttyUSB0"
      },
      {
        "Key": "baudRate",
        "Value": "0"
      },
      {
        "Key": "dataBits",
        "Value": "0"
      },
      {
        "Key": "parity",
        "Value": "0"
      },
      {
        "Key": "networkInterface",
        "Value": "0.0.0.0"
      },
      {
        "Key": "responseTimeout",
        "Value": "5000"
      },
      {
        "Key": "name",
        "Value": "modbus-converter_device"
      },
      {
        "Key": "description",
        "Value": ""
      }
    ]
  }
}

Response

Status: 200 OK

{
    "data": {
        "CreateDevice": {
            "ID": "<generated-uuid>",
            "Name": "My Modbus Multi-Station RTU to TCP Converter Device",
            "DriverID": "4F0F523B-293C-4704-8282-6C2073C76C10",
            "Description": ""
        }
    }
}

Create Device - Modbus RTU

POST {{edgeUrl}}/devicehub/v2

Modbus RTU

Driver ID: 546457FA-D638-11E9-BB65-2A2AE2DBCCE4 Group: Modbus

Required properties: - baudRate SignedInteger — The data transmission speed, in bits per second, used for serial communication. Must match the baud rate configured on the device. Options: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 - dataBits SignedInteger — The number of data bits in each transmitted character (typically 7 or 8). Must match the device's serial configuration. - parity SignedInteger — The error-checking method used for serial communication (None, Even, or Odd). Must match the device's configured parity setting. Options: 0, 1, 2 - stopBits SignedInteger — The number of stop bits used to signal the end of a character (typically 1 or 2). Must match the device's serial configuration. - deviceFile String — The serial port path used to communicate with the device (/dev/ttyS1, /dev/ttyUSB0, …). Must match a port available on the gateway host. - stationId SignedInteger — This is a station no of device. - name String — A unique, user-defined name for this device. Used to identify the device throughout the edge gateway, including in message broker topics and logs.