Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 195.1
edited by Dilisi S
on 2025/03/28 00:38
Change comment: Mar 17 edits - part 3
To version 175.1
edited by Dilisi S
on 2025/03/20 16:51
Change comment: Mar 20 edits - part 2

Summary

Details

Page properties
Content
... ... @@ -164,35 +164,13 @@
164 164  [[image:ins1.png||height="310" width="500"]]
165 165  
166 166  
167 -= 3. Creating Devices (Optional) =
167 += 3. Data Converters =
168 168  
169 -{{info}}
170 -**The following procedure is optional. If you haven't created any device in ThingsBoard first, ThingsBoard will automatically create a device for you based on the integration settings (the device name defined in the uplink decoder) just after it receives the first uplink from your device.Type your information message here.**
171 -{{/info}}
172 172  
173 -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.
174 -
175 -
176 -In the left navigation, click **Entities -> Devices**.
177 -
178 -Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
179 -
180 -In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
181 -
182 -Click the **Add** button.
183 -
184 -Skip the **connectivity testing** by clicking the **Close** button.
185 -
186 -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.
187 -
188 -
189 -= 4. Data Converters =
190 -
191 -
192 192  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.
193 193  
194 194  
195 -== 4.1 Uplink ==
173 +== 3.1 Uplink ==
196 196  
197 197  
198 198  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -208,100 +208,155 @@
208 208  [[image:create-new-converter-menu.png||height="259" width="500"]]
209 209  
210 210  
211 -The **Add data converter** window will appear.
189 +The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
212 212  
213 -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**.
191 +Click on the **JavaScript** button.
214 214  
215 -Click on the **TBEL** button if it has not been selected by default.
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.
216 216  
217 -Modify the default TBEL function to match with your device as described below:
195 +{{info}}
196 +Please note that the value assigned to the IMEI field in the payload will be used by ThingsBoard to create a device on the platform with the same name.
197 +{{/info}}
218 218  
219 -
220 -* Uncomment** line 11**:
221 -
222 -//var data = decodeToJson(payload)//
223 -
224 -
225 -* **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.
226 -* From **line 38**: Modify the telemetry section to allow parsed data to be assigned to the fields.
227 -
228 -//telemetry: {
229 - temperature: data.temperature,
230 - humidity: data.humidity,
231 - rawData: payloadStr
232 - }//
233 -
234 -
235 -The modified uplink decoder function to match with **Device A** is shown below.
236 -
237 237  {{code language="JavaScript"}}
238 -// Decode an uplink message from a buffer
239 -// payload - array of bytes
240 -// metadata - key/value object
241 -
242 -/** Decoder **/
243 -
200 +//Version: 0.1
244 244  // decode payload to string
245 245  var payloadStr = decodeToString(payload);
246 246  
247 247  // decode payload to JSON
205 +var objdata = {};
206 +var obj1 = {};
248 248  var data = decodeToJson(payload);
208 +var deviceName = data.IMEI;
209 +delete data.IMEI;
210 +var modelname = "Dragino " + data.Model;
211 +//var mod = data.mod
212 +delete data.Model;
213 +//delete data.mod
214 +var timestamp = new Date().getTime();
249 249  
250 -var deviceName = 'Device A';
251 -var deviceType = 'thermostat';
252 -var customerName = 'Customer C';
253 -var groupName = 'thermostat devices';
254 -var manufacturer = 'Example corporation';
255 -// use assetName and assetType instead of deviceName and deviceType
256 -// to automatically create assets instead of devices.
257 -// var assetName = 'Asset A';
258 -// var assetType = 'building';
216 +for (var key in data) {
217 +
218 + if (Number(key)) {
219 + obj1[key] = data[key];
220 + obj1[key][obj1[key].length - 1] = Number(new Date(
221 + obj1[key][obj1[key].length - 1]));
259 259  
260 -// Result object with device/asset attributes/telemetry data
223 + }
224 +//Alec submitted25/02/25
225 +//turn old key into new
226 + else if (key === "Reading") {
227 + objdata["reading"] = data[key];
228 + } else if (key === "work mode") {
229 + objdata["work_mode"] = data[key];
230 + } else if (key === "hum") {
231 + objdata["humidity"] = data[key];
232 + }else if (key === "hum2") {
233 + objdata["humidity2"] = data[key];
234 + } else if (key === "hum3") {
235 + objdata["humidity3"] = data[key];
236 + } else if (key === "tem") {
237 + objdata["temperature"] = data[key];
238 + } else if (key === "tem2") {
239 + objdata["temperature2"] = data[key];
240 + } else if (key === "tem3") {
241 + objdata["temperature3"] = data[key];
242 + } else if (key === "DS18B20_Temp") {
243 + objdata["temperature_pro"] = data[key];
244 + } else if (key === "ds18b20_temperature") {
245 + objdata["temperature_pro"] = data[key];
246 + } else if (key === "DS18B20_temperature_pro") {
247 + objdata["temperature_pro"] = data[key];
248 + } else if (key === "tdc send flag") {
249 + objdata["tdc_send_flag"] = data[key];
250 + } else if (key === "trigger mode") {
251 + objdata["trigger_mode"] = data[key];
252 + } else if (key === "soil dielectric constant") {
253 + objdata["soil_dielectric_constant"] = data[key];
254 + } else if (key === "door open num") {
255 + objdata["door_open_num"] = data[key];
256 + } else if (key === "door duration") {
257 + objdata["door_duration"] = data[key];
258 + } else if (key === "count time") {
259 + objdata["count_time"] = data[key];
260 + } else if (key === "last open time2") {
261 + objdata["last_open_time2"] = data[key];
262 + } else if (key === "last open time3") {
263 + objdata["last_open_time3"] = data[key];
264 + }
265 +//Alec submitted25/02/25
266 + else {
267 + objdata[key] = data[key]
268 + }
269 +}
270 +var listdata = [{
271 + "ts": timestamp,
272 + "values": objdata
273 +}]
274 +for (var key1 in obj1) {
275 + if (modelname == "Dragino RS485-NB") {
276 + listdata.push({
277 + "ts": obj1[key1][obj1[key1].length - 1],
278 + "values": {
279 + "Payload": obj1[key1][0],
280 + }
281 + })
282 + } else {
283 + listdata.push({
284 + "ts": obj1[key1][obj1[key1].length - 1],
285 + "values": {
286 + "values": obj1[key1]
287 + },
288 + })
289 + }
290 +}
261 261  var result = {
262 -// Use deviceName and deviceType or assetName and assetType, but not both.
263 - deviceName: deviceName,
264 - deviceType: deviceType,
265 -// assetName: assetName,
266 -// assetType: assetType,
267 -// customerName: customerName,
268 - groupName: groupName,
269 - attributes: {
270 - model: 'Model A',
271 - serialNumber: 'SN111',
272 - integrationName: metadata['integrationName'],
273 - manufacturer: manufacturer
274 - },
275 - telemetry: {
276 - temperature: data.temperature,
277 - humidity: data.humidity,
278 - rawData: payloadStr
279 - }
280 -};
281 281  
282 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
293 + deviceName: deviceName,
294 + deviceType: modelname,
295 + attributes: {
296 + model: modelname,
297 + //customerName: "NB-CB",
298 + //groupName: "NB-CB",
299 + //integrationName: metadata['integrationName']
283 283  
301 + },
302 + telemetry: listdata
303 +}
304 +
305 +function decodeToString(payload) {
306 + return String.fromCharCode.apply(String, payload);
307 +}
308 +
309 +function decodeToJson(payload) {
310 + // covert payload to string.
311 + var str = decodeToString(payload);
312 +
313 + // parse string to JSON
314 + var data = JSON.parse(str);
315 + return data;
316 +}
317 +
284 284  return result;
285 285  {{/code}}
286 286  
287 287  
288 -Once you modify the decoder function, click on the **Add** button.
322 +Click on the **Add** button.
289 289  
290 290  
325 +[[image:mqtt-uplink.png||width="500"]]
291 291  
292 -[[image:ul-data-converter-device-a.png||height="524" width="500"]]
293 293  
294 294  
295 295  You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
296 296  
297 297  
298 -[[image:ul-data-converter-added.png||height="257"]]
332 +[[image:data-converter-list-showing-uplink-dc.png]]
299 299  
300 300  
335 += 4. Add Integration =
301 301  
302 -= 5. Add Integration =
303 303  
304 -
305 305  In the left navigation, click **Integrations center**, and then click **Integrations**.
306 306  
307 307  
... ... @@ -319,7 +319,7 @@
319 319  **Basic settings:**
320 320  
321 321  * **Integration type**: MQTT
322 -* **Name**: MQTT integration - Device A
355 +* **Name**: MQTT integration NB/CB
323 323  * **Enable integration**: YES
324 324  * **Allows create devices or assets**: YES
325 325  
... ... @@ -326,11 +326,9 @@
326 326  Click **Next** button.
327 327  
328 328  
329 -[[image:add-integration-basic-settings.png||height="504" width="500"]]
362 +[[image:add-integration-basic-settings.png||height="511" width="500"]]
330 330  
331 331  
332 -
333 -
334 334  **Uplink data converter:**
335 335  
336 336  * Click on the **Select existing** button.
... ... @@ -339,10 +339,9 @@
339 339  Click **Next** button.
340 340  
341 341  
342 -[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
373 +[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
343 343  
344 344  
345 -
346 346  **Downlink data converter:**
347 347  
348 348  Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
... ... @@ -358,18 +358,20 @@
358 358  
359 359  **Connection:**
360 360  
361 -* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
391 +* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
362 362  * **Port**: 8883
363 -* **Credentials type**: Basic
393 +* **Credentials**: Basic
394 +* **Enable SSL**: YES
364 364  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
365 365  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
366 -* **Enable SSL**: YES
367 -* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
397 +* **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 S31B-NB.)
368 368  * **QoS:** 0-At most once
369 369  
370 -[[image:add-integartion-connection.png||height="505" width="500"]]
371 371  
372 372  
402 +[[image:add-integration-connection.png||height="511" width="500"]]
403 +
404 +
373 373  Click on the **Advanced settings** button.
374 374  
375 375  * **Clean session:** YES
... ... @@ -397,36 +397,35 @@
397 397  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
398 398  
399 399  
400 -[[image:integration-added.png]]
432 +[[image:new-integration-pending.png]]
401 401  
402 402  
435 += 5. Verifying the receipt of data from virtual devices =
403 403  
404 -= 6. Verifying the receipt of data from virtual devices =
405 405  
438 +== 5.1 How does it work? ==
406 406  
407 -== 6.1 How does it work? ==
408 408  
409 -
410 410  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.
411 411  
412 -The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
443 +The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
413 413  
414 -(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
445 +(% 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.
415 415  
416 416  {{code language="none"}}
417 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
448 +{"IMEI": "S31B-NB", "temperature": 27, ......}
418 418  {{/code}}
419 419  
420 -Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
451 +Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
421 421  
422 422  
423 423  == 5.2 Sending messages ==
424 424  
425 425  
426 -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.
457 +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.
427 427  
428 428  {{code language="none"}}
429 -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}'
460 +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}'
430 430  {{/code}}
431 431  
432 432  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -435,9 +435,15 @@
435 435  [[image:integration-active.png]]
436 436  
437 437  
438 -== 6.3 Viewing messages ==
469 +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**.
439 439  
440 440  
472 +[[image:new-device.png]]
473 +
474 +
475 +== 5.3 Viewing messages ==
476 +
477 +
441 441  Go back to the **Integrations** page.
442 442  
443 443  Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
... ... @@ -453,40 +453,29 @@
453 453  Then click on the **Apply changes** (//**tick icon**//) button.
454 454  
455 455  
456 -[[image:debug-enabled.png||height="301" width="700"]]
493 +[[image:Screenshot 2025-03-18 at 09.23.10.png]]
457 457  
458 458  
459 -
460 -
461 461  Now go to the **Events** tab.
462 462  
463 -Select the **Event type** as **Debug** from the dropdown list.
498 +Select the Event type as **Debug** from the dropdown list.
464 464  
465 -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:
500 +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.
466 466  
467 -{{code language="none"}}
468 -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}'
469 -{{/code}}
470 470  
471 -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.
503 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
472 472  
473 473  
474 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
475 -
476 -
477 -
478 478  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
479 479  
480 480  
481 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
509 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
482 482  
483 483  
484 -
485 -
486 486  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.
487 487  
488 488  
489 -= 7. Creating a Dashboard =
515 += 6. Creating a Dashboard =
490 490  
491 491  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.
492 492  
... ... @@ -569,7 +569,7 @@
569 569  [[image:timeseries-4.png||height="316" width="700"]]
570 570  
571 571  
572 -= 8. Configure NB-IoT Sensor =
598 += 7. Configure NB-IoT Sensor =
573 573  
574 574  
575 575  Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
... ... @@ -598,3 +598,6 @@
598 598  {{/info}}
599 599  
600 600  [[image:image-4.png]]
627 +
628 +
629 +
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