Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 167.1
edited by Dilisi S
on 2025/03/19 03:36
Change comment: There is no comment for this version
To version 156.1
edited by Dilisi S
on 2025/03/17 00:34
Change comment: Uploaded new attachment "mqtt-uplink.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -67,6 +67,7 @@
67 67  [[image:thingsboard-6.png||height="244" width="500"]]
68 68  
69 69  
70 +(% class="wikigeneratedid" %)
70 70  == 2.2 HiveMQ Cloud ==
71 71  
72 72  === 2.2.1 HiveMQ Cloud ===
... ... @@ -176,6 +176,7 @@
176 176  In the left navigation, click **Integrations center**, and then click **Data converters**.
177 177  
178 178  
180 +
179 179  [[image:data-converters-list-empty.png]]
180 180  
181 181  
... ... @@ -188,130 +188,34 @@
188 188  
189 189  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
190 190  
191 -Click on the **JavaScript** button.
193 +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.
192 192  
193 -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.
194 -
195 -
196 196  {{code language="JavaScript"}}
197 -//Version: 0.1
196 +/** Decoder **/
197 +
198 198  // decode payload to string
199 199  var payloadStr = decodeToString(payload);
200 +var data = JSON.parse(payloadStr);
200 200  
202 +var deviceName = metadata.topic.split("/")[3];
201 201  // decode payload to JSON
202 -var objdata = {};
203 -var obj1 = {};
204 -var data = decodeToJson(payload);
205 -var deviceName = data.IMEI;
206 -delete data.IMEI;
207 -var modelname = "Dragino " + data.Model;
208 -//var mod = data.mod
209 -delete data.Model;
210 -//delete data.mod
211 -var timestamp = new Date().getTime();
204 +var deviceType = 'sensor';
212 212  
213 -for (var key in data) {
214 -
215 - if (Number(key)) {
216 - obj1[key] = data[key];
217 - obj1[key][obj1[key].length - 1] = Number(new Date(
218 - obj1[key][obj1[key].length - 1]));
219 -
220 - }
221 -//Alec submitted25/02/25
222 -//turn old key into new
223 - else if (key === "Reading") {
224 - objdata["reading"] = data[key];
225 - } else if (key === "work mode") {
226 - objdata["work_mode"] = data[key];
227 - } else if (key === "hum") {
228 - objdata["humidity"] = data[key];
229 - }else if (key === "hum2") {
230 - objdata["humidity2"] = data[key];
231 - } else if (key === "hum3") {
232 - objdata["humidity3"] = data[key];
233 - } else if (key === "tem") {
234 - objdata["temperature"] = data[key];
235 - } else if (key === "tem2") {
236 - objdata["temperature2"] = data[key];
237 - } else if (key === "tem3") {
238 - objdata["temperature3"] = data[key];
239 - } else if (key === "DS18B20_Temp") {
240 - objdata["temperature_pro"] = data[key];
241 - } else if (key === "ds18b20_temperature") {
242 - objdata["temperature_pro"] = data[key];
243 - } else if (key === "DS18B20_temperature_pro") {
244 - objdata["temperature_pro"] = data[key];
245 - } else if (key === "tdc send flag") {
246 - objdata["tdc_send_flag"] = data[key];
247 - } else if (key === "trigger mode") {
248 - objdata["trigger_mode"] = data[key];
249 - } else if (key === "soil dielectric constant") {
250 - objdata["soil_dielectric_constant"] = data[key];
251 - } else if (key === "door open num") {
252 - objdata["door_open_num"] = data[key];
253 - } else if (key === "door duration") {
254 - objdata["door_duration"] = data[key];
255 - } else if (key === "count time") {
256 - objdata["count_time"] = data[key];
257 - } else if (key === "last open time2") {
258 - objdata["last_open_time2"] = data[key];
259 - } else if (key === "last open time3") {
260 - objdata["last_open_time3"] = data[key];
261 - }
262 -//Alec submitted25/02/25
263 - else {
264 - objdata[key] = data[key]
265 - }
266 -}
267 -var listdata = [{
268 - "ts": timestamp,
269 - "values": objdata
270 -}]
271 -for (var key1 in obj1) {
272 - if (modelname == "Dragino RS485-NB") {
273 - listdata.push({
274 - "ts": obj1[key1][obj1[key1].length - 1],
275 - "values": {
276 - "Payload": obj1[key1][0],
277 - }
278 - })
279 - } else {
280 - listdata.push({
281 - "ts": obj1[key1][obj1[key1].length - 1],
282 - "values": {
283 - "values": obj1[key1]
284 - },
285 - })
286 - }
287 -}
206 +// Result object with device attributes/telemetry data
288 288  var result = {
289 -
290 290   deviceName: deviceName,
291 - deviceType: modelname,
209 + deviceType: deviceType,
292 292   attributes: {
293 - model: modelname,
294 - //customerName: "NB-CB",
295 - //groupName: "NB-CB",
296 - //integrationName: metadata['integrationName']
297 -
211 + integrationName: metadata['integrationName'],
298 298   },
299 - telemetry: listdata
300 -}
213 + telemetry: {
214 + temperature: data.temperature,
215 + humidity: data.humidity,
216 + }
217 +};
301 301  
302 -function decodeToString(payload) {
303 - return String.fromCharCode.apply(String, payload);
304 -}
219 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
305 305  
306 -function decodeToJson(payload) {
307 - // covert payload to string.
308 - var str = decodeToString(payload);
309 -
310 - // parse string to JSON
311 - var data = JSON.parse(str);
312 - return data;
313 -}
314 -
315 315  return result;
316 316  {{/code}}
317 317  
... ... @@ -319,16 +319,16 @@
319 319  Click on the **Add** button.
320 320  
321 321  
322 -[[image:mqtt-uplink.png||width="500"]]
323 323  
229 +[[image:add-uplink-data-converter.png||height="529" width="500"]]
324 324  
325 325  
326 326  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
327 327  
328 -
329 329  [[image:data-converter-list-showing-uplink-dc.png]]
330 330  
331 331  
237 +
332 332  == 3.2 Downlink ==
333 333  
334 334  
... ... @@ -386,6 +386,7 @@
386 386  Click on the **Add** button.
387 387  
388 388  
295 +
389 389  [[image:add-downlink-data-converter.png||height="529" width="500"]]
390 390  
391 391  
... ... @@ -395,6 +395,7 @@
395 395  [[image:data-converters-list.png]]
396 396  
397 397  
305 +
398 398  = 4. Add Integration =
399 399  
400 400  
... ... @@ -422,6 +422,7 @@
422 422  Click **Next** button.
423 423  
424 424  
333 +
425 425  [[image:add-integration-basic-settings.png||height="511" width="500"]]
426 426  
427 427  
... ... @@ -433,6 +433,7 @@
433 433  Click **Next** button.
434 434  
435 435  
345 +
436 436  [[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
437 437  
438 438  
... ... @@ -444,18 +444,19 @@
444 444  Click **Next** button.
445 445  
446 446  
357 +
447 447  [[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
448 448  
449 449  
450 450  **Connection:**
451 451  
452 -* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
363 +* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
453 453  * **Port**: 8883
454 454  * **Credentials**: Basic
455 455  * **Enable SSL**: YES
456 456  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
457 457  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
458 -* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
369 +* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
459 459  * **QoS:** 0-At most once
460 460  
461 461  [[image:add-integration-connection.png||height="511" width="500"]]
... ... @@ -500,24 +500,36 @@
500 500  
501 501  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.
502 502  
503 -The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
414 +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.
504 504  
505 -(% 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.
416 +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.
506 506  
418 +
419 +**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.**
420 +
421 +
422 +For example, if you send two MQTT messages with different device names in the topic:
423 +
424 +1. v1/devices/**S31B-NB**/telemetry
425 +1. v1/devices/**LDS25-NB**/telemetry
426 +
427 +ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
428 +
429 +
430 +The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
431 +
507 507  {{code language="none"}}
508 -{"IMEI": "S31B-NB", "temperature": 27, ......}
433 +{"temperature":10.4, "humidity":85}
509 509  {{/code}}
510 510  
511 -Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
512 512  
513 -
514 514  == 5.2 Sending messages ==
515 515  
516 516  
517 -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.
440 +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.
518 518  
519 519  {{code language="none"}}
520 -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}'
443 +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}'
521 521  {{/code}}
522 522  
523 523  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -529,50 +529,38 @@
529 529  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**.
530 530  
531 531  
532 -[[image:new-device.png]]
455 +[[image:device-provision-1.png]]
533 533  
534 534  
535 -== 5.3 Viewing messages ==
458 +Click on the device S31B-NB on the devices list to see its details.
536 536  
460 +Then go to the **Latest telemetry** tab.
537 537  
462 +You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
538 538  
539 -Go back to the **Integrations** page.
540 540  
541 -Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
465 +[[image:telemetry-1.png]]
542 542  
543 -Click on the **Edit** button (//**pen icon**//).
544 544  
545 -Click on the **Disabled** button in the upper-right corner.
468 +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//.
546 546  
547 -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.
548 548  
549 -Click on the **Apply** button.
471 +[[image:telemetry-2.png]]
550 550  
551 -Then click on the **Apply changes** (//**tick icon**//) button.
552 552  
474 +Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
553 553  
554 -[[image:Screenshot 2025-03-18 at 09.23.10.png]]
555 555  
477 +{{code language="none"}}
478 +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}'
479 +{{/code}}
556 556  
557 -Now go to the **Events** tab.
481 +Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
558 558  
559 -Select the Event type as **Debug** from the dropdown list.
560 560  
561 -Now you can see all the Uplink messages you are simulating through the MQTT broker. The status should
484 +[[image:device-provision-2.png]]
562 562  
563 563  
564 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
565 -
566 -
567 -Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
568 -
569 -
570 -[[image:Screenshot 2025-03-16 at 18.39.12.png]]
571 -
572 -
573 -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.
574 -
575 -
576 576  = 6. Creating a Dashboard =
577 577  
578 578  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.
... ... @@ -670,7 +670,3 @@
670 670  * **AT+SERVADDR=<Broker address, Port>**
671 671  
672 672  Test your uplink by pressing the ACT button for 1 second.
673 -
674 -
675 -
676 -
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 @@
1 -153.2 KB
1 +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
new-device.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -143.3 KB
Content