Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 170.1
edited by Dilisi S
on 2025/03/19 21:00
Change comment: There is no comment for this version
To version 194.1
edited by Dilisi S
on 2025/03/28 00:23
Change comment: Mar 27 edits - part 3

Summary

Details

Page properties
Content
... ... @@ -164,13 +164,32 @@
164 164  [[image:ins1.png||height="310" width="500"]]
165 165  
166 166  
167 -= 3. Data Converters =
167 += 3. Creating Devices =
168 168  
169 169  
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 +
172 +
173 +In the left navigation, click **Entities -> Devices**.
174 +
175 +Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
176 +
177 +In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
178 +
179 +Click the **Add** button.
180 +
181 +Skip the **connectivity testing** by clicking the **Close** button.
182 +
183 +The device is created and listed on the **Devices** page. Note that its initial state is **Inactive** because it has not received any data yet.
184 +
185 +
186 += 4. Data Converters =
187 +
188 +
170 170  In **ThingsBoard**, **Data Converters** are components used to transform incoming or outgoing data between different formats, typically to convert raw telemetry data from devices into a structured format that ThingsBoard can understand, or vice versa.
171 171  
172 172  
173 -== 3.1 Uplink ==
192 +== 4.1 Uplink ==
174 174  
175 175  
176 176  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -186,156 +186,100 @@
186 186  [[image:create-new-converter-menu.png||height="259" width="500"]]
187 187  
188 188  
189 -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.
190 190  
191 -Click on the **JavaScript** button.
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**.
192 192  
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.
212 +Click on the **TBEL** button if it has not been selected by default.
194 194  
214 +Modify the default TBEL function to match with your device as described below:
195 195  
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 +
196 196  {{code language="JavaScript"}}
197 -//Version: 0.1
235 +// Decode an uplink message from a buffer
236 +// payload - array of bytes
237 +// metadata - key/value object
238 +
239 +/** Decoder **/
240 +
198 198  // decode payload to string
199 199  var payloadStr = decodeToString(payload);
200 200  
201 201  // decode payload to JSON
202 -var objdata = {};
203 -var obj1 = {};
204 204  var data = decodeToJson(payload);
205 -var deviceName = data.IMEI;
206 -delete data.IMEI;
207 -var modelname = "Dragino " + data.Model;
208 -//var mod = data.mod
209 -delete data.Model;
210 -//delete data.mod
211 -var timestamp = new Date().getTime();
212 212  
213 -for (var key in data) {
214 -
215 - if (Number(key)) {
216 - obj1[key] = data[key];
217 - obj1[key][obj1[key].length - 1] = Number(new Date(
218 - obj1[key][obj1[key].length - 1]));
247 +var deviceName = 'Device A';
248 +var deviceType = 'thermostat';
249 +var customerName = 'Customer C';
250 +var groupName = 'thermostat devices';
251 +var manufacturer = 'Example corporation';
252 +// use assetName and assetType instead of deviceName and deviceType
253 +// to automatically create assets instead of devices.
254 +// var assetName = 'Asset A';
255 +// var assetType = 'building';
219 219  
220 - }
221 -//Alec submitted25/02/25
222 -//turn old key into new
223 - else if (key === "Reading") {
224 - objdata["reading"] = data[key];
225 - } else if (key === "work mode") {
226 - objdata["work_mode"] = data[key];
227 - } else if (key === "hum") {
228 - objdata["humidity"] = data[key];
229 - }else if (key === "hum2") {
230 - objdata["humidity2"] = data[key];
231 - } else if (key === "hum3") {
232 - objdata["humidity3"] = data[key];
233 - } else if (key === "tem") {
234 - objdata["temperature"] = data[key];
235 - } else if (key === "tem2") {
236 - objdata["temperature2"] = data[key];
237 - } else if (key === "tem3") {
238 - objdata["temperature3"] = data[key];
239 - } else if (key === "DS18B20_Temp") {
240 - objdata["temperature_pro"] = data[key];
241 - } else if (key === "ds18b20_temperature") {
242 - objdata["temperature_pro"] = data[key];
243 - } else if (key === "DS18B20_temperature_pro") {
244 - objdata["temperature_pro"] = data[key];
245 - } else if (key === "tdc send flag") {
246 - objdata["tdc_send_flag"] = data[key];
247 - } else if (key === "trigger mode") {
248 - objdata["trigger_mode"] = data[key];
249 - } else if (key === "soil dielectric constant") {
250 - objdata["soil_dielectric_constant"] = data[key];
251 - } else if (key === "door open num") {
252 - objdata["door_open_num"] = data[key];
253 - } else if (key === "door duration") {
254 - objdata["door_duration"] = data[key];
255 - } else if (key === "count time") {
256 - objdata["count_time"] = data[key];
257 - } else if (key === "last open time2") {
258 - objdata["last_open_time2"] = data[key];
259 - } else if (key === "last open time3") {
260 - objdata["last_open_time3"] = data[key];
261 - }
262 -//Alec submitted25/02/25
263 - else {
264 - objdata[key] = data[key]
265 - }
266 -}
267 -var listdata = [{
268 - "ts": timestamp,
269 - "values": objdata
270 -}]
271 -for (var key1 in obj1) {
272 - if (modelname == "Dragino RS485-NB") {
273 - listdata.push({
274 - "ts": obj1[key1][obj1[key1].length - 1],
275 - "values": {
276 - "Payload": obj1[key1][0],
277 - }
278 - })
279 - } else {
280 - listdata.push({
281 - "ts": obj1[key1][obj1[key1].length - 1],
282 - "values": {
283 - "values": obj1[key1]
284 - },
285 - })
286 - }
287 -}
257 +// Result object with device/asset attributes/telemetry data
288 288  var result = {
259 +// Use deviceName and deviceType or assetName and assetType, but not both.
260 + deviceName: deviceName,
261 + deviceType: deviceType,
262 +// assetName: assetName,
263 +// assetType: assetType,
264 +// customerName: customerName,
265 + groupName: groupName,
266 + attributes: {
267 + model: 'Model A',
268 + serialNumber: 'SN111',
269 + integrationName: metadata['integrationName'],
270 + manufacturer: manufacturer
271 + },
272 + telemetry: {
273 + temperature: data.temperature,
274 + humidity: data.humidity,
275 + rawData: payloadStr
276 + }
277 +};
289 289  
290 - deviceName: deviceName,
291 - deviceType: modelname,
292 - attributes: {
293 - model: modelname,
294 - //customerName: "NB-CB",
295 - //groupName: "NB-CB",
296 - //integrationName: metadata['integrationName']
279 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
297 297  
298 - },
299 - telemetry: listdata
300 -}
301 -
302 -function decodeToString(payload) {
303 - return String.fromCharCode.apply(String, payload);
304 -}
305 -
306 -function decodeToJson(payload) {
307 - // covert payload to string.
308 - var str = decodeToString(payload);
309 -
310 - // parse string to JSON
311 - var data = JSON.parse(str);
312 - return data;
313 -}
314 -
315 315  return result;
316 316  {{/code}}
317 317  
318 318  
319 -Click on the **Add** button.
285 +Once you modify the decoder function, click on the **Add** button.
320 320  
321 321  
322 -[[image:mqtt-uplink.png||width="500"]]
323 323  
289 +[[image:ul-data-converter-device-a.png||height="524" width="500"]]
324 324  
325 325  
326 326  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
327 327  
328 328  
329 -[[image:data-converter-list-showing-uplink-dc.png]]
295 +[[image:ul-data-converter-added.png||height="257"]]
330 330  
331 331  
332 332  
299 += 5. Add Integration =
333 333  
334 334  
335 -
336 -= 4. Add Integration =
337 -
338 -
339 339  In the left navigation, click **Integrations center**, and then click **Integrations**.
340 340  
341 341  
... ... @@ -353,7 +353,7 @@
353 353  **Basic settings:**
354 354  
355 355  * **Integration type**: MQTT
356 -* **Name**: MQTT integration NB/CB
319 +* **Name**: MQTT integration - Device A
357 357  * **Enable integration**: YES
358 358  * **Allows create devices or assets**: YES
359 359  
... ... @@ -360,9 +360,11 @@
360 360  Click **Next** button.
361 361  
362 362  
363 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
326 +[[image:add-integration-basic-settings.png||height="504" width="500"]]
364 364  
365 365  
329 +
330 +
366 366  **Uplink data converter:**
367 367  
368 368  * Click on the **Select existing** button.
... ... @@ -371,32 +371,35 @@
371 371  Click **Next** button.
372 372  
373 373  
374 -[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
339 +[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
375 375  
376 376  
342 +
377 377  **Downlink data converter:**
378 378  
379 -* Click on the **Select existing** button.
380 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
345 +Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
381 381  
382 -Click **Next** button.
347 +* Click on the **Skip **button in the Downlink data converter section.
383 383  
349 +Click **Skip** button.
384 384  
385 -[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
386 386  
352 +[[image:integration-dl-skip.png||height="511" width="500"]]
387 387  
354 +
355 +
388 388  **Connection:**
389 389  
390 -* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
358 +* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
391 391  * **Port**: 8883
392 -* **Credentials**: Basic
393 -* **Enable SSL**: YES
360 +* **Credentials type**: Basic
394 394  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
395 395  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
396 -* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
363 +* **Enable SSL**: YES
364 +* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
397 397  * **QoS:** 0-At most once
398 398  
399 -[[image:add-integration-connection.png||height="511" width="500"]]
367 +[[image:add-integartion-connection.png||height="505" width="500"]]
400 400  
401 401  
402 402  Click on the **Advanced settings** button.
... ... @@ -426,36 +426,36 @@
426 426  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
427 427  
428 428  
397 +[[image:integration-added.png]]
429 429  
430 -[[image:new-integration-pending.png]]
431 431  
432 432  
433 -= 5. Verifying the receipt of data from virtual devices =
401 += 6. Verifying the receipt of data from virtual devices =
434 434  
435 435  
436 -== 5.1 How does it work? ==
404 +== 6.1 How does it work? ==
437 437  
438 438  
439 439  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.
440 440  
441 -The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
409 +The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
442 442  
443 -(% 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.
411 +(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
444 444  
445 445  {{code language="none"}}
446 -{"IMEI": "S31B-NB", "temperature": 27, ......}
414 +{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
447 447  {{/code}}
448 448  
449 -Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
417 +Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
450 450  
451 451  
452 452  == 5.2 Sending messages ==
453 453  
454 454  
455 -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.
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.
456 456  
457 457  {{code language="none"}}
458 -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}'
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}'
459 459  {{/code}}
460 460  
461 461  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -464,15 +464,9 @@
464 464  [[image:integration-active.png]]
465 465  
466 466  
467 -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**.
435 +== 6.3 Viewing messages ==
468 468  
469 469  
470 -[[image:new-device.png]]
471 -
472 -
473 -== 5.3 Viewing messages ==
474 -
475 -
476 476  Go back to the **Integrations** page.
477 477  
478 478  Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
... ... @@ -488,29 +488,40 @@
488 488  Then click on the **Apply changes** (//**tick icon**//) button.
489 489  
490 490  
491 -[[image:Screenshot 2025-03-18 at 09.23.10.png]]
453 +[[image:debug-enabled.png||height="301" width="700"]]
492 492  
493 493  
456 +
457 +
494 494  Now go to the **Events** tab.
495 495  
496 -Select the Event type as **Debug** from the dropdown list.
460 +Select the **Event type** as **Debug** from the dropdown list.
497 497  
498 -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.
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:
499 499  
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}}
500 500  
501 -[[image:Screenshot 2025-03-16 at 18.38.59.png]]
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.
502 502  
503 503  
471 +[[image:Screenshot 2025-03-26 at 19.49.31.png]]
472 +
473 +
474 +
504 504  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
505 505  
506 506  
507 -[[image:Screenshot 2025-03-16 at 18.39.12.png]]
478 +[[image:Screenshot 2025-03-26 at 19.47.52.png]]
508 508  
509 509  
481 +
482 +
510 510  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.
511 511  
512 512  
513 -= 6. Creating a Dashboard =
486 += 7. Creating a Dashboard =
514 514  
515 515  ThingsBoard **Dashboards** provide a powerful way to visualize and monitor real-time and historical data from connected devices. They allow users to create interactive, customizable panels displaying telemetry data, device status, and other key metrics. With a variety of widgets, including charts, maps, and tables, dashboards help users gain insights, track trends, and manage IoT deployments efficiently.
516 516  
... ... @@ -593,10 +593,10 @@
593 593  [[image:timeseries-4.png||height="316" width="700"]]
594 594  
595 595  
596 -= 7. Configure NB-IoT Sensor =
569 += 8. Configure NB-IoT Sensor =
597 597  
598 598  
599 -Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-NB**.
572 +Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
600 600  
601 601  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
602 602  
... ... @@ -604,7 +604,7 @@
604 604  **AT Commands**
605 605  
606 606  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
607 -* **AT+SUBTOPIC=<MQTT subscribe topic> **
580 +* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
608 608  * **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
609 609  * **AT+CLIENT=null**
610 610  * **AT+UNAME=<MQTT Username>**
... ... @@ -612,11 +612,13 @@
612 612  * **AT+SERVADDR=<Broker address, Port>**
613 613  
614 614  Test your uplink by pressing the ACT button for 1 second.
588 +
615 615  
616 616  
617 617  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**.
618 618  
619 -[[image:image-4.png]]
593 +{{info}}
594 +The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
595 +{{/info}}
620 620  
621 -
622 -
597 +[[image:image-4.png]]
Screenshot 2025-03-16 at 18.39.12.png
Size
... ... @@ -1,1 +1,1 @@
1 -277.0 KB
1 +211.9 KB
Content
add-integration-basic-settings.png
Size
... ... @@ -1,1 +1,1 @@
1 -122.5 KB
1 +123.8 KB
Content
add-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -153.2 KB
1 +158.1 KB
Content
integration-active.png
Size
... ... @@ -1,1 +1,1 @@
1 -64.2 KB
1 +64.1 KB
Content
Screenshot 2025-03-26 at 18.15.08.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +92.2 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
debug-enabled.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +196.3 KB
Content
integration-added.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +196.2 KB
Content
integration-dl-skip.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +105.5 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