Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/15 23:13

From version < 177.1 >

edited by Dilisi S
on 2025/03/26 21:03

To version < 174.1 >

edited by Dilisi S
on 2025/03/20 16:50

Change comment: Uploaded new attachment "Screenshot 2025-03-16 at 18.39.12.png", version {1}

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)

Details

Page properties

Content

@@ -164,32 +164,13 @@
  [[image:ins1.png||height="310" width="500"]]
--= 3. Creating Devices =
++= 3. Data Converters =
--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.
--
--
--In the left navigation, click Entities -> Devices.
--
--Click the **Add Device** button (the button with the **+** sign), and from the dropdown menu, click **Add new device**.
--
--In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
--
--Click the **Add** button.
--
--Skip the **connectivity testing** by clicking the **Close** button.
--
--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.
--
--
--= 4. Data Converters =
--
--
  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.
--== 4.1 Uplink ==
++== 3.1 Uplink ==
  In the left navigation, click **Integrations center**, and then click **Data converters**.
@@ -207,76 +207,135 @@
  The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
--Click on the **TBEL** button if it has not been selected by default.
++Click on the **JavaScript** button.
--The default TBEL function is shown below.
++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.
  {{code language="JavaScript"}}
--// Decode an uplink message from a buffer
--// payload - array of bytes
--// metadata - key/value object
--
--/** Decoder **/
--
++//Version: 0.1
  // decode payload to string
  var payloadStr = decodeToString(payload);
  // decode payload to JSON
--// var data = decodeToJson(payload);
++var objdata = {};
++var obj1 = {};
++var data = decodeToJson(payload);
++var deviceName = data.IMEI;
++delete data.IMEI;
++var modelname = "Dragino " + data.Model;
++//var mod = data.mod
++delete data.Model;
++//delete data.mod
++var timestamp = new Date().getTime();
--var deviceName = 'Device A';
--var deviceType = 'thermostat';
--var customerName = 'Customer C';
--var groupName = 'thermostat devices';
--var manufacturer = 'Example corporation';
--// use assetName and assetType instead of deviceName and deviceType
--// to automatically create assets instead of devices.
--// var assetName = 'Asset A';
--// var assetType = 'building';
++for (var key in data) {
++
++    if (Number(key)) {
++        obj1[key] = data[key];
++        obj1[key][obj1[key].length - 1] = Number(new Date(
++            obj1[key][obj1[key].length - 1]));
--// Result object with device/asset attributes/telemetry data
++    }
++//Alec submitted25/02/25
++//turn old key into new
++    else if (key === "Reading") {
++        objdata["reading"] = data[key];
++    } else if (key === "work mode") {
++        objdata["work_mode"] = data[key];
++    } else if (key === "hum") {
++        objdata["humidity"] = data[key];
++    }else if (key === "hum2") {
++        objdata["humidity2"] = data[key];
++    } else if (key === "hum3") {
++        objdata["humidity3"] = data[key];
++    } else if (key === "tem") {
++        objdata["temperature"] = data[key];
++    } else if (key === "tem2") {
++        objdata["temperature2"] = data[key];
++    } else if (key === "tem3") {
++        objdata["temperature3"] = data[key];
++    } else if (key === "DS18B20_Temp") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "ds18b20_temperature") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "DS18B20_temperature_pro") {
++        objdata["temperature_pro"] = data[key];
++    } else if (key === "tdc send flag") {
++        objdata["tdc_send_flag"] = data[key];
++    } else if (key === "trigger mode") {
++        objdata["trigger_mode"] = data[key];
++    } else if (key === "soil dielectric constant") {
++        objdata["soil_dielectric_constant"] = data[key];
++    } else if (key === "door open num") {
++        objdata["door_open_num"] = data[key];
++    } else if (key === "door duration") {
++        objdata["door_duration"] = data[key];
++    } else if (key === "count time") {
++        objdata["count_time"] = data[key];
++    } else if (key === "last open time2") {
++        objdata["last_open_time2"] = data[key];
++    } else if (key === "last open time3") {
++        objdata["last_open_time3"] = data[key];
++    }
++//Alec submitted25/02/25
++    else {
++        objdata[key] = data[key]
++    }
++}
++var listdata = [{
++    "ts": timestamp,
++    "values": objdata
++}]
++for (var key1 in obj1) {
++    if (modelname == "Dragino RS485-NB") {
++        listdata.push({
++            "ts": obj1[key1][obj1[key1].length - 1],
++            "values": {
++                "Payload": obj1[key1][0],
++            }
++        })
++    } else {
++        listdata.push({
++            "ts": obj1[key1][obj1[key1].length - 1],
++            "values": {
++                "values": obj1[key1]
++            },
++        })
++    }
++}
  var result = {
--// Use deviceName and deviceType or assetName and assetType, but not both.
--   deviceName: deviceName,
--   deviceType: deviceType,
--// assetName: assetName,
--// assetType: assetType,
--// customerName: customerName,
--   groupName: groupName,
--   attributes: {
--       model: 'Model A',
--       serialNumber: 'SN111',
--       integrationName: metadata['integrationName'],
--       manufacturer: manufacturer
--   },
--   telemetry: {
--       temperature: 42,
--       humidity: 80,
--       rawData: payloadStr
--   }
--};
--/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++    deviceName: deviceName,
++    deviceType: modelname,
++    attributes: {
++        model: modelname,
++        //customerName: "NB-CB",
++        //groupName: "NB-CB",
++        //integrationName: metadata['integrationName']
--return result;
--{{/code}}
++    },
++    telemetry: listdata
++}
--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.
++function decodeToString(payload) {
++    return String.fromCharCode.apply(String, payload);
++}
--For example, if your device name is **Device B**, you can change **Device A** to **Device B**.
++function decodeToJson(payload) {
++    // covert payload to string.
++    var str = decodeToString(payload);
++    // parse string to JSON
++    var data = JSON.parse(str);
++    return data;
++}
--{{code language="JavaScript"}}
--var deviceName = 'Device A';
--var deviceType = 'thermostat';
--var customerName = 'Customer C';
--var groupName = 'thermostat devices';
--var manufacturer = 'Example corporation';
++return result;
  {{/code}}
