Changes for page ThingsBoard

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

From 155.1 to 154.1 From 171.1 to 170.1

From version 170.1

edited by Dilisi S
on 2025/03/19 21:00

Change comment: There is no comment for this version

To version 155.1

edited by Dilisi S
on 2025/03/17 00:27

Change comment: Mar 16 edits - part 1

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -67,6 +67,7 @@
  [[image:thingsboard-6.png||height="244" width="500"]]
++(% class="wikigeneratedid" %)
  == 2.2 HiveMQ Cloud ==
  === 2.2.1 HiveMQ Cloud ===
@@ -176,6 +176,7 @@
  In the left navigation, click **Integrations center**, and then click **Data converters**.
++
  [[image:data-converters-list-empty.png]]
@@ -188,130 +188,34 @@
  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
--Click on the **JavaScript** button.
++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.
--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
++/** Decoder **/
++
  // decode payload to string
  var payloadStr = decodeToString(payload);
++var data = JSON.parse(payloadStr);
++var deviceName =  metadata.topic.split("/")[3];
  // decode payload to JSON
--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();
++var deviceType = 'sensor';
--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]
--            },
--        })
--    }
--}
++// Result object with device attributes/telemetry data
  var result = {
--
      deviceName: deviceName,
--    deviceType: modelname,
++    deviceType: deviceType,
      attributes: {
--        model: modelname,
--        //customerName: "NB-CB",
--        //groupName: "NB-CB",
--        //integrationName: metadata['integrationName']
--
++        integrationName: metadata['integrationName'],
      },
--    telemetry: listdata
--}
++    telemetry: {
++        temperature: data.temperature,
++        humidity: data.humidity,
++    }
++};
--function decodeToString(payload) {
--    return String.fromCharCode.apply(String, payload);
--}
++/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
--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}}
@@ -319,20 +319,84 @@
  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 ==
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
++
++[[image:create-new-converter-menu.png||width="500"]]
++
++
++
++The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
++
++Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
++
++
++{{code language="JavaScript"}}
++// Encode downlink data from incoming Rule Engine message
++
++// msg - JSON message payload downlink message json
++// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
++// metadata - list of key-value pairs with additional data about the message
++// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
++
++/** Encoder **/
++
++var data = {};
++
++// Process data from incoming message and metadata
++
++data.tempFreq = msg.temperatureUploadFrequency;
++data.humFreq = msg.humidityUploadFrequency;
++
++data.devSerialNumber = metadata['ss_serialNumber'];
++
++// Result object with encoded downlink payload
++var result = {
++
++    // downlink data content type: JSON, TEXT or BINARY (base64 format)
++    contentType: "JSON",
++
++    // downlink data
++    data: JSON.stringify(data),
++
++    // Optional metadata object presented in key/value format
++    metadata: {
++            topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
++    }
++
++};
++
++return result;
++{{/code}}
++
++
++Click on the **Add** button.
++
++
++
++[[image:add-downlink-data-converter.png||height="529" width="500"]]
++
++
++You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
++
++
++[[image:data-converters-list.png]]
++
++
++
  = 4. Add Integration =
@@ -360,6 +360,7 @@
  Click **Next** button.
++
  [[image:add-integration-basic-settings.png||height="511" width="500"]]
@@ -371,6 +371,7 @@
  Click **Next** button.
++
  [[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
@@ -382,18 +382,19 @@
  Click **Next** button.
++
  [[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
  **Connection:**
--* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
++* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.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: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
++* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
  * **QoS:** 0-At most once
  [[image:add-integration-connection.png||height="511" width="500"]]
@@ -438,24 +438,36 @@
  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.
++The Mosquitto client publishes messages on the topic v1/devices/[device_name]/telemetry. The [device_name]placeholder can be replaced with any device name, for example, 'S31B-NB'. Then, the MQTT topic would be v1/devices/S31B-NB/telemetry.
--(% 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.
++On the ThingsBoard side, we configure the MQTT topic subscription as v1/devices/+/telemetry. The + wildcard represents any device name and allows ThingsBoard to automatically create (provision) a device with that name, such as S31B-NB, for example.
++
++**The new device is created the first time the MQTT topic is received. For subsequent MQTT topics with the same device name, no duplicate devices will be created.**
++
++
++For example, if you send two MQTT messages with different device names in the topic:
++
++1. v1/devices/**S31B-NB**/telemetry
++1. v1/devices/**LDS25-NB**/telemetry
++
++ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
++
++
++The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
++
  {{code language="none"}}
--{"IMEI": "S31B-NB", "temperature": 27, ......}
++{"temperature":10.4, "humidity":85}
  {{/code}}
--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.
++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 10.4 and 85, 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}'
++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":10.4, "humidity":85}'
  {{/code}}
  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
@@ -467,49 +467,38 @@
  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]]
++[[image:device-provision-1.png]]
--== 5.3 Viewing messages ==
++Click on the device S31B-NB on the devices list to see its details.
++Then go to the **Latest telemetry** tab.
--Go back to the **Integrations** page.
++You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
--Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
--Click on the **Edit** button (//**pen icon**//).
++[[image:telemetry-1.png]]
--Click on the **Disabled** button in the upper-right corner.
--Turn on the **All messages (15 min)** option. This will enable displaying all messages in the **Events** tab. This setting will expire in 15 minutes, and you will need to repeat the same steps if you want to view the messages in the Events tab later.
++Now, change the values of the fields and send the MQTT message again. For example, set temperature to 20 and humidity to 70. Observe how the values update in //Latest Telemetry//.
--Click on the **Apply** button.
--Then click on the **Apply changes** (//**tick icon**//) button.
++[[image:telemetry-2.png]]
--[[image:Screenshot 2025-03-18 at 09.23.10.png]]
++Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
--Now go to the **Events** tab.
++{{code language="none"}}
++mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/LDS25-NB/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":11, "humidity":87}'
++{{/code}}
--Select the Event type as **Debug** from the dropdown list.
++Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
--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.
++[[image:device-provision-2.png]]
--[[image:Screenshot 2025-03-16 at 18.38.59.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-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.
@@ -518,11 +518,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 -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.
@@ -579,11 +579,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 -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 "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 -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 "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 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":18, "humidity":79}'
  {{/code}}
@@ -604,8 +604,8 @@
  **AT Commands**
  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
--* **AT+SUBTOPIC=<MQTT subscribe topic> **
--* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
++* **AT+SUBTOPIC=<MQTT topic>**
++* **AT+PUBTOPIC=<MQTT topic>**
  * **AT+CLIENT=null**
  * **AT+UNAME=<MQTT Username>**
  * **AT+PWD=<MQTT Password>**
@@ -612,11 +612,3 @@
  * **AT+SERVADDR=<Broker address, Port>**
  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**, and the device name is **861275077962896**, which is represented by the **IMEI**.
--
--[[image:image-4.png]]
--
--
--

Screenshot 2025-03-16 at 18.38.59.png

Author

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

Size

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

Content

Screenshot 2025-03-16 at 18.39.12.png

Author

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

Size

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

Content

Screenshot 2025-03-18 at 09.23.10.png

Author

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

Size

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

Content

add-integration-connection.png

Size

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

Content

image-4.png

Author

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

Size

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

Content

mqtt-uplink.png

Author

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

Size

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

Content

new-device.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation