Changes for page ThingsBoard
Last modified by Dilisi S on 2025/04/23 19:23
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 0 added, 2 removed)
Details
- Page properties
-
- Content
-
... ... @@ -164,32 +164,13 @@ 164 164 [[image:ins1.png||height="310" width="500"]] 165 165 166 166 167 -= 3. CreatingDevices =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,93 +207,138 @@ 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** buttonif it has not been selected by default.191 +Click on the **JavaScript** button. 211 211 212 - Modifythe defaultTBELfunction tomatch withyourdeviceas describedbelow: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 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}} 214 214 215 -~1. Uncomment line 11: 216 - 217 -var data = decodeToJson(payload) 218 - 219 -[[image:Screenshot 2025-03-26 at 18.15.08.png||height="219" width="500"]] 220 - 221 - 222 -3. Modify the telemetry section to allow parsed data to be assigned to the fields. 223 - 224 -telemetry: { 225 - temperature: data.temperature, 226 - humidity: data.humidity, 227 - rawData: payloadStr 228 - } 229 - 230 - 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 - 200 +//Version: 0.1 239 239 // decode payload to string 240 240 var payloadStr = decodeToString(payload); 241 241 242 242 // decode payload to JSON 205 +var objdata = {}; 206 +var obj1 = {}; 243 243 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(); 244 244 245 -var deviceName = 'Device B'; 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'; 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])); 254 254 255 -// 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 +} 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 **/ 293 + deviceName: deviceName, 294 + deviceType: modelname, 295 + attributes: { 296 + model: modelname, 297 + //customerName: "NB-CB", 298 + //groupName: "NB-CB", 299 + //integrationName: metadata['integrationName'] 278 278 279 -return result; 280 -{{/code}} 301 + }, 302 + telemetry: listdata 303 +} 281 281 282 -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. 305 +function decodeToString(payload) { 306 + return String.fromCharCode.apply(String, payload); 307 +} 283 283 284 -For example, if your device name is **Device B**, you can change **Device A** to **Device B**. 309 +function decodeToJson(payload) { 310 + // covert payload to string. 311 + var str = decodeToString(payload); 285 285 313 + // parse string to JSON 314 + var data = JSON.parse(str); 315 + return data; 316 +} 286 286 287 -{{code language="JavaScript"}} 288 -var deviceName = 'Device A'; 289 -var deviceType = 'thermostat'; 290 -var customerName = 'Customer C'; 291 -var groupName = 'thermostat devices'; 292 -var manufacturer = 'Example corporation'; 318 +return result; 293 293 {{/code}} 294 294 295 295 296 - Once you modify the decoder function, click on the **Add** button.322 +Click on the **Add** button. 297 297 298 298 299 299 [[image:mqtt-uplink.png||width="500"]] ... ... @@ -306,7 +306,7 @@ 306 306 [[image:data-converter-list-showing-uplink-dc.png]] 307 307 308 308 309 -= 5. Add Integration =335 += 4. Add Integration = 310 310 311 311 312 312 In the left navigation, click **Integrations center**, and then click **Integrations**. ... ... @@ -362,15 +362,17 @@ 362 362 363 363 **Connection:** 364 364 365 -* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)391 +* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud) 366 366 * **Port**: 8883 367 367 * **Credentials**: Basic 368 368 * **Enable SSL**: YES 369 369 * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials) 370 370 * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials) 371 -* **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.)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.) 372 372 * **QoS:** 0-At most once 373 373 400 + 401 + 374 374 [[image:add-integration-connection.png||height="511" width="500"]] 375 375 376 376 ... ... @@ -404,10 +404,10 @@ 404 404 [[image:new-integration-pending.png]] 405 405 406 406 407 -= 6. Verifying the receipt of data from virtual devices =435 += 5. Verifying the receipt of data from virtual devices = 408 408 409 409 410 -== 6.1 How does it work? ==438 +== 5.1 How does it work? == 411 411 412 412 413 413 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. ... ... @@ -444,7 +444,7 @@ 444 444 [[image:new-device.png]] 445 445 446 446 447 -== 6.3 Viewing messages ==475 +== 5.3 Viewing messages == 448 448 449 449 450 450 Go back to the **Integrations** page. ... ... @@ -484,7 +484,7 @@ 484 484 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. 485 485 486 486 487 -= 7. Creating a Dashboard =515 += 6. Creating a Dashboard = 488 488 489 489 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. 490 490 ... ... @@ -567,7 +567,7 @@ 567 567 [[image:timeseries-4.png||height="316" width="700"]] 568 568 569 569 570 -= 8. Configure NB-IoT Sensor =598 += 7. Configure NB-IoT Sensor = 571 571 572 572 573 573 Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
- 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