Changes for page ThingsBoard
Last modified by Dilisi S on 2025/04/02 02:09
Summary
-
Page properties (1 modified, 0 added, 0 removed)
-
Attachments (0 modified, 1 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -164,7 +164,6 @@ 164 164 [[image:ins1.png||height="310" width="500"]] 165 165 166 166 167 -(% class="wikigeneratedid" %) 168 168 = 3. Creating Devices = 169 169 170 170 ... ... @@ -208,138 +208,93 @@ 208 208 209 209 The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**. 210 210 211 -Click on the ** JavaScript** button.210 +Click on the **TBEL** button if it has not been selected by default. 212 212 213 - Deletethe defaultdecoderfunctioninthe codeeditor. Now copyand paste thefollowingdecoder function writtenin **JavaScript** in to the **codeeditor**. This decoderfunction is compatiblefor both NB andCB series devices.212 +Modify the default TBEL function to match with your device as described below: 214 214 215 -{{info}} 216 -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. 217 -{{/info}} 218 218 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 + 219 219 {{code language="JavaScript"}} 220 -//Version: 0.1 233 +// Decode an uplink message from a buffer 234 +// payload - array of bytes 235 +// metadata - key/value object 236 + 237 +/** Decoder **/ 238 + 221 221 // decode payload to string 222 222 var payloadStr = decodeToString(payload); 223 223 224 224 // decode payload to JSON 225 -var objdata = {}; 226 -var obj1 = {}; 227 227 var data = decodeToJson(payload); 228 -var deviceName = data.IMEI; 229 -delete data.IMEI; 230 -var modelname = "Dragino " + data.Model; 231 -//var mod = data.mod 232 -delete data.Model; 233 -//delete data.mod 234 -var timestamp = new Date().getTime(); 235 235 236 -for (var key in data) { 237 - 238 - if (Number(key)) { 239 - obj1[key] = data[key]; 240 - obj1[key][obj1[key].length - 1] = Number(new Date( 241 - obj1[key][obj1[key].length - 1])); 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'; 242 242 243 - } 244 -//Alec submitted25/02/25 245 -//turn old key into new 246 - else if (key === "Reading") { 247 - objdata["reading"] = data[key]; 248 - } else if (key === "work mode") { 249 - objdata["work_mode"] = data[key]; 250 - } else if (key === "hum") { 251 - objdata["humidity"] = data[key]; 252 - }else if (key === "hum2") { 253 - objdata["humidity2"] = data[key]; 254 - } else if (key === "hum3") { 255 - objdata["humidity3"] = data[key]; 256 - } else if (key === "tem") { 257 - objdata["temperature"] = data[key]; 258 - } else if (key === "tem2") { 259 - objdata["temperature2"] = data[key]; 260 - } else if (key === "tem3") { 261 - objdata["temperature3"] = data[key]; 262 - } else if (key === "DS18B20_Temp") { 263 - objdata["temperature_pro"] = data[key]; 264 - } else if (key === "ds18b20_temperature") { 265 - objdata["temperature_pro"] = data[key]; 266 - } else if (key === "DS18B20_temperature_pro") { 267 - objdata["temperature_pro"] = data[key]; 268 - } else if (key === "tdc send flag") { 269 - objdata["tdc_send_flag"] = data[key]; 270 - } else if (key === "trigger mode") { 271 - objdata["trigger_mode"] = data[key]; 272 - } else if (key === "soil dielectric constant") { 273 - objdata["soil_dielectric_constant"] = data[key]; 274 - } else if (key === "door open num") { 275 - objdata["door_open_num"] = data[key]; 276 - } else if (key === "door duration") { 277 - objdata["door_duration"] = data[key]; 278 - } else if (key === "count time") { 279 - objdata["count_time"] = data[key]; 280 - } else if (key === "last open time2") { 281 - objdata["last_open_time2"] = data[key]; 282 - } else if (key === "last open time3") { 283 - objdata["last_open_time3"] = data[key]; 284 - } 285 -//Alec submitted25/02/25 286 - else { 287 - objdata[key] = data[key] 288 - } 289 -} 290 -var listdata = [{ 291 - "ts": timestamp, 292 - "values": objdata 293 -}] 294 -for (var key1 in obj1) { 295 - if (modelname == "Dragino RS485-NB") { 296 - listdata.push({ 297 - "ts": obj1[key1][obj1[key1].length - 1], 298 - "values": { 299 - "Payload": obj1[key1][0], 300 - } 301 - }) 302 - } else { 303 - listdata.push({ 304 - "ts": obj1[key1][obj1[key1].length - 1], 305 - "values": { 306 - "values": obj1[key1] 307 - }, 308 - }) 309 - } 310 -} 255 +// Result object with device/asset attributes/telemetry data 311 311 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 +}; 312 312 313 - deviceName: deviceName, 314 - deviceType: modelname, 315 - attributes: { 316 - model: modelname, 317 - //customerName: "NB-CB", 318 - //groupName: "NB-CB", 319 - //integrationName: metadata['integrationName'] 277 +/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/ 320 320 321 - }, 322 - telemetry: listdata 323 -} 279 +return result; 280 +{{/code}} 324 324 325 -function decodeToString(payload) { 326 - return String.fromCharCode.apply(String, payload); 327 -} 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. 328 328 329 -function decodeToJson(payload) { 330 - // covert payload to string. 331 - var str = decodeToString(payload); 284 +For example, if your device name is **Device B**, you can change **Device A** to **Device B**. 332 332 333 - // parse string to JSON 334 - var data = JSON.parse(str); 335 - return data; 336 -} 337 337 338 -return result; 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'; 339 339 {{/code}} 340 340 341 341 342 - Click on the **Add** button.296 +Once you modify the decoder function, click on the **Add** button. 343 343 344 344 345 345 [[image:mqtt-uplink.png||width="500"]] ... ... @@ -408,16 +408,15 @@ 408 408 409 409 **Connection:** 410 410 411 -* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud) 365 +* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**) 412 412 * **Port**: 8883 413 413 * **Credentials**: Basic 414 414 * **Enable SSL**: YES 415 415 * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials) 416 416 * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials) 417 -* **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.)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.) 418 418 * **QoS:** 0-At most once 419 419 420 - 421 421 [[image:add-integration-connection.png||height="511" width="500"]] 422 422 423 423
- 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