Socket

Configure the following fields:

• Connection type — TCP or UDP
• Address — IP address to bind to
• Port — port to listen on
• Buffer size — size of the received data block buffer

Click the plus icon to add a new device, then fill in the following fields:

• Address filter — IP address pattern allowed to connect (see examples below)
• Device name — device name in ThingsBoard
• Device profile — device profile in ThingsBoard (optional)
• Encoding — encoding used when writing string data to storage

Click the plus icon to add a new device. Fill in the device details.

1. Click the pencil icon of the Attributes section to add a new attribute key.

   

2. Click Add attribute in the opened window.

   

3. Enter the key name and byte positions, then click Apply.

   

4. Click the pencil icon of the Time series section to add a new time series key.

   

5. Click Add time series in the opened window.

   

6. Enter the key name and byte positions, then click Apply.

   

You can enable a per-key report strategy. Available strategies:

• On report period — after every report period
• On value change — when a value changes
• On value change or report period — when a value changes or the report period elapses
• On received — immediately after data is received (default)

Both telemetry and attributes use the same field structure:

{
  "address": "127.0.0.1:50001",
  "deviceName": "Device Example",
  "deviceType": "default",
  "encoding": "utf-8",
  "telemetry": [
    { "key": "temp", "byteFrom": 0, "byteTo": -1 },
    { "key": "hum",  "byteFrom": 0, "byteTo": 2  }
  ],
  "attributes": [
    { "key": "name", "byteFrom": 0, "byteTo": -1 },
    { "key": "num",  "byteFrom": 2, "byteTo": 4  }
  ]
}

Time series settings in Advanced mode. Attributes settings in Advanced mode.

1. Click the pencil icon of the Attribute requests section.

   

2. Click Add attribute request in the opened window.

   

3. Select the request type, enter the request expression and attribute name expression, then click Apply.

   

"attributeRequests": [
  {
    "type": "shared",
    "requestExpression": "${[0:3]==atr}",
    "attributeNameExpression": "[3:]"
  }
]

To request multiple attributes in a single message, add multiple slice ranges in attributeNameExpression:

"attributeRequests": [
  {
    "type": "shared",
    "requestExpression": "${[0:3]==atr}",
    "attributeNameExpression": "[4:19][20:]"
  }
]

The device sends: atr sharedAttribute sharedAttribute1

1. Click the pencil icon of the Attribute updates section.

   

2. Click Add attribute update in the opened window.

   

3. Select encoding and fill in the Attribute on platform field, then click Apply.

   

1. Click the pencil icon of the RPC methods section.

   

2. Click Add method in the opened window.

   

3. Fill in Method name, select encoding, and set With Response, then click Apply.