--Once you modify the decoder function, click on the **Add** button.
++Click on the **Add** button.
  [[image:mqtt-uplink.png||width="500"]]
@@ -289,9 +289,13 @@
  [[image:data-converter-list-showing-uplink-dc.png]]
--= 5. Add Integration =
++
++
++= 4. Add Integration =
++
++
  In the left navigation, click **Integrations center**, and then click **Integrations**.
@@ -345,13 +345,13 @@
  **Connection:**
--* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
++* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
  * **Port**: 8883
  * **Credentials**: Basic
  * **Enable SSL**: YES
  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
--* **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.)
++* **Topic: v1/devices/me/telemetry** (The topic can be anything, even you can use just the device name, for example ts02-nb)
  * **QoS:** 0-At most once
  [[image:add-integration-connection.png||height="511" width="500"]]
@@ -384,13 +384,14 @@
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
++
  [[image:new-integration-pending.png]]
--= 6. Verifying the receipt of data from virtual devices =
++= 5. Verifying the receipt of data from virtual devices =
--== 6.1 How does it work? ==
++== 5.1 How does it work? ==
  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.
@@ -427,7 +427,7 @@
  [[image:new-device.png]]
--== 6.3 Viewing messages ==
++== 5.3 Viewing messages ==
  Go back to the **Integrations** page.
@@ -467,7 +467,7 @@
  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.
--= 7. Creating a Dashboard =
++= 6. Creating a Dashboard =
  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.
@@ -550,7 +550,7 @@
  [[image:timeseries-4.png||height="316" width="700"]]
--= 8. Configure NB-IoT Sensor =
++= 7. Configure NB-IoT Sensor =
  Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
@@ -561,7 +561,7 @@
  **AT Commands**
  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
--* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
++* **AT+SUBTOPIC=<MQTT subscribe topic> **
  * **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
  * **AT+CLIENT=null**
  * **AT+UNAME=<MQTT Username>**

Changes for page ThingsBoard

Summary

Details

Applications

Navigation