Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 175.1
edited by Dilisi S
on 2025/03/20 16:51
Change comment: Mar 20 edits - part 2
To version 169.1
edited by Dilisi S
on 2025/03/19 04:17
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -192,9 +192,6 @@
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}}
198 198  
199 199  {{code language="JavaScript"}}
200 200  //Version: 0.1
... ... @@ -332,6 +332,72 @@
332 332  [[image:data-converter-list-showing-uplink-dc.png]]
333 333  
334 334  
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 +
335 335  = 4. Add Integration =
336 336  
337 337  
... ... @@ -375,17 +375,15 @@
375 375  
376 376  **Downlink data converter:**
377 377  
378 -Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
441 +* Click on the **Select existing** button.
442 +* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
379 379  
380 -* Click on the **Skip **button in the Downlink data converter section.
444 +Click **Next** button.
381 381  
382 -Click **Skip** button.
383 383  
447 +[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
384 384  
385 -[[image:integration-dl-skip.png||height="511" width="500"]]
386 386  
387 -
388 -
389 389  **Connection:**
390 390  
391 391  * **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
... ... @@ -394,11 +394,9 @@
394 394  * **Enable SSL**: YES
395 395  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
396 396  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
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.)
458 +* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
398 398  * **QoS:** 0-At most once
399 399  
400 -
401 -
402 402  [[image:add-integration-connection.png||height="511" width="500"]]
403 403  
404 404  
... ... @@ -429,6 +429,7 @@
429 429  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
430 430  
431 431  
491 +
432 432  [[image:new-integration-pending.png]]
433 433  
434 434  
... ... @@ -522,7 +522,8 @@
522 522  
523 523  First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
524 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}}
585 +{{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}'
586 +{{/code}}
526 526  
527 527  
528 528  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
... ... @@ -598,7 +598,7 @@
598 598  = 7. Configure NB-IoT Sensor =
599 599  
600 600  
601 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
662 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
602 602  
603 603  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
604 604  
... ... @@ -606,7 +606,7 @@
606 606  **AT Commands**
607 607  
608 608  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
609 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
670 +* **AT+SUBTOPIC=<MQTT subscribe topic> **
610 610  * **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
611 611  * **AT+CLIENT=null**
612 612  * **AT+UNAME=<MQTT Username>**
... ... @@ -614,15 +614,10 @@
614 614  * **AT+SERVADDR=<Broker address, Port>**
615 615  
616 616  Test your uplink by pressing the ACT button for 1 second.
617 -
618 618  
619 619  
620 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**.
621 621  
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 626  [[image:image-4.png]]
627 627  
628 628  
Screenshot 2025-03-16 at 18.39.12.png
Size
... ... @@ -1,1 +1,1 @@
1 -211.9 KB
1 +277.0 KB
Content
add-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -158.1 KB
1 +153.2 KB
Content
integration-dl-skip.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -105.5 KB
Content