Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 193.1
edited by Dilisi S
on 2025/03/27 23:31
Change comment: Mar 27 edits - part 2
To version 179.1
edited by Dilisi S
on 2025/03/27 01:21
Change comment: There is no comment for this version

Summary

Details

Page properties
Content
... ... @@ -205,31 +205,29 @@
205 205  [[image:create-new-converter-menu.png||height="259" width="500"]]
206 206  
207 207  
208 -The **Add data converter** window will appear.
208 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
209 209  
210 -Let's create an uplink data converter for the device named '**Device A**'. Name it ‘**MQTT Uplink Converter - Device A**’ and select the Type as **Uplink**.
211 -
212 212  Click on the **TBEL** button if it has not been selected by default.
213 213  
214 214  Modify the default TBEL function to match with your device as described below:
215 215  
216 216  
217 -* Uncomment** line 11**:
215 +~1. Uncomment line 11:
218 218  
219 -//var data = decodeToJson(payload)//
217 +var data = decodeToJson(payload)
220 220  
219 +[[image:Screenshot 2025-03-26 at 18.15.08.png||height="219" width="500"]]
221 221  
222 -* **Line 13**: Assign your device name to the **deviceName** field. - We used **Device A** as it is to match with our device, **Device A **in the Devices section.
223 -* From **line 38**: Modify the telemetry section to allow parsed data to be assigned to the fields.
224 224  
225 -//telemetry: {
222 +3. Modify the telemetry section to allow parsed data to be assigned to the fields.
223 +
224 +telemetry: {
226 226   temperature: data.temperature,
227 227   humidity: data.humidity,
228 228   rawData: payloadStr
229 - }//
228 + }
230 230  
231 231  
232 -The modified uplink decoder function to match with **Device A** is shown below.
233 233  
234 234  {{code language="JavaScript"}}
235 235  // Decode an uplink message from a buffer
... ... @@ -244,7 +244,7 @@
244 244  // decode payload to JSON
245 245  var data = decodeToJson(payload);
246 246  
247 -var deviceName = 'Device A';
245 +var deviceName = 'Device B';
248 248  var deviceType = 'thermostat';
249 249  var customerName = 'Customer C';
250 250  var groupName = 'thermostat devices';
... ... @@ -281,21 +281,33 @@
281 281  return result;
282 282  {{/code}}
283 283  
282 +We use the same decoder function for all our devices. However, you need to modify a few things for each device. Among these, **deviceName** is a **mandatory** field. You should assign a device name to the **deviceName** field that matches the name of your device in the **Devices** section.
284 284  
284 +For example, if your device name is **Device B**, you can change **Device A** to **Device B**.
285 +
286 +
287 +{{code language="JavaScript"}}
288 +var deviceName = 'Device A';
289 +var deviceType = 'thermostat';
290 +var customerName = 'Customer C';
291 +var groupName = 'thermostat devices';
292 +var manufacturer = 'Example corporation';
293 +{{/code}}
294 +
295 +
285 285  Once you modify the decoder function, click on the **Add** button.
286 286  
287 287  
299 +[[image:mqtt-uplink.png||width="500"]]
288 288  
289 -[[image:ul-data-converter-device-a.png||height="524" width="500"]]
290 290  
291 291  
292 292  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
293 293  
294 294  
295 -[[image:ul-data-converter-added.png||height="257"]]
306 +[[image:data-converter-list-showing-uplink-dc.png]]
296 296  
297 297  
298 -
299 299  = 5. Add Integration =
300 300  
301 301  
... ... @@ -316,7 +316,7 @@
316 316  **Basic settings:**
317 317  
318 318  * **Integration type**: MQTT
319 -* **Name**: MQTT integration - Device A
329 +* **Name**: MQTT integration NB/CB
320 320  * **Enable integration**: YES
321 321  * **Allows create devices or assets**: YES
322 322  
... ... @@ -323,11 +323,9 @@
323 323  Click **Next** button.
324 324  
325 325  
326 -[[image:add-integration-basic-settings.png||height="504" width="500"]]
336 +[[image:add-integration-basic-settings.png||height="511" width="500"]]
327 327  
328 328  
329 -
330 -
331 331  **Uplink data converter:**
332 332  
333 333  * Click on the **Select existing** button.
... ... @@ -336,10 +336,9 @@
336 336  Click **Next** button.
337 337  
338 338  
339 -[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
347 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
340 340  
341 341  
342 -
343 343  **Downlink data converter:**
344 344  
345 345  Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
... ... @@ -355,19 +355,18 @@
355 355  
356 356  **Connection:**
357 357  
358 -* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
365 +* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
359 359  * **Port**: 8883
360 -* **Credentials type**: Basic
367 +* **Credentials**: Basic
368 +* **Enable SSL**: YES
361 361  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
362 362  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
363 -* **Enable SSL**: YES
364 -* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
371 +* **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 devices/a/telemetry.)
365 365  * **QoS:** 0-At most once
366 366  
374 +[[image:add-integration-connection.png||height="511" width="500"]]
367 367  
368 -[[image:add-integartion-connection.png||height="505" width="500"]]
369 369  
370 -
371 371  Click on the **Advanced settings** button.
372 372  
373 373  * **Clean session:** YES
... ... @@ -395,10 +395,9 @@
395 395  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
396 396  
397 397  
398 -[[image:integration-added.png]]
404 +[[image:new-integration-pending.png]]
399 399  
400 400  
401 -
402 402  = 6. Verifying the receipt of data from virtual devices =
403 403  
404 404  
... ... @@ -407,24 +407,24 @@
407 407  
408 408  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.
409 409  
410 -The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
415 +The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
411 411  
412 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
417 +(% 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.
413 413  
414 414  {{code language="none"}}
415 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
420 +{"IMEI": "S31B-NB", "temperature": 27, ......}
416 416  {{/code}}
417 417  
418 -Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
423 +Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
419 419  
420 420  
421 421  == 5.2 Sending messages ==
422 422  
423 423  
424 -On your computer's terminal, issue the following MQTT command which simulates the device '**Device A'**. The message payload contains the fields IMEI, temperature, humidity, and pressure, which hold the values 350693903995577, 30, 80, and 1005 respectively. This payload is also (technically) known as telemetry.
429 +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.
425 425  
426 426  {{code language="none"}}
427 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":30, "humidity":80, "pressure":1005}'
432 +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}'
428 428  {{/code}}
429 429  
430 430  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -433,6 +433,12 @@
433 433  [[image:integration-active.png]]
434 434  
435 435  
441 +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**.
442 +
443 +
444 +[[image:new-device.png]]
445 +
446 +
436 436  == 6.3 Viewing messages ==
437 437  
438 438  
... ... @@ -451,36 +451,25 @@
451 451  Then click on the **Apply changes** (//**tick icon**//) button.
452 452  
453 453  
454 -[[image:debug-enabled.png||height="301" width="700"]]
465 +[[image:Screenshot 2025-03-18 at 09.23.10.png]]
455 455  
456 456  
457 -
458 -
459 459  Now go to the **Events** tab.
460 460  
461 -Select the **Event type** as **Debug** from the dropdown list.
470 +Select the Event type as **Debug** from the dropdown list.
462 462  
463 -Publish another message (of course, you can repeat the previous message by pressing the UP arrow on your keyboard and then press Enter key) to your MQTT broker from your terminal, for example:
472 +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.
464 464  
465 -{{code language="none"}}
466 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":30, "humidity":80, "pressure":1005}'
467 -{{/code}}
468 468  
469 -Now you can see that uplink message in the **Events** tab (Click the **refresh** button if you didn't see any messages in the Events tab). The status should be **OK **if there is no errors in your integration.
475 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
470 470  
471 471  
472 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
473 -
474 -
475 -
476 476  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
477 477  
478 478  
479 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
481 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
480 480  
481 481  
482 -
483 -
484 484  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.
485 485  
486 486  
... ... @@ -596,3 +596,6 @@
596 596  {{/info}}
597 597  
598 598  [[image:image-4.png]]
599 +
600 +
601 +
Screenshot 2025-03-26 at 19.47.52.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -168.4 KB
Content
Screenshot 2025-03-26 at 19.49.31.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -133.0 KB
Content
add-integartion-connection.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -110.3 KB
Content
add-integartion-connetcion.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -146.0 KB
Content
add-integration-basic-settings.png
Size
... ... @@ -1,1 +1,1 @@
1 -123.8 KB
1 +122.5 KB
Content
add-integration-ul-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -121.2 KB
Content
debug-enabled.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -196.3 KB
Content
integration-active.png
Size
... ... @@ -1,1 +1,1 @@
1 -64.1 KB
1 +64.2 KB
Content
integration-added.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -196.2 KB
Content
ul-data-converter-added.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -189.4 KB
Content
ul-data-converter-device-a.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -168.3 KB
Content