Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 194.1
edited by Dilisi S
on 2025/03/28 00:23
Change comment: Mar 27 edits - part 3
To version 177.1
edited by Dilisi S
on 2025/03/26 21:03
Change comment: Mar 26 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -170,7 +170,7 @@
170 170  First, you need to create devices in ThingsBoard to represent your physical devices. For example, you can name it **Device A**, and the second device could be **Device B** or any name you prefer. The device name should be unique within the **Devices** space.
171 171  
172 172  
173 -In the left navigation, click **Entities -> Devices**.
173 +In the left navigation, click Entities -> Devices.
174 174  
175 175  Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
176 176  
... ... @@ -205,32 +205,13 @@
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 -Modify the default TBEL function to match with your device as described below:
212 +The default TBEL function is shown below.
215 215  
216 216  
217 -* Uncomment** line 11**:
218 -
219 -//var data = decodeToJson(payload)//
220 -
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 -
225 -//telemetry: {
226 - temperature: data.temperature,
227 - humidity: data.humidity,
228 - rawData: payloadStr
229 - }//
230 -
231 -
232 -The modified uplink decoder function to match with **Device A** is shown below.
233 -
234 234  {{code language="JavaScript"}}
235 235  // Decode an uplink message from a buffer
236 236  // payload - array of bytes
... ... @@ -242,7 +242,7 @@
242 242  var payloadStr = decodeToString(payload);
243 243  
244 244  // decode payload to JSON
245 -var data = decodeToJson(payload);
226 +// var data = decodeToJson(payload);
246 246  
247 247  var deviceName = 'Device A';
248 248  var deviceType = 'thermostat';
... ... @@ -270,8 +270,8 @@
270 270   manufacturer: manufacturer
271 271   },
272 272   telemetry: {
273 - temperature: data.temperature,
274 - humidity: data.humidity,
254 + temperature: 42,
255 + humidity: 80,
275 275   rawData: payloadStr
276 276   }
277 277  };
... ... @@ -281,21 +281,33 @@
281 281  return result;
282 282  {{/code}}
283 283  
265 +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  
267 +For example, if your device name is **Device B**, you can change **Device A** to **Device B**.
268 +
269 +
270 +{{code language="JavaScript"}}
271 +var deviceName = 'Device A';
272 +var deviceType = 'thermostat';
273 +var customerName = 'Customer C';
274 +var groupName = 'thermostat devices';
275 +var manufacturer = 'Example corporation';
276 +{{/code}}
277 +
278 +
285 285  Once you modify the decoder function, click on the **Add** button.
286 286  
287 287  
282 +[[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"]]
289 +[[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
312 +* **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"]]
319 +[[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"]]
330 +[[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,16 +355,16 @@
355 355  
356 356  **Connection:**
357 357  
358 -* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
348 +* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
359 359  * **Port**: 8883
360 -* **Credentials type**: Basic
350 +* **Credentials**: Basic
351 +* **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.)
354 +* **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  
367 -[[image:add-integartion-connection.png||height="505" width="500"]]
357 +[[image:add-integration-connection.png||height="511" width="500"]]
368 368  
369 369  
370 370  Click on the **Advanced settings** button.
... ... @@ -394,10 +394,9 @@
394 394  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
395 395  
396 396  
397 -[[image:integration-added.png]]
387 +[[image:new-integration-pending.png]]
398 398  
399 399  
400 -
401 401  = 6. Verifying the receipt of data from virtual devices =
402 402  
403 403  
... ... @@ -406,24 +406,24 @@
406 406  
407 407  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.
408 408  
409 -The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
398 +The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
410 410  
411 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
400 +(% 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.
412 412  
413 413  {{code language="none"}}
414 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
403 +{"IMEI": "S31B-NB", "temperature": 27, ......}
415 415  {{/code}}
416 416  
417 -Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
406 +Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
418 418  
419 419  
420 420  == 5.2 Sending messages ==
421 421  
422 422  
423 -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.
412 +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.
424 424  
425 425  {{code language="none"}}
426 -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}'
415 +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}'
427 427  {{/code}}
428 428  
429 429  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -432,6 +432,12 @@
432 432  [[image:integration-active.png]]
433 433  
434 434  
424 +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**.
425 +
426 +
427 +[[image:new-device.png]]
428 +
429 +
435 435  == 6.3 Viewing messages ==
436 436  
437 437  
... ... @@ -450,36 +450,25 @@
450 450  Then click on the **Apply changes** (//**tick icon**//) button.
451 451  
452 452  
453 -[[image:debug-enabled.png||height="301" width="700"]]
448 +[[image:Screenshot 2025-03-18 at 09.23.10.png]]
454 454  
455 455  
456 -
457 -
458 458  Now go to the **Events** tab.
459 459  
460 -Select the **Event type** as **Debug** from the dropdown list.
453 +Select the Event type as **Debug** from the dropdown list.
461 461  
462 -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:
455 +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.
463 463  
464 -{{code language="none"}}
465 -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}'
466 -{{/code}}
467 467  
468 -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.
458 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
469 469  
470 470  
471 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
472 -
473 -
474 -
475 475  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
476 476  
477 477  
478 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
464 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
479 479  
480 480  
481 -
482 -
483 483  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.
484 484  
485 485  
... ... @@ -595,3 +595,6 @@
595 595  {{/info}}
596 596  
597 597  [[image:image-4.png]]
582 +
583 +
584 +
Screenshot 2025-03-26 at 18.15.08.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -92.2 KB
Content
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