Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23

From 203.1 to 202.1 From 205.1 to 204.1

From version 204.1

edited by Dilisi S
on 2025/04/21 16:49

Change comment: April 21 edits - part 1

To version 203.1

edited by Dilisi S
on 2025/04/21 16:48

Change comment: Uploaded new attachment "data-converters-list.png", version {1}

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -164,18 +164,37 @@
  [[image:ins1.png||height="310" width="500"]]
++= 3. Creating Devices (Optional) =
--= 3. Data Converters =
++{{info}}
++**The following procedure is optional. If you haven't created any device in ThingsBoard first, ThingsBoard will automatically create a device for you based on the integration settings (the device name defined in the uplink decoder) just after it receives the first uplink from your device.**
++{{/info}}
++First, you need to create devices in ThingsBoard to represent your physical devices. For example, you can name it **Device A**, and the second device could be **Device B** or any name you prefer. The device name should be unique within the **Devices** space.
--In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
--**In this section, you will create a universal uplink data converter for all Dragino NB-IoT devices. The uplink decoder converts any MQTT message coming from a device into key-value pairs that can be used to display and visualize data using various widgets on the dashboard**.
++In the left navigation, click **Entities -> Devices**.
++Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
--== 3.1 Uplink ==
++In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
++Click the **Add** button.
++Skip the **connectivity testing** by clicking the **Close** button.
++
++The device is created and listed on the **Devices** page. Note that its initial state is **Inactive** because it has not received any data yet.
++
++
++= 4. Data Converters =
++
++
++In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
++
++
++== 4.1 Uplink ==
++
++
  In the left navigation, click **Integrations center**, and then click **Data converters**.
@@ -182,7 +182,7 @@
  [[image:data-converters-list-empty.png]]
--On the **Data converters** page, click on the ‘**+**’ button, and then click on **Create new converter** from the dropdown menu.
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
@@ -189,67 +189,79 @@
  [[image:create-new-converter-menu.png||height="259" width="500"]]
--The **Add data converter** window appears.
++The **Add data converter** window will appear.
--Name it ‘**MQTT Uplink Converter**’ and select the Type as **Uplink**.
++Let's create an uplink data converter for the device named '**Device A**'. Name it ‘**MQTT Uplink Converter - Device A**’ and select the Type as **Uplink**.
  Click on the **TBEL** button if it has not been selected by default.
--Replace the default TBEL decoder function with the following universal TBEL decoder function, which decodes MQTT payload from any Dragino NB-IoT device.
++Modify the default TBEL function to match with your device as described below:
++* Uncomment** line 11**:
++
++//var data = decodeToJson(payload)//
++
++
++* **Line 13**: Assign your device name to the **deviceName** field. - We used **Device A** as it is to match with our device, **Device A **in the **Devices **section.
++* From **line 38**: Modify the telemetry section to allow parsed data to be assigned to the fields.
++
++//telemetry: {
++       temperature: data.temperature,
++       humidity: data.humidity,
++       rawData: payloadStr
++   }//
++
++
++The modified uplink decoder function to match with **Device A** is shown below.
++
  {{code language="JavaScript"}}
++// Decode an uplink message from a buffer
++// payload - array of bytes
++// metadata - key/value object
++
++/** Decoder **/
++
++// decode payload to string
++var payloadStr = decodeToString(payload);
++
  // decode payload to JSON
--var pattern = "yyyy/MM/dd HH:mm:ss";
--var objdata = {};
--var obj1 = {};
  var data = decodeToJson(payload);
