Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 178.1
edited by Dilisi S
on 2025/03/27 01:16
Change comment: Uploaded new attachment "Screenshot 2025-03-26 at 18.15.08.png", version {1}
To version 191.1
edited by Dilisi S
on 2025/03/27 23:16
Change comment: Uploaded new attachment "integration-active.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -205,13 +205,32 @@
205 205  [[image:create-new-converter-menu.png||height="259" width="500"]]
206 206  
207 207  
208 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
208 +The **Add data converter** window will appear.
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 +
210 210  Click on the **TBEL** button if it has not been selected by default.
211 211  
212 -The default TBEL function is shown below.
214 +Modify the default TBEL function to match with your device as described below:
213 213  
214 214  
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 +
215 215  {{code language="JavaScript"}}
216 216  // Decode an uplink message from a buffer
217 217  // payload - array of bytes
... ... @@ -223,7 +223,7 @@
223 223  var payloadStr = decodeToString(payload);
224 224  
225 225  // decode payload to JSON
226 -// var data = decodeToJson(payload);
245 +var data = decodeToJson(payload);
227 227  
228 228  var deviceName = 'Device A';
229 229  var deviceType = 'thermostat';
... ... @@ -251,8 +251,8 @@
251 251   manufacturer: manufacturer
252 252   },
253 253   telemetry: {
254 - temperature: 42,
255 - humidity: 80,
273 + temperature: data.temperature,
274 + humidity: data.humidity,
256 256   rawData: payloadStr
257 257   }
258 258  };
... ... @@ -262,33 +262,21 @@
262 262  return result;
263 263  {{/code}}
264 264  
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.
266 266  
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 -
279 279  Once you modify the decoder function, click on the **Add** button.
280 280  
281 281  
282 -[[image:mqtt-uplink.png||width="500"]]
283 283  
289 +[[image:ul-data-converter-device-a.png||height="524" width="500"]]
284 284  
285 285  
286 286  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
287 287  
288 288  
289 -[[image:data-converter-list-showing-uplink-dc.png]]
295 +[[image:ul-data-converter-added.png||height="257"]]
290 290  
291 291  
298 +
292 292  = 5. Add Integration =
293 293  
294 294  
... ... @@ -309,7 +309,7 @@
309 309  **Basic settings:**
310 310  
311 311  * **Integration type**: MQTT
312 -* **Name**: MQTT integration NB/CB
319 +* **Name**: MQTT integration - Device A
313 313  * **Enable integration**: YES
314 314  * **Allows create devices or assets**: YES
315 315  
... ... @@ -316,9 +316,11 @@
316 316  Click **Next** button.
317 317  
318 318  
319 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
326 +[[image:add-integration-basic-settings.png||height="504" width="500"]]
320 320  
321 321  
329 +
330 +
322 322  **Uplink data converter:**
323 323  
324 324  * Click on the **Select existing** button.
... ... @@ -327,9 +327,10 @@
327 327  Click **Next** button.
328 328  
329 329  
330 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
339 +[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
331 331  
332 332  
342 +
333 333  **Downlink data converter:**
334 334  
335 335  Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
... ... @@ -345,18 +345,20 @@
345 345  
346 346  **Connection:**
347 347  
348 -* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
358 +* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
349 349  * **Port**: 8883
350 -* **Credentials**: Basic
351 -* **Enable SSL**: YES
360 +* **Credentials type**: Basic
352 352  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
353 353  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
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.)
363 +* **Enable SSL**: YES
364 +* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
355 355  * **QoS:** 0-At most once
356 356  
357 -[[image:add-integration-connection.png||height="511" width="500"]]
358 358  
359 359  
369 +[[image:add-integartion-connection.png||height="505" width="500"]]
370 +
371 +
360 360  Click on the **Advanced settings** button.
361 361  
362 362  * **Clean session:** YES
... ... @@ -395,15 +395,15 @@
395 395  
396 396  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.
397 397  
398 -The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
410 +The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
399 399  
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 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
401 401  
402 402  {{code language="none"}}
403 -{"IMEI": "S31B-NB", "temperature": 27, ......}
415 +{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
404 404  {{/code}}
405 405  
406 -Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
418 +Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
407 407  
408 408  
409 409  == 5.2 Sending messages ==
... ... @@ -412,7 +412,7 @@
412 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.
413 413  
414 414  {{code language="none"}}
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 +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}'
416 416  {{/code}}
417 417  
418 418  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -421,12 +421,8 @@
421 421  [[image:integration-active.png]]
422 422  
423 423  
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 425  
426 426  
427 -[[image:new-device.png]]
428 -
429 -
430 430  == 6.3 Viewing messages ==
431 431  
432 432  
... ... @@ -452,18 +452,22 @@
452 452  
453 453  Select the Event type as **Debug** from the dropdown list.
454 454  
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 +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.
456 456  
457 457  
458 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
466 +[[image:Screenshot 2025-03-26 at 19.49.31.png]]
459 459  
460 460  
469 +
470 +
461 461  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
462 462  
463 463  
464 -[[image:Screenshot 2025-03-16 at 18.39.12.png]]
474 +[[image:Screenshot 2025-03-26 at 19.47.52.png]]
465 465  
466 466  
477 +
478 +
467 467  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.
468 468  
469 469  
... ... @@ -581,4 +581,3 @@
581 581  [[image:image-4.png]]
582 582  
583 583  
584 -
add-integration-basic-settings.png
Size
... ... @@ -1,1 +1,1 @@
1 -122.5 KB
1 +123.8 KB
Content
integration-active.png
Size
... ... @@ -1,1 +1,1 @@
1 -64.2 KB
1 +64.1 KB
Content
Screenshot 2025-03-26 at 19.47.52.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +168.4 KB
Content
Screenshot 2025-03-26 at 19.49.31.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +133.0 KB
Content
add-integartion-connection.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +110.3 KB
Content
add-integartion-connetcion.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +146.0 KB
Content
add-integration-ul-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +121.2 KB
Content
integration-added.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +196.2 KB
Content
ul-data-converter-added.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +189.4 KB
Content
ul-data-converter-device-a.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +168.3 KB
Content