Changes for page ThingsBoard

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

From 190.1 to 189.1 From 209.1 to 208.1

From version 208.1

edited by Dilisi S
on 2025/04/21 17:06

Change comment: There is no comment for this version

To version 190.1

edited by Dilisi S
on 2025/03/27 23:15

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

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (2 modified, 0 added, 6 removed)

Details

Page properties

Content

@@ -164,18 +164,34 @@
  [[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 **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**.
@@ -288,17 +288,18 @@
  **Basic settings:**
  * **Integration type**: MQTT
--* **Name**: MQTT integration
++* **Name**: MQTT integration - Device A
  * **Enable integration**: YES
--* **Allow create devices or assets**: YES
++* **Allows create devices or assets**: YES
  Click **Next** button.
++[[image:add-integration-basic-settings.png||height="504" width="500"]]
--[[image:add-integration-part-1.png||height="483" width="500"]]
++
  **Uplink data converter:**
  * Click on the **Select existing** button.
@@ -307,8 +307,8 @@
  Click **Next** button.
++[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
--[[image:add-integration-part-2.png||height="484" width="500"]]
  **Downlink data converter:**
@@ -326,18 +326,18 @@
  **Connection:**
--* **Host**: Host URL (Eg, **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
--* **Port**: 8883 (the port number may differ based on your MQTT broker)
++* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
++* **Port**: 8883
  * **Credentials type**: Basic
  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
  * **Enable SSL**: YES
--* **Topic**: # (the # symbol indicates that it filters all topics).
++* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
  * **QoS:** 0-At most once
--[[image:add-integration-4.png||height="484" width="500"]]
++[[image:add-integartion-connection.png||height="505" width="500"]]
  Click on the **Advanced settings** button.
@@ -367,16 +367,15 @@
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
--[[image:integration-added.png]]
++[[image:new-integration-pending.png]]
++= 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.
  The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
@@ -393,7 +393,7 @@
  == 5.2 Sending messages ==
--On your computer's terminal, issue the following MQTT command which simulates the device '**Device A'**. The message payload contains the fields IMEI, temperature, humidity, and pressure, which hold the values 350693903995577, 30, 80, and 1005 respectively. This payload is also (technically) known as telemetry.
++On the terminal, issue the following MQTT command which simulates the device S31B-NB. The message payload contains the fields temperature and humidity, which hold the values S31B-NB and 27, respectively. This payload is also (technically) known as telemetry.
  {{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":30, "humidity":80, "pressure":1005}'
@@ -405,9 +405,11 @@
  [[image:integration-active.png]]
--== 5.3 Viewing messages ==
++== 6.3 Viewing messages ==
++
++
  Go back to the **Integrations** page.
  Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
@@ -423,28 +423,21 @@
  Then click on the **Apply changes** (//**tick icon**//) button.
--[[image:debug-enabled.png||height="301" width="700"]]
++[[image:Screenshot 2025-03-18 at 09.23.10.png]]
--
--
  Now go to the **Events** tab.
--Select the **Event type** as **Debug** from the dropdown list.
++Select the Event type as **Debug** from the dropdown list.
--Publish another message (of course, you can repeat the previous message by pressing the UP arrow on your keyboard and then press Enter key) to your MQTT broker from your terminal, for example:
++Now you can see all the Uplink messages you are simulating through the MQTT broker. The status should be **OK **if there is no errors in your integration.
--{{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":30, "humidity":80, "pressure":1005}'
--{{/code}}
--Now you can see that uplink message in the **Events** tab (Click the **refresh** button if you didn't see any messages in the Events tab). The status should be **OK **if there is no errors in your integration.
--
--
  [[image:Screenshot 2025-03-26 at 19.49.31.png]]
++
  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
@@ -456,7 +456,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.
@@ -466,7 +466,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 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":80, "pressure":1005}'{{/code}}
++{{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}}
  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
@@ -504,19 +504,15 @@
  Configure the **Time series chart** widget as follows:
--* **Datasource** - select **Device A** device you provisioned.
++* **Datasource** - select S31B-NB 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.
--{{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:timeseries-1.png||height="491" width="700"]]
--[[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.
@@ -529,11 +529,12 @@
  {{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":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": 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":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": 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":19, "humidity":80, "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}'
++
  {{/code}}
  The chart will update with the values in realtime, as shown in the below image.
@@ -542,7 +542,7 @@
  [[image:timeseries-4.png||height="316" width="700"]]
--= 8. Configure Physical NB-IoT Sensor =
++= 8. Configure 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**.
@@ -564,7 +564,12 @@
--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.
++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**.
++{{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]]
++
++

Screenshot 2025-03-31 at 06.51.15.png

Author

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

Size

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

Content

add-integration-4.png

Author

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

Size

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

Content

add-integration-part-1.png

Author

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

Size

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

Content

add-integration-part-2.png

Author

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

Size

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

Content

data-converters-list.png

Size

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

Content

debug-enabled.png

Author

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

Size

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

Content

integration-active.png

Size

@@ -1,1 +1,1 @@
--64.1 KB
++64.2 KB

Content

mqtt-uplink-converter.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation