Changes for page ThingsBoard

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

From 128.1 to 129.1 From 164.1 to 165.1

From version 129.1

edited by Dilisi S
on 2025/03/08 22:02

Change comment: There is no comment for this version

To version 164.1

edited by Dilisi S
on 2025/03/18 05:03

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -22,7 +22,10 @@
  To complete this tutorial, you need to have the following:
  * ThingsBoard cloud account
--* HiveMQ Cloud account
++* MQTT Broker (public or private) such as,
++** **[[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.
++** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
  == 2.1 ThingsBoard Cloud ==
@@ -66,7 +66,9 @@
  == 2.2 HiveMQ Cloud ==
++=== 2.2.1 HiveMQ Cloud ===
++
  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
  Click on the **Start Free** button.
@@ -141,6 +141,24 @@
  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
++=== 2.2.2 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.
++
++
++[[image:emqx.png||height="420" width="500"]]
++
++
++=== 2.2.3 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.
++
++If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.
++
++[[image:ins1.png||height="310" width="500"]]
++
++
  = 3. Data Converters =
@@ -153,7 +153,6 @@
  In the left navigation, click **Integrations center**, and then click **Data converters**.
--
  [[image:data-converters-list-empty.png]]
@@ -166,34 +166,130 @@
  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
--Click on the **TBEL** button if not selected it by default. Delete the existing decoder function in the code editor. Now copy and paste the following decoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
++Click on the **JavaScript** button.
--{{code language="JavaScript"}}
--/** Decoder **/
++Delete the default decoder function in the code editor. Now copy and paste the following decoder function written in **JavaScript** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
++
++{{code language="JavaScript"}}
++//Version: 0.1
  // decode payload to string
  var payloadStr = decodeToString(payload);
--var data = JSON.parse(payloadStr);
--var deviceName =  metadata.topic.split("/")[3];
  // decode payload to JSON
--var deviceType = 'sensor';
++var objdata = {};
++var obj1 = {};
++var data = decodeToJson(payload);
++var deviceName = data.IMEI;
++delete data.IMEI;
++var modelname = "Dragino " + data.Model;
++//var mod = data.mod
++delete data.Model;
++//delete data.mod
++var timestamp = new Date().getTime();
--// Result object with device attributes/telemetry data
++for (var key in data) {
++
++    if (Number(key)) {
++        obj1[key] = data[key];
++        obj1[key][obj1[key].length - 1] = Number(new Date(
++            obj1[key][obj1[key].length - 1]));
++
++    }
++//Alec submitted25/02/25
++//turn old key into new
++    else if (key === "Reading") {
++        objdata["reading"] = data[key];
++    } else if (key === "work mode") {
++        objdata["work_mode"] = data[key];
++    } else if (key === "hum") {
++        objdata["humidity"] = data[key];
++    }else if (key === "hum2") {
++        objdata["humidity2"] = data[key];
++    } else if (key === "hum3") {
++        objdata["humidity3"] = data[key];
++    } else if (key === "tem") {
++        objdata["temperature"] = data[key];
++    } else if (key === "tem2") {
++        objdata["temperature2"] = data[key];
++    } else if (key === "tem3") {
++        objdata["temperature3"] = data[key];
++    } else if (key === "DS18B20_Temp") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "ds18b20_temperature") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "DS18B20_temperature_pro") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "tdc send flag") {
++        objdata["tdc_send_flag"] = data[key];
++    } else if (key === "trigger mode") {
++        objdata["trigger_mode"] = data[key];
++    } else if (key === "soil dielectric constant") {
++        objdata["soil_dielectric_constant"] = data[key];
++    } else if (key === "door open num") {
++        objdata["door_open_num"] = data[key];
++    } else if (key === "door duration") {
++        objdata["door_duration"] = data[key];
++    } else if (key === "count time") {
++        objdata["count_time"] = data[key];
++    } else if (key === "last open time2") {
++        objdata["last_open_time2"] = data[key];
++    } else if (key === "last open time3") {
++        objdata["last_open_time3"] = data[key];
++    }
++//Alec submitted25/02/25
++    else {
++        objdata[key] = data[key]
++    }
++}
++var listdata = [{
++    "ts": timestamp,
++    "values": objdata
++}]
++for (var key1 in obj1) {
++    if (modelname == "Dragino RS485-NB") {
++        listdata.push({
++            "ts": obj1[key1][obj1[key1].length - 1],
++            "values": {
++                "Payload": obj1[key1][0],
++            }
++        })
++    } else {
++        listdata.push({
++            "ts": obj1[key1][obj1[key1].length - 1],
++            "values": {
++                "values": obj1[key1]
++            },
++        })
++    }
++}
  var result = {
++
      deviceName: deviceName,
--    deviceType: deviceType,
++    deviceType: modelname,
      attributes: {
--        integrationName: metadata['integrationName'],
++        model: modelname,
++        //customerName: "NB-CB",
++        //groupName: "NB-CB",
++        //integrationName: metadata['integrationName']
++
      },
--    telemetry: {
--        temperature: data.temperature,
--        humidity: data.humidity,
--    }
--};
++    telemetry: listdata
++}
--/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++function decodeToString(payload) {
++    return String.fromCharCode.apply(String, payload);
++}
++function decodeToJson(payload) {
++    // covert payload to string.
++    var str = decodeToString(payload);
++
++    // parse string to JSON
++    var data = JSON.parse(str);
++    return data;
++}
++
  return result;
  {{/code}}
@@ -201,16 +201,16 @@
  Click on the **Add** button.
++[[image:mqtt-uplink.png||width="500"]]
--[[image:add-uplink-data-converter.png||height="529" width="500"]]
  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