--var deviceName = data.IMEI;
--data.remove("IMEI");
--var modelname = "Dragino "+ data.Model;
--//var mod = data.mod
--data.remove("Model");
--//delete data.mod
--var timestamp = new Date().getTime();
--foreach (entry: data.entrySet()) {
--    var key = entry.getKey();
--    var value = entry.getValue();
--    //objdata[key] = data[key]
--    if(key.matches("^-?\\d+$")){ //is number
--        obj1[key]=data[key];
--        var index = obj1[key].length-1;
--        obj1[key][index]=new Date(obj1[key][index],pattern).getTime();
--    }
--    else if (key==="bat"||key==="BAT"){
--        objdata["battery"] = data[key];
--    }
--    else{
--    objdata[key] = data[key];
--}}
--var listdata = [{"ts":timestamp,"values":objdata}];
--foreach ( entry1: obj1.entrySet()){
--    var key1 = entry1.getKey();
--    var value1 = entry1.getValue();
--    var index = obj1[key1].length-1;
--    var ts = obj1[key1][index];
--    if (modelname=="Dragino RS485-NB"){
--        listdata.push({"ts":ts,"values":{"Payload":obj1[key1][0]}});
--    }
--    else{
--        listdata.push({"ts":ts,"values":{"values":obj1[key1]}});
--    }
--}
--   var result = {
--    deviceName: deviceName,
--    deviceType: modelname,
--    attributes: {
--        model: modelname
--        //customerName: "NB-CB",
--        //groupName: "NB-CB",
--        //integrationName: metadata['integrationName']
--    },
--    telemetry: listdata
++
++var deviceName = 'Device A';
++var deviceType = 'thermostat';
++var customerName = 'Customer C';
++var groupName = 'thermostat devices';
++var manufacturer = 'Example corporation';
++// use assetName and assetType instead of deviceName and deviceType
++// to automatically create assets instead of devices.
++// var assetName = 'Asset A';
++// var assetType = 'building';
++
++// Result object with device/asset attributes/telemetry data
++var result = {
++// Use deviceName and deviceType or assetName and assetType, but not both.
++   deviceName: deviceName,
++   deviceType: deviceType,
++// assetName: assetName,
++// assetType: assetType,
++// customerName: customerName,
++   groupName: groupName,
++   attributes: {
++       model: 'Model A',
++       serialNumber: 'SN111',
++       integrationName: metadata['integrationName'],
++       manufacturer: manufacturer
++   },
++   telemetry: {
++       temperature: data.temperature,
++       humidity: data.humidity,
++       rawData: payloadStr
++   }
  };
++
++/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++
  return result;
  {{/code}}
@@ -257,18 +257,18 @@
  Once you modify the decoder function, click on the **Add** button.
--[[image:mqtt-uplink-converter.png||height="498" width="500"]]
++[[image:ul-data-converter-device-a.png||height="524" width="500"]]
  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
++[[image:ul-data-converter-added.png||height="257"]]
--[[image:data-converters-list.png]]
--= 4. Add Integration =
++= 5. Add Integration =
  In the left navigation, click **Integrations center**, and then click **Integrations**.
@@ -370,10 +370,10 @@
--= 5. Verifying the receipt of data from virtual devices =
++= 6. Verifying the receipt of data from virtual devices =
--== 5.1 How does it work? ==
++== 6.1 How does it work? ==
  We use the Mosquitto MQTT client to simulate MQTT messages, acting as a virtual device. First, install the Mosquitto client on your computer from [[this link>>url:https://mosquitto.org/download/]]. The Mosquitto client publishes messages to the MQTT broker (HiveMQ) on a specified MQTT topic. ThingsBoard subscribes to these messages using the same topic.
@@ -404,7 +404,7 @@
  [[image:integration-active.png]]
--== 5.3 Viewing messages ==
++== 6.3 Viewing messages ==
  Go back to the **Integrations** page.
@@ -455,7 +455,7 @@
  Now, you have successfully tested your integration with a simulated uplink payload and verified that it is received by ThingsBoard, and the device is provisioned.
--= 6. Creating a Dashboard =
++= 7. Creating a Dashboard =
  ThingsBoard **Dashboards** provide a powerful way to visualize and monitor real-time and historical data from connected devices. They allow users to create interactive, customizable panels displaying telemetry data, device status, and other key metrics. With a variety of widgets, including charts, maps, and tables, dashboards help users gain insights, track trends, and manage IoT deployments efficiently.

Changes for page ThingsBoard

Summary

Details

Applications

Navigation