OPC-UA Connector Configuration

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.

• Example of OPC-UA Connector config file. Press to expand.

  {
  "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 | anonymous
   (recommended if all servers in the local network) | username
   (recommended as basic level of security) | cert.PEM
   (recommended as better level of security) | | —- | —- | —- |

This option of identity subsection is simplest.

This part of configuration will look like:

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

Using this option you can provide the username and password for connection to OPC-UA server.

This part of configuration will look like:

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

This option for identity is safest.

Optionally, you can provide the username/password pair.
This part of configuration will look like:

"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"
          }
        ]