Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
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 158.1
edited by Dilisi S
on 2025/03/18 03:15
Change comment: Uploaded new attachment "add-integration-connection.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -329,10 +329,72 @@
329 329  [[image:data-converter-list-showing-uplink-dc.png]]
330 330  
331 331  
332 +== 3.2 Downlink ==
332 332  
333 333  
335 +On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
334 334  
335 335  
338 +[[image:create-new-converter-menu.png||width="500"]]
339 +
340 +
341 +
342 +The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
343 +
344 +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.
345 +
346 +
347 +{{code language="JavaScript"}}
348 +// Encode downlink data from incoming Rule Engine message
349 +
350 +// msg - JSON message payload downlink message json
351 +// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
352 +// metadata - list of key-value pairs with additional data about the message
353 +// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
354 +
355 +/** Encoder **/
356 +
357 +var data = {};
358 +
359 +// Process data from incoming message and metadata
360 +
361 +data.tempFreq = msg.temperatureUploadFrequency;
362 +data.humFreq = msg.humidityUploadFrequency;
363 +
364 +data.devSerialNumber = metadata['ss_serialNumber'];
365 +
366 +// Result object with encoded downlink payload
367 +var result = {
368 +
369 + // downlink data content type: JSON, TEXT or BINARY (base64 format)
370 + contentType: "JSON",
371 +
372 + // downlink data
373 + data: JSON.stringify(data),
374 +
375 + // Optional metadata object presented in key/value format
376 + metadata: {
377 + topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
378 + }
379 +
380 +};
381 +
382 +return result;
383 +{{/code}}
384 +
385 +
386 +Click on the **Add** button.
387 +
388 +
389 +[[image:add-downlink-data-converter.png||height="529" width="500"]]
390 +
391 +
392 +You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
393 +
394 +
395 +[[image:data-converters-list.png]]
396 +
397 +
336 336  = 4. Add Integration =
337 337  
338 338  
... ... @@ -438,24 +438,36 @@
438 438  
439 439  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.
440 440  
441 -The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
503 +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.
442 442  
443 -(% 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.
505 +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.
444 444  
507 +
508 +**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.**
509 +
510 +
511 +For example, if you send two MQTT messages with different device names in the topic:
512 +
513 +1. v1/devices/**S31B-NB**/telemetry
514 +1. v1/devices/**LDS25-NB**/telemetry
515 +
516 +ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
517 +
518 +
519 +The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
520 +
445 445  {{code language="none"}}
446 -{"IMEI": "S31B-NB", "temperature": 27, ......}
522 +{"temperature":10.4, "humidity":85}
447 447  {{/code}}
448 448  
449 -Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
450 450  
451 -
452 452  == 5.2 Sending messages ==
453 453  
454 454  
455 -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.
529 +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.
456 456  
457 457  {{code language="none"}}
458 -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}'
532 +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}'
459 459  {{/code}}
460 460  
461 461  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -467,49 +467,38 @@
467 467  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**.
468 468  
469 469  
470 -[[image:new-device.png]]
544 +[[image:device-provision-1.png]]
471 471  
472 472  
473 -== 5.3 Viewing messages ==
547 +Click on the device S31B-NB on the devices list to see its details.
474 474  
549 +Then go to the **Latest telemetry** tab.
475 475  
476 -Go back to the **Integrations** page.
551 +You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
477 477  
478 -Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
479 479  
480 -Click on the **Edit** button (//**pen icon**//).
554 +[[image:telemetry-1.png]]
481 481  
482 -Click on the **Disabled** button in the upper-right corner.
483 483  
484 -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.
557 +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//.
485 485  
486 -Click on the **Apply** button.
487 487  
488 -Then click on the **Apply changes** (//**tick icon**//) button.
560 +[[image:telemetry-2.png]]
489 489  
490 490  
491 -[[image:Screenshot 2025-03-18 at 09.23.10.png]]
563 +Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
492 492  
493 493  
494 -Now go to the **Events** tab.
566 +{{code language="none"}}
567 +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}'
568 +{{/code}}
495 495  
496 -Select the Event type as **Debug** from the dropdown list.
570 +Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
497 497  
498 -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.
499 499  
573 +[[image:device-provision-2.png]]
500 500  
501 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
502 502  
503 -
504 -Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
505 -
506 -
507 -[[image:Screenshot 2025-03-16 at 18.39.12.png]]
508 -
509 -
510 -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.
511 -
512 -
513 513  = 6. Creating a Dashboard =
514 514  
515 515  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 @@
518 518  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.
519 519  
520 520  
521 -First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
522 -
523 -{{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}}
524 -
525 -
526 526  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
527 527  
528 528  
... ... @@ -579,11 +579,11 @@
579 579  
580 580  
581 581  {{code language="none"}}
582 -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}'
640 +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}'
583 583  
584 -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}'
642 +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}'
585 585  
586 -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}'
644 +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}'
587 587  
588 588  {{/code}}
589 589  
... ... @@ -604,8 +604,8 @@
604 604  **AT Commands**
605 605  
606 606  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
607 -* **AT+SUBTOPIC=<MQTT subscribe topic> **
608 -* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
665 +* **AT+SUBTOPIC=<MQTT topic>**
666 +* **AT+PUBTOPIC=<MQTT topic>**
609 609  * **AT+CLIENT=null**
610 610  * **AT+UNAME=<MQTT Username>**
611 611  * **AT+PWD=<MQTT Password>**
... ... @@ -612,11 +612,3 @@
612 612  * **AT+SERVADDR=<Broker address, Port>**
613 613  
614 614  Test your uplink by pressing the ACT button for 1 second.
615 -
616 -
617 -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**.
618 -
619 -[[image:image-4.png]]
620 -
621 -
622 -
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
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