++
  [[image:data-converter-list-showing-uplink-dc.png]]
--
  == 3.2 Downlink ==
@@ -268,7 +268,6 @@
  Click on the **Add** button.
--
  [[image:add-downlink-data-converter.png||height="529" width="500"]]
@@ -278,7 +278,6 @@
  [[image:data-converters-list.png]]
--
  = 4. Add Integration =
@@ -306,7 +306,6 @@
  Click **Next** button.
--
  [[image:add-integration-basic-settings.png||height="511" width="500"]]
@@ -318,7 +318,6 @@
  Click **Next** button.
--
  [[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
@@ -330,19 +330,18 @@
  Click **Next** button.
--
  [[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
  **Connection:**
--* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
++* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
  * **Port**: 8883
  * **Credentials**: Basic
  * **Enable SSL**: YES
  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
--* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
++* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
  * **QoS:** 0-At most once
  [[image:add-integration-connection.png||height="511" width="500"]]
@@ -350,8 +350,8 @@
  Click on the **Advanced settings** button.
--* **Clean session:** NO
--* **Retained**: NO
++* **Clean session:** YES
++* **Retained**: YES
  [[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
@@ -379,13 +379,163 @@
  [[image:new-integration-pending.png]]
--= 5. Verifying the receipt of data from the device =
++= 5. Verifying the receipt of data from virtual devices =
--On the terminal, issue the following MQTT command which simulates the device S31B-NB.
++== 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 **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
++
++(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows, which is common for all **~-~-NB** and **~-~-CB** series devices. The **IMEI** field is mandatory and is used to provision a new device with the name assigned to it in ThingsBoard.
++
  {{code language="none"}}
--mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
++{"IMEI": "S31B-NB", "temperature": 27, ......}
  {{/code}}
--If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter  NB/CB → Events.
++Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
++
++
++== 5.2 Sending messages ==
++
++
++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 -t "v1/devices/me/telemetry" -u "xxxxx" -P "xxxxx" -m '{"IMEI": "S31B-NB", "temperature": 27}'
++{{/code}}
++
++If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
++
++
++[[image:integration-active.png]]
++
++
++Also, a new device named **S31B-NB** will appear under **//Entities -> Devices -> All//**. This means the first MQTT message triggers ThingsBoard to provision a device named **S31B-NB**.
++
++
++[[image:new-device.png]]
++
++
++Click on the **MQTT integration NB/CB **list in the **Integrations** page to see its details.
++
++Then go to the **Events** tab.
++
++You can see the uplink message you sent from the MQTT broker.
++
++
++[[image:Screenshot 2025-03-16 at 18.38.59.png]]
++
++
++
++
++Now 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-16 at 18.39.12.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.
++
++
++
++= 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.
++
++
++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.
++
++
++In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
++
++
++[[image:dashboard-1.png]]
++
++
++In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
++
++Click on the **Add** button.
++
++
++[[image:dashboard-2.png||height="526" width="500"]]
++
++
++Click on the **Add widget / Add new widget** button.
++
++
++[[image:dashboard-3.png]]
++
++
++In the **Select widgets bundle** window, click **Charts**.
++
++
++[[image:dashboard-4.png||height="537" width="700"]]
++
++
++
++In the **Charts: select widget** window, click **Time series chart**.
++
++
++[[image:dashboard-5.png||height="525" width="700"]]
++
++
++Configure the **Time series chart** widget as follows:
++
++* **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.
++
++[[image:timeseries-1.png||height="491" 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"]]
++
++
++Now send the following MQTT messages from the terminal to simulate the data.
++
++
++{{code language="none"}}
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":20, "humidity":70}'
++
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":22, "humidity":71}'
++
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":18, "humidity":79}'
++
++{{/code}}
++
++The chart will update with the values in realtime, as shown in the below image.
++
++
++[[image:timeseries-4.png||height="316" width="700"]]
++
++
++= 7. 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 **S31B-NB**.
++
++First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
++
++
++**AT Commands**
++
++* **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
++* **AT+SUBTOPIC=<MQTT topic>**
++* **AT+PUBTOPIC=<MQTT topic>**
++* **AT+CLIENT=null**
++* **AT+UNAME=<MQTT Username>**
++* **AT+PWD=<MQTT Password>**
++* **AT+SERVADDR=<Broker address, Port>**
++
++Test your uplink by pressing the ACT button for 1 second.

add-integration-connection.png

Size

@@ -1,1 +1,1 @@
--124.4 KB
++153.2 KB

Content

Screenshot 2025-03-16 at 18.38.59.png

Author

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

Size

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

Content

Screenshot 2025-03-16 at 18.39.12.png

Author

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

Size

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

Content

dashboard-1.png

Author

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

Size

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

Content

dashboard-2.png

Author

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

Size

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

Content

dashboard-3.png

Author

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

Size

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

Content

dashboard-4.png

Author

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

Size

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

Content

dashboard-5.png

Author

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

Size

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

Content

device-provision-1.png

Author

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

Size

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

Content

device-provision-2.png

Author

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

Size

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

Content

emqx.png

Author

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

Size

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

Content

ins1.png

Author

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

Size

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

Content

integration-active.png

Author

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

Size

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

Content

mqtt-uplink.png

Author

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

Size

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

Content

new-device.png

Author

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

Size

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

Content

telemetry-1.png

Author

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

Size

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

Content

telemetry-2.png

Author

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

Size

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

Content

timeseries-1.png

Author

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

Size

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

Content

timeseries-3.png

Author

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

Size

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

Content

timeseries-4.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation