Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 182.1
edited by Dilisi S
on 2025/03/27 02:50
Change comment: Mar 26 - heavy edits
To version 172.1
edited by Dilisi S
on 2025/03/20 15:36
Change comment: Mar 20 - edits

Summary

Details

Page properties
Content
... ... @@ -164,32 +164,13 @@
164 164  [[image:ins1.png||height="310" width="500"]]
165 165  
166 166  
167 -= 3. Creating Devices =
167 += 3. Data Converters =
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 -
189 189  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.
190 190  
191 191  
192 -== 4.1 Uplink ==
173 +== 3.1 Uplink ==
193 193  
194 194  
195 195  In the left navigation, click **Integrations center**, and then click **Data converters**.
... ... @@ -207,80 +207,135 @@
207 207  
208 208  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
209 209  
210 -Click on the **TBEL** button if it has not been selected by default.
191 +Click on the **JavaScript** button.
211 211  
212 -Modify the default TBEL function to match with your device as described below:
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.
213 213  
214 214  
215 -* Uncomment** line 11**:
216 -
217 -//var data = decodeToJson(payload)//
218 -
219 -
220 -* **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.
221 -* From **line 38**: Modify the telemetry section to allow parsed data to be assigned to the fields.
222 -
223 -//telemetry: {
224 - temperature: data.temperature,
225 - humidity: data.humidity,
226 - rawData: payloadStr
227 - }//
228 -
229 -
230 -The modified uplink decoder function to match with **Device A** is shown below.
231 -
232 232  {{code language="JavaScript"}}
233 -// Decode an uplink message from a buffer
234 -// payload - array of bytes
235 -// metadata - key/value object
236 -
237 -/** Decoder **/
238 -
197 +//Version: 0.1
239 239  // decode payload to string
240 240  var payloadStr = decodeToString(payload);
241 241  
242 242  // decode payload to JSON
202 +var objdata = {};
203 +var obj1 = {};
243 243  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();
244 244  
245 -var deviceName = 'Device A';
246 -var deviceType = 'thermostat';
247 -var customerName = 'Customer C';
248 -var groupName = 'thermostat devices';
249 -var manufacturer = 'Example corporation';
250 -// use assetName and assetType instead of deviceName and deviceType
251 -// to automatically create assets instead of devices.
252 -// var assetName = 'Asset A';
253 -// var assetType = 'building';
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]));
254 254  
255 -// Result object with device/asset attributes/telemetry data
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 +}
256 256  var result = {
257 -// Use deviceName and deviceType or assetName and assetType, but not both.
258 - deviceName: deviceName,
259 - deviceType: deviceType,
260 -// assetName: assetName,
261 -// assetType: assetType,
262 -// customerName: customerName,
263 - groupName: groupName,
264 - attributes: {
265 - model: 'Model A',
266 - serialNumber: 'SN111',
267 - integrationName: metadata['integrationName'],
268 - manufacturer: manufacturer
269 - },
270 - telemetry: {
271 - temperature: data.temperature,
272 - humidity: data.humidity,
273 - rawData: payloadStr
274 - }
275 -};
276 276  
277 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
290 + deviceName: deviceName,
291 + deviceType: modelname,
292 + attributes: {
293 + model: modelname,
294 + //customerName: "NB-CB",
295 + //groupName: "NB-CB",
296 + //integrationName: metadata['integrationName']
278 278  
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 +
279 279  return result;
280 280  {{/code}}
281 281  
282 282  
283 -Once you modify the decoder function, click on the **Add** button.
319 +Click on the **Add** button.
284 284  
285 285  
286 286  [[image:mqtt-uplink.png||width="500"]]
... ... @@ -293,9 +293,13 @@
293 293  [[image:data-converter-list-showing-uplink-dc.png]]
294 294  
295 295  
296 -= 5. Add Integration =
297 297  
298 298  
334 +
335 +
336 += 4. Add Integration =
337 +
338 +
299 299  In the left navigation, click **Integrations center**, and then click **Integrations**.
300 300  
301 301  
... ... @@ -349,13 +349,13 @@
349 349  
350 350  **Connection:**
351 351  
352 -* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
392 +* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
353 353  * **Port**: 8883
354 -* **Credentials type**: Basic
394 +* **Credentials**: Basic
395 +* **Enable SSL**: YES
355 355  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
356 356  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
357 -* **Enable SSL**: YES
358 -* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
398 +* **Topic: v1/devices/me/telemetry** (The topic can be anything, even you can use just the device name, for example ts02-nb)
359 359  * **QoS:** 0-At most once
360 360  
361 361  [[image:add-integration-connection.png||height="511" width="500"]]
... ... @@ -388,26 +388,27 @@
388 388  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
389 389  
390 390  
431 +
391 391  [[image:new-integration-pending.png]]
392 392  
393 393  
394 -= 6. Verifying the receipt of data from virtual devices =
435 += 5. Verifying the receipt of data from virtual devices =
395 395  
396 396  
397 -== 6.1 How does it work? ==
438 +== 5.1 How does it work? ==
398 398  
399 399  
400 400  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.
401 401  
402 -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.
403 403  
404 -(% 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.
405 405  
406 406  {{code language="none"}}
407 -{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
448 +{"IMEI": "S31B-NB", "temperature": 27, ......}
408 408  {{/code}}
409 409  
410 -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.
411 411  
412 412  
413 413  == 5.2 Sending messages ==
... ... @@ -416,7 +416,7 @@
416 416  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.
417 417  
418 418  {{code language="none"}}
419 -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}'
420 420  {{/code}}
421 421  
422 422  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
... ... @@ -425,11 +425,15 @@
425 425  [[image:integration-active.png]]
426 426  
427 427  
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**.
428 428  
429 429  
430 -== 6.3 Viewing messages ==
472 +[[image:new-device.png]]
431 431  
432 432  
475 +== 5.3 Viewing messages ==
476 +
477 +
433 433  Go back to the **Integrations** page.
434 434  
435 435  Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
... ... @@ -452,26 +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.
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.
456 456  
457 457  
458 -[[image:Screenshot 2025-03-26 at 19.49.31.png]]
503 +[[image:Screenshot 2025-03-16 at 18.38.59.png]]
459 459  
460 460  
461 -
462 -
463 463  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
464 464  
465 465  
466 -[[image:Screenshot 2025-03-26 at 19.47.52.png]]
509 +[[image:Screenshot 2025-03-16 at 18.39.12.png]]
467 467  
468 468  
469 -
470 -
471 471  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.
472 472  
473 473  
474 -= 7. Creating a Dashboard =
515 += 6. Creating a Dashboard =
475 475  
476 476  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.
477 477  
... ... @@ -554,7 +554,7 @@
554 554  [[image:timeseries-4.png||height="316" width="700"]]
555 555  
556 556  
557 -= 8. Configure NB-IoT Sensor =
598 += 7. Configure NB-IoT Sensor =
558 558  
559 559  
560 560  Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
... ... @@ -565,7 +565,7 @@
565 565  **AT Commands**
566 566  
567 567  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
568 -* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
609 +* **AT+SUBTOPIC=<MQTT subscribe topic> **
569 569  * **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
570 570  * **AT+CLIENT=null**
571 571  * **AT+UNAME=<MQTT Username>**
Screenshot 2025-03-16 at 18.39.12.png
Size
... ... @@ -1,1 +1,1 @@
1 -211.9 KB
1 +277.0 KB
Content
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-integration-connection.png
Size
... ... @@ -1,1 +1,1 @@
1 -158.1 KB
1 +153.2 KB
Content