Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 168.1
edited by Dilisi S
on 2025/03/19 03:40
Change comment: Uploaded new attachment "image-4.png", version {1}
To version 175.1
edited by Dilisi S
on 2025/03/20 16:51
Change comment: Mar 20 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -192,6 +192,9 @@
192 192  
193 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 194  
195 +{{info}}
196 +Please note that the value assigned to the IMEI field in the payload will be used by ThingsBoard to create a device on the platform with the same name.
197 +{{/info}}
195 195  
196 196  {{code language="JavaScript"}}
197 197  //Version: 0.1
... ... @@ -329,72 +329,6 @@
329 329  [[image:data-converter-list-showing-uplink-dc.png]]
330 330  
331 331  
332 -== 3.2 Downlink ==
333 -
334 -
335 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
336 -
337 -
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 -
398 398  = 4. Add Integration =
399 399  
400 400  
... ... @@ -438,15 +438,17 @@
438 438  
439 439  **Downlink data converter:**
440 440  
441 -* Click on the **Select existing** button.
442 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
378 +Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
443 443  
444 -Click **Next** button.
380 +* Click on the **Skip **button in the Downlink data converter section.
445 445  
382 +Click **Skip** button.
446 446  
447 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
448 448  
385 +[[image:integration-dl-skip.png||height="511" width="500"]]
449 449  
387 +
388 +
450 450  **Connection:**
451 451  
452 452  * **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -455,9 +455,11 @@
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)
397 +* **Topic: v1/devices/me/telemetry** (The topic can be anything; you can even use just the device name. For example, you can use your device name here, such as S31B-NB.)
459 459  * **QoS:** 0-At most once
460 460  
400 +
401 +
461 461  [[image:add-integration-connection.png||height="511" width="500"]]
462 462  
463 463  
... ... @@ -488,7 +488,6 @@
488 488  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
489 489  
490 490  
491 -
492 492  [[image:new-integration-pending.png]]
493 493  
494 494  
... ... @@ -535,7 +535,6 @@
535 535  == 5.3 Viewing messages ==
536 536  
537 537  
538 -
539 539  Go back to the **Integrations** page.
540 540  
541 541  Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
... ... @@ -558,7 +558,7 @@
558 558  
559 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
500 +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.
562 562  
563 563  
564 564  [[image:Screenshot 2025-03-16 at 18.38.59.png]]
... ... @@ -581,6 +581,11 @@
581 581  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.
582 582  
583 583  
523 +First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
524 +
525 +{{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}}
526 +
527 +
584 584  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
585 585  
586 586  
... ... @@ -637,11 +637,11 @@
637 637  
638 638  
639 639  {{code language="none"}}
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}'
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": 22, "humidity":70}'
641 641  
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}'
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": 27, "humidity":72}'
643 643  
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}'
588 +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}'
645 645  
646 646  {{/code}}
647 647  
... ... @@ -654,7 +654,7 @@
654 654  = 7. Configure NB-IoT Sensor =
655 655  
656 656  
657 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
601 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
658 658  
659 659  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
660 660  
... ... @@ -662,8 +662,8 @@
662 662  **AT Commands**
663 663  
664 664  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
665 -* **AT+SUBTOPIC=<MQTT topic>**
666 -* **AT+PUBTOPIC=<MQTT topic>**
609 +* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
610 +* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
667 667  * **AT+CLIENT=null**
668 668  * **AT+UNAME=<MQTT Username>**
669 669  * **AT+PWD=<MQTT Password>**
... ... @@ -670,7 +670,16 @@
670 670  * **AT+SERVADDR=<Broker address, Port>**
671 671  
672 672  Test your uplink by pressing the ACT button for 1 second.
617 +
673 673  
674 674  
620 +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**.
675 675  
622 +{{info}}
623 +The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
624 +{{/info}}
625 +
626 +[[image:image-4.png]]
627 +
628 +
676 676  
Screenshot 2025-03-16 at 18.39.12.png
Size
... ... @@ -1,1 +1,1 @@
1 -277.0 KB
1 +211.9 KB
Content
add-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -153.2 KB
1 +158.1 KB
Content
integration-dl-skip.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +105.5 KB
Content