Changes for page ThingsBoard

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

From 201.1 to 202.1 From 221.1 to 222.1

From version 202.1

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

Change comment: Uploaded new attachment "mqtt-uplink-converter.png", version {1}

To version 221.1

edited by Dilisi S
on 2025/04/23 01:38

Change comment: April 22 edits

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -23,8 +23,9 @@
  * ThingsBoard cloud account
  * MQTT Broker (public or private) such as,
++** [[ThingsBoard MQTT broker>>https://thingsboard.io/docs/mqtt-broker/]] (TBMQ)
  ** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**
--** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
++** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MQTT learning and testing, and should not be used in the production environment.
  ** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
  == 2.1 ThingsBoard Cloud ==
@@ -67,11 +67,19 @@
  [[image:thingsboard-6.png||height="244" width="500"]]
--== 2.2 HiveMQ Cloud ==
++== 2.2 MQTT Brokers ==
--=== 2.2.1 HiveMQ Cloud ===
++This section introduces some MQTT brokers that you can use to publish messages from the device side and subscribe from the ThingsBoard side.
++=== 2.2.1 ThingsBoard MQTT broker (TBMQ) ===
++
++The complete instructions for installing, configuring, and using the TBMQ can be found [[here>>https://thingsboard.io/docs/mqtt-broker/getting-started/]].
++
++
++=== 2.2.2 HiveMQ Cloud ===
++
++
  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
  Click on the **Start Free** button.
@@ -146,7 +146,7 @@
  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
--=== 2.2.2 emqx ===
++=== 2.2.3 emqx ===
  The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
@@ -155,7 +155,7 @@
  [[image:emqx.png||height="420" width="500"]]
--=== 2.2.3 Ins1.thingseye.io ===
++=== 2.2.4 Ins1.thingseye.io ===
  [[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.
@@ -164,37 +164,18 @@
  [[image:ins1.png||height="310" width="500"]]
--= 3. Creating Devices (Optional) =
--{{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}}
++= 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**.
@@ -201,7 +201,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.
@@ -208,79 +208,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}}
@@ -288,18 +288,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**.
@@ -319,7 +319,7 @@
  **Basic settings:**
  * **Integration type**: MQTT
--* **Name**: MQTT integration - Device A
++* **Name**: MQTT integration
  * **Enable integration**: YES
  * **Allow create devices or assets**: YES
@@ -326,11 +326,10 @@
  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.
@@ -339,8 +339,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:**
@@ -358,16 +358,16 @@
  **Connection:**
--* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
--* **Port**: 8883
++* **Host**: Host URL (Eg, **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
++* **Port**: 8883 (the port number may differ based on your MQTT broker)
  * **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: device/a** (The topic can be anything; you can even use just the device name.)
++* **Topic**: # (the # symbol indicates that it filters all topics).
  * **QoS:** 0-At most once
--[[image:add-integartion-connection.png||height="505" width="500"]]
++[[image:add-integration-4.png||height="484" width="500"]]
  Click on the **Advanced settings** button.
@@ -397,50 +397,59 @@
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
--[[image:integration-added.png]]
++[[image:integrations-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.
++The Mosquitto client publishes messages (payloads) to a topic - for example, # or device/ts01-nb. You can, of course, use any topic you prefer.
--(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
++(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows. The **IMEI **and **Model **are mandatory fields. For other fields, you can use any number of key-value pairs.
++
  {{code language="none"}}
--{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
++{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}
  {{/code}}
--Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
--
  == 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 your computer's terminal, issue the following MQTT command, which simulates the device named '**350693903995577'**. The message payload contains the fields IMEI, Model, temperature, humidity, and pressure, which hold the values 350693903995577,  TS01-NB, 30, 80, and 1005 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}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/350693903995577" -m '{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}'
  {{/code}}
--If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
++If the integration was performed without errors, a new device named **350693903995577 **is created in the **Devices **section.
--[[image:integration-active.png]]
++[[image:new-device-1.png]]
--== 6.3 Viewing messages ==
++The status of the integration also changes to '**Active**' after the first telemetry transmission.
++[[image:Screenshot 2025-04-21 122154.png]]
++
++
++
++**When ThingsBoard receives this message for the first time, it will automatically create a new device named '350693903995577' in the Devices section. The device name is based on the IMEI number. For subsequent messages with the same IMEI, no duplicate devices will be created. Each new IMEI number will result in a unique entry in the Devices section, representing a physical device.**
++
++
++== 5.3 Viewing messages ==
++
++
  Go back to the **Integrations** page.
--Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
++Click on the **MQTT integration** in the **Integrations** page to see its details.
  Click on the **Edit** button (//**pen icon**//).
@@ -453,11 +453,10 @@
  Then click on the **Apply changes** (//**tick icon**//) button.
--[[image:debug-enabled.png||height="301" width="700"]]
++[[image:Screenshot 2025-04-21 122936.png||height="247" width="500"]]
--
  Now go to the **Events** tab.
  Select the **Event type** as **Debug** from the dropdown list.
@@ -465,28 +465,23 @@
  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:
  {{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}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/350693903995577" -m '{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":82, "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.
--[[image:Screenshot 2025-03-26 at 19.47.52.png]]
++[[image:Screenshot 2025-04-21 122909.png]]
--
  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.
@@ -494,11 +494,6 @@
  This section guides you on how to create a dashboard to display temperature and humidity data from the device on a time-series chart. You may also use other widgets in ThingsBoard to display data according to your requirements.
--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}}
--
--
  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
@@ -534,10 +534,11 @@
  Configure the **Time series chart** widget as follows:
--* **Datasource** - select **Device A** device you provisioned.
++* **Datasource** - select **350693903995577 **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.
++** **humidity** - Click **Add series** button. Then choose **humidity** for the key, and then type **%** as its unit.
++** pressure -  Click **Add series** button. Then choose **humidity** for the key, and then type Pa as its unit.
  * Click on the **Add** button.
  {{info}}
@@ -544,34 +544,27 @@
  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"]]
++[[image:Screenshot 2025-04-21 123647.png||height="466" 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.
--[[image:timeseries-3.png||height="347" width="700"]]
++[[image:Screenshot 2025-04-21 124145.png||height="443" width="700"]]
--Now send the following MQTT messages from the terminal to simulate the data.
++**Now send a few MQTT messages from the terminal to simulate the data. Use different values for temperature, humidity, and pressure in each message.**
++**The chart will update with the values in real time, and you will see a live chart similar to this:**
--{{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 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":27, "humidity":72, "pressure":1005}'
++[[image:Screenshot 2025-04-21 124054.png||height="441" width="700"]]
--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.
--
--
--[[image:timeseries-4.png||height="316" width="700"]]
--
--
  = 8. Configure Physical NB-IoT Sensor =
@@ -583,8 +583,8 @@
  **AT Commands**
  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
--* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
--* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
++* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: # -  **You can leave the SUBTOPIC configuration as it is, since we are not sending downlink messages to the device at the moment.
++* **AT+PUBTOPIC=<MQTT publish topic> Eg: #**
  * **AT+CLIENT=null**
  * **AT+UNAME=<MQTT Username>**
  * **AT+PWD=<MQTT Password>**
@@ -593,7 +593,6 @@
  Test your uplink by pressing the ACT button for 1 second.
--
  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.

data-converters-list.png

Size

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

Content

Screenshot 2025-04-21 122154.png

Author

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

Size

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

Content

Screenshot 2025-04-21 122909.png

Author

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

Size

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

Content

Screenshot 2025-04-21 122936.png

Author

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

Size

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

Content

Screenshot 2025-04-21 123647.png

Author

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

Size

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

Content

Screenshot 2025-04-21 124054.png

Author

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

Size

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

Content

Screenshot 2025-04-21 124145.png

Author

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

Size

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

Content

add-integration-4.png

Author

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

Size

...	...	@@ -1,0 +1,1 @@
	1	+63.1 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

add-integration-part-2.png

Author

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

Size

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

Content

device-1.png

Author

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

Size

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

Content

integrations-pending.png

Author

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

Size

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

Content

new-device-1.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation