OPC-UA Connector Configuration

• Section “server”
  • Subsection “identity”
• Section “mapping”
  • Subsection “attributes”
  • Subsection “timeseries”
  • Subsection “rpc_methods”
  • Subsection “attributes_updates”
• Next steps

This guide will help you to get familiar with OPC-UA connector configuration for ThingsBoard IoT Gateway. Use general configuration to enable this extension. We will describe connector configuration file below.

{
  "server": {
    "name": "OPC-UA Default Server",
    "url": "localhost:4840/freeopcua/server/",
    "timeoutInMillis": 5000,
    "scanPeriodInMillis": 5000,
    "disableSubscriptions":false,
    "subCheckPeriodInMillis": 100,
    "showMap": false,
    "security": "Basic128Rsa15",
    "identity": {
      "type": "anonymous"
    },
    "mapping": [
      {
        "deviceNodePattern": "Root\\.Objects\\.Device1",
        "deviceNamePattern": "Device ${Root\\.Objects\\.Device1\\.serialNumber}",
        "attributes": [
          {
            "key": "temperature °C",
            "path": "${ns=2;i=5}"
          }
        ],
        "timeseries": [
          {
            "key": "humidity",
            "path": "${Root\\.Objects\\.Device1\\.TemperatureAndHumiditySensor\\.Humidity}"
          },
          {
            "key": "batteryLevel",
            "path": "${Battery\\.batteryLevel}"
          }
        ],
        "rpc_methods": [
          {
            "method": "multiply",
            "arguments": [2, 4]
          }
        ],
        "attributes_updates": [
          {
            "attributeOnThingsBoard": "deviceName",
            "attributeOnDevice": "Root\\.Objects\\.Device1\\.serialNumber"
          }
        ]
      }
    ]
  }
}

Section “server”

Configuration in this section uses for connecting to OPC-UA server.

Subsection “identity”

There are several types available for this subsection:

1. anonymous
2. username
3. cert.PEM

    "identity": {
      "type": "anonymous"
    },

    "identity": {
      "username": "user",
      "password": "5Tr0nG?@$sW0rD"
    },

    "identity": {
      "type": "cert.PEM",
      "caCert": "etc/thingsboard-gateway/ca.pem",
      "privateKey": "etc/thingsboard-gateway/private_key.pem", 
      "cert": "etc/thingsboard-gateway/cert.pem",
      "mode": "SignAndEncrypt",
      "username": "user",
      "password": "5Tr0nG?@$sW0rD"
    },

Section “mapping”

This configuration section contains array of nodes that the gateway will subscribe to after connecting to the OPC-UA server and settings about processing data from these nodes.

This part of configuration will look like:

        "deviceNodePattern": "Root\\.Objects\\.Device1",
        "deviceNamePattern": "Device ${Root\\.Objects\\.Device1\\.serialNumber}",

Optionally, you can add in this section parameter “converter” for using custom converter.

Subsection “attributes”

This subsection contains configurations for variables of the object, that will be interpreted as attributes for the device.

** * ** You can put here some expression for search like:

1. Full path to node - ${Root\.Objects\.Device1\.TemperatureAndHumiditySensor\.Humidity}
2. Relative path from device object - ${TemperatureAndHumiditySensor\.Humidity}
3. Some regular expression to search - ${Root\.Objects\.Device\d*\.TemperatureAndHumiditySensor\.Humidity}
4. Namespace identifier and node identifier - ${ns=2;i=5}

This part of configuration will look like:

        "attributes": [
          {
            "key": "temperature °C",
            "path": "${ns=2;i=5}"
          }
        ],

Subsection “timeseries”

This subsection contains configurations for variables of the object, that will be interpreted as telemetry for the device.

** * ** You can put here some expression for search like:

1. Full path to node - ${Root\.Objects\.Device1\.TemperatureAndHumiditySensor\.Humidity}
2. Relative path from device object - ${TemperatureAndHumiditySensor\.Humidity}
3. Some regular expression to search - ${Root\.Objects\.Device\d*\.TemperatureAndHumiditySensor\.Humidity}
4. Namespace identifier and node identifier - ${ns=2;i=5}

This part of configuration will look like:

        "timeseries": [
          {
            "key": "humidity",
            "path": "${Root\\.Objects\\.Device1\\.TemperatureAndHumiditySensor\\.Humidity}"
          }
        ],

Subsection “rpc_methods”

This subsection contains configuration for RPC request from ThingsBoard platform instance.

This part of configuration will look like:

        "rpc_methods": [
          {
            "method": "multiply",
            "arguments": [2, 4]
          }
        ],

Subsection “attributes_updates”

This subsection contains configuration for attribute updates request from ThingsBoard platform instance.

This part of configuration will look like:

        "attributes_updates": [
          {
            "attributeOnThingsBoard": "deviceName",
            "attributeOnDevice": "Root\\.Objects\\.Device1\\.serialNumber"
          }
        ]

Next steps

Explore guides related to main ThingsBoard features:

• How to connect OPC-UA server to the gateway
• ThingsBoard IoT Gateway Features
• Data Visualization - how to visualize collected data.
• Device attributes - how to use device attributes.
• Telemetry data collection - how to collect telemetry data.
• Using RPC capabilities - how to send commands to/from devices.
• Rule Engine - how to use rule engine to analyze data from devices.