Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 213.1
edited by Dilisi S
on 2025/04/21 18:23
Change comment: April 17 edits - part 2
To version 207.1
edited by Dilisi S
on 2025/04/21 17:00
Change comment: Uploaded new attachment "add-integration-4.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -288,7 +288,7 @@
288 288  **Basic settings:**
289 289  
290 290  * **Integration type**: MQTT
291 -* **Name**: MQTT integration
291 +* **Name**: MQTT integration - Device A
292 292  * **Enable integration**: YES
293 293  * **Allow create devices or assets**: YES
294 294  
... ... @@ -295,10 +295,11 @@
295 295  Click **Next** button.
296 296  
297 297  
298 +[[image:add-integration-basic-settings.png||height="504" width="500"]]
298 298  
299 -[[image:add-integration-part-1.png||height="483" width="500"]]
300 300  
301 301  
302 +
302 302  **Uplink data converter:**
303 303  
304 304  * Click on the **Select existing** button.
... ... @@ -307,8 +307,8 @@
307 307  Click **Next** button.
308 308  
309 309  
311 +[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
310 310  
311 -[[image:add-integration-part-2.png||height="484" width="500"]]
312 312  
313 313  
314 314  **Downlink data converter:**
... ... @@ -326,19 +326,18 @@
326 326  
327 327  **Connection:**
328 328  
329 -* **Host**: Host URL (Eg, **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
330 -* **Port**: 8883 (the port number may differ based on your MQTT broker)
330 +* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
331 +* **Port**: 8883
331 331  * **Credentials type**: Basic
332 332  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
333 333  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
334 334  * **Enable SSL**: YES
335 -* **Topic**: # (the # symbol indicates that it filters all topics).
336 +* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
336 336  * **QoS:** 0-At most once
337 337  
339 +[[image:add-integartion-connection.png||height="505" width="500"]]
338 338  
339 -[[image:add-integration-4.png||height="484" width="500"]]
340 340  
341 -
342 342  Click on the **Advanced settings** button.
343 343  
344 344  * **Clean session:** YES
... ... @@ -366,8 +366,8 @@
366 366  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
367 367  
368 368  
369 +[[image:integration-added.png]]
369 369  
370 -[[image:integrations-pending.png]]
371 371  
372 372  
373 373  = 5. Verifying the receipt of data from virtual devices =
... ... @@ -378,41 +378,32 @@
378 378  
379 379  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.
380 380  
381 -The Mosquitto client publishes messages (payloads) to a topic - for example, # or device/ts01-nb. You can, of course, use any topic you prefer.
381 +The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
382 382  
383 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
383 383  
384 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows. The **IMEI **and **Model **are mandatory fields. For other fields, you can use any number of key-value pairs.
385 -
386 386  {{code language="none"}}
387 -{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}
386 +{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
388 388  {{/code}}
389 389  
389 +Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
390 390  
391 +
391 391  == 5.2 Sending messages ==
392 392  
393 393  
394 -On your computer's terminal, issue the following MQTT command, which simulates the device named '**350693903995577'**. The message payload contains the fields IMEI, Model, temperature, humidity, and pressure, which hold the values 350693903995577,  TS01-NB, 30, 80, and 1005 respectively. This payload is also (technically) known as telemetry.
395 +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.
395 395  
396 396  {{code language="none"}}
397 -mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/350693903995577" -m '{"IMEI":"350693903995577", "Model":"TS01-NB", "temperature":30, "humidity":80, "pressure":1005}'
398 +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}'
398 398  {{/code}}
399 399  
400 -If the integration was performed without errors, a new device named **350693903995577 **is created in the **Devices **section.
401 +If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
401 401  
402 402  
403 -[[image:new-device-1.png]]
404 +[[image:integration-active.png]]
404 404  
405 405  
406 -The status of the integration also changes to '**Active**' after the first telemetry transmission.
407 -
408 -
409 -[[image:Screenshot 2025-04-21 122154.png]]
410 -
411 -
412 -
413 -**When ThingsBoard receives this message for the first time, it will automatically create a new device named '350693903995577' in the Devices section. The device name is based on the IMEI number. For subsequent messages with the same IMEI, no duplicate devices will be created. Each new IMEI number will result in a unique entry in the Devices section, representing a physical device.**
414 -
415 -
416 416  == 5.3 Viewing messages ==
417 417  
418 418  
Screenshot 2025-04-21 122154.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -21.2 KB
Content
device-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -34.5 KB
Content
integrations-pending.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -19.8 KB
Content
new-device-1.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -34.7 KB
Content