Changes for page ThingsBoard

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

From 193.1 to 194.1 From 205.1 to 206.1

From version 194.1

edited by Dilisi S
on 2025/03/28 00:23

Change comment: Mar 27 edits - part 3

To version 205.1

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

Change comment: Uploaded new attachment "add-integration-part-1.png", version {1}

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -164,34 +164,18 @@
  [[image:ins1.png||height="310" width="500"]]
--= 3. Creating Devices =
++= 3. Data Converters =
--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 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**.
--
--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.
++**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**.
--== 4.1 Uplink ==
++== 3.1 Uplink ==
++
  In the left navigation, click **Integrations center**, and then click **Data converters**.
@@ -198,7 +198,7 @@
  [[image:data-converters-list-empty.png]]
--On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
++On the **Data converters** page, click on the ‘**+**’ button, and then click on **Create new converter** from the dropdown menu.
@@ -205,79 +205,67 @@
  [[image:create-new-converter-menu.png||height="259" width="500"]]
--The **Add data converter** window will appear.
++The **Add data converter** window appears.
--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**.
++Name it ‘**MQTT Uplink Converter**’ and select the Type as **Uplink**.
  Click on the **TBEL** button if it has not been selected by default.
--Modify the default TBEL function to match with your device as described below:
++Replace the default TBEL decoder function with the following universal TBEL decoder function, which decodes MQTT payload from any Dragino NB-IoT device.
--* 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 = '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
--   }
++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
  };
--
--/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
--
  return result;
  {{/code}}
@@ -285,18 +285,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]]
--= 5. Add Integration =
++= 4. Add Integration =
  In the left navigation, click **Integrations center**, and then click **Integrations**.
@@ -318,7 +318,7 @@
  * **Integration type**: MQTT
  * **Name**: MQTT integration - Device A
  * **Enable integration**: YES
--* **Allows create devices or assets**: YES
++* **Allow create devices or assets**: YES
  Click **Next** button.
@@ -398,10 +398,10 @@
--= 6. Verifying the receipt of data from virtual devices =
++= 5. Verifying the receipt of data from virtual devices =
--== 6.1 How does it work? ==
++== 5.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.
@@ -432,7 +432,7 @@
  [[image:integration-active.png]]
--== 6.3 Viewing messages ==
++== 5.3 Viewing messages ==
  Go back to the **Integrations** page.
@@ -483,7 +483,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.
--= 7. Creating a Dashboard =
++= 6. 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.
@@ -493,7 +493,7 @@
  First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
--{{code language="none"}}mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 22, "humidity":80}'{{/code}}
++{{code language="none"}}mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":80, "pressure":1005}'{{/code}}
  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
@@ -531,15 +531,19 @@
  Configure the **Time series chart** widget as follows:
--* **Datasource** - select S31B-NB device you provisioned.
++* **Datasource** - select **Device A** device you provisioned.
  * **Series**:
  ** **temperature** - you can see this key by default.
  ** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
  * Click on the **Add** button.
--[[image:timeseries-1.png||height="491" width="700"]]
++{{info}}
++You can add only the relevant fields from the device's payload to display data on a widget. These fields are called 'keys'.
++{{/info}}
++[[image:Screenshot 2025-03-31 at 06.51.15.png||height="485" width="700"]]
++
  The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
  Click the **Save** button to add the widget to the dashboard.
@@ -552,12 +552,11 @@
  {{code language="none"}}
--mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 22, "humidity":70}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":70, "pressure":1005}'
--mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 27, "humidity":72}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":27, "humidity":72, "pressure":1005}'
--mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 19, "humidity":80}'
--
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":19, "humidity":80, "pressure":1005}'
  {{/code}}
  The chart will update with the values in realtime, as shown in the below image.
@@ -566,7 +566,7 @@
  [[image:timeseries-4.png||height="316" width="700"]]
--= 8. Configure NB-IoT Sensor =
++= 8. Configure Physical NB-IoT Sensor =
  Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
@@ -588,10 +588,7 @@
--The following image shows the uplink payload of a real Dragino device. The publish topic is **TS01-NB**, and the device name is **861275077962896**, which is represented by the **IMEI**.
++The following image shows the uplink payload of a real Dragino device. The publish topic is '**TS01-NB' that contains fields in the payload, IMEI, IMSI, Model, temperature, etc**. Note that we have created a device named **TS01-NB** in the **Devices** section in advance.
--{{info}}
--The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
--{{/info}}
  [[image:image-4.png]]

data-converters-list.png

Size

@@ -1,1 +1,1 @@
--212.2 KB
++19.0 KB

Content

Screenshot 2025-03-31 at 06.51.15.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+179.5 KB

Content

add-integration-part-1.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+48.6 KB

Content

mqtt-uplink-converter.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+75.3 KB

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation