Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23

From 168.1 to 169.1 From 194.1 to 195.1

From version 169.1

edited by Dilisi S
on 2025/03/19 04:17

Change comment: There is no comment for this version

To version 194.1

edited by Dilisi S
on 2025/03/28 00:23

Change comment: Mar 27 edits - part 3

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (4 modified, 11 added, 0 removed)

Details

Page properties

Content

@@ -164,240 +164,141 @@
  [[image:ins1.png||height="310" width="500"]]
--= 3. Data Converters =
++= 3. Creating Devices =
--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.
++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.
--== 3.1 Uplink ==
++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 left navigation, click **Integrations center**, and then click **Data converters**.
++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.
--[[image:data-converters-list-empty.png]]
++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.
--On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
++= 4. Data Converters =
--[[image:create-new-converter-menu.png||height="259" width="500"]]
++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.
--The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
++== 4.1 Uplink ==
--Click on the **JavaScript** button.
--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.
++In the left navigation, click **Integrations center**, and then click **Data converters**.
--{{code language="JavaScript"}}
--//Version: 0.1
--// decode payload to string
--var payloadStr = decodeToString(payload);
++[[image:data-converters-list-empty.png]]
--// decode payload to JSON
--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();
--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]));
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
--    }
--//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 = {
--    deviceName: deviceName,
--    deviceType: modelname,
--    attributes: {
--        model: modelname,
--        //customerName: "NB-CB",
--        //groupName: "NB-CB",
--        //integrationName: metadata['integrationName']
--    },
--    telemetry: listdata
--}
++[[image:create-new-converter-menu.png||height="259" width="500"]]
--function decodeToString(payload) {
--    return String.fromCharCode.apply(String, payload);
--}
--function decodeToJson(payload) {
--    // covert payload to string.
--    var str = decodeToString(payload);
++The **Add data converter** window will appear.
--    // parse string to JSON
--    var data = JSON.parse(str);
--    return data;
--}
++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**.
--return result;
--{{/code}}
++Click on the **TBEL** button if it has not been selected by default.
++Modify the default TBEL function to match with your device as described below:
--Click on the **Add** button.
++* Uncomment** line 11**:
--[[image:mqtt-uplink.png||width="500"]]
++//var data = decodeToJson(payload)//
++* **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.
++* From **line 38**: Modify the telemetry section to allow parsed data to be assigned to the fields.
--You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
++//telemetry: {
++       temperature: data.temperature,
++       humidity: data.humidity,
++       rawData: payloadStr
++   }//
--[[image:data-converter-list-showing-uplink-dc.png]]
++The modified uplink decoder function to match with **Device A** is shown below.
--
--== 3.2 Downlink ==
--
--
--On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
--
--
--[[image:create-new-converter-menu.png||width="500"]]
--
--
--
--The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
--
--Click on the **TBEL** button if not selected it by default. Now copy and paste the following encoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This encoder function is compatible for both NB and CB series devices.
--
--
  {{code language="JavaScript"}}
--// Encode downlink data from incoming Rule Engine message
++// Decode an uplink message from a buffer
++// payload - array of bytes
++// metadata - key/value object
--// msg - JSON message payload downlink message json
--// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
--// metadata - list of key-value pairs with additional data about the message
--// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
++/** Decoder **/
--/** Encoder **/
++// decode payload to string
++var payloadStr = decodeToString(payload);
--var data = {};
++// decode payload to JSON
++var data = decodeToJson(payload);
--// Process data from incoming message and metadata
++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';
--data.tempFreq = msg.temperatureUploadFrequency;
--data.humFreq = msg.humidityUploadFrequency;
--
--data.devSerialNumber = metadata['ss_serialNumber'];
--
--// Result object with encoded downlink payload
++// Result object with device/asset attributes/telemetry data
  var result = {
--
--    // downlink data content type: JSON, TEXT or BINARY (base64 format)
--    contentType: "JSON",
--
--    // downlink data
--    data: JSON.stringify(data),
--
--    // Optional metadata object presented in key/value format
--    metadata: {
--            topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
--    }
--
++// 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: data.temperature,
++       humidity: data.humidity,
++       rawData: payloadStr
++   }
  };
++/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++
  return result;
  {{/code}}
--Click on the **Add** button.
++Once you modify the decoder function, click on the **Add** button.
--[[image:add-downlink-data-converter.png||height="529" width="500"]]
++[[image:ul-data-converter-device-a.png||height="524" width="500"]]
--You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
++You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
--[[image:data-converters-list.png]]
++[[image:ul-data-converter-added.png||height="257"]]
--= 4. Add Integration =
++= 5. Add Integration =
++
++
  In the left navigation, click **Integrations center**, and then click **Integrations**.
@@ -415,7 +415,7 @@
  **Basic settings:**
  * **Integration type**: MQTT
--* **Name**: MQTT integration NB/CB
++* **Name**: MQTT integration - Device A
  * **Enable integration**: YES
  * **Allows create devices or assets**: YES
@@ -422,9 +422,11 @@
  Click **Next** button.
--[[image:add-integration-basic-settings.png||height="511" width="500"]]
++[[image:add-integration-basic-settings.png||height="504" width="500"]]
++
++
  **Uplink data converter:**
  * Click on the **Select existing** button.
@@ -433,32 +433,35 @@
  Click **Next** button.
--[[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
++[[image:add-integration-ul-data-converter.png||height="505" width="500"]]
++
  **Downlink data converter:**
--* Click on the **Select existing** button.
--* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
++Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
--Click **Next** button.
++* Click on the **Skip **button in the Downlink data converter section.
++Click **Skip** button.
--[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
++[[image:integration-dl-skip.png||height="511" width="500"]]
++
++
  **Connection:**
--* **Host**: Cluster URL (Eg. 011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud)
++* **Host**: Host URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
  * **Port**: 8883
--* **Credentials**: Basic
--* **Enable SSL**: YES
++* **Credentials type**: Basic
  * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
  * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
--* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
++* **Enable SSL**: YES
++* **Topic: device/a** (The topic can be anything; you can even use just the device name.)
  * **QoS:** 0-At most once
--[[image:add-integration-connection.png||height="511" width="500"]]
++[[image:add-integartion-connection.png||height="505" width="500"]]
  Click on the **Advanced settings** button.
@@ -488,36 +488,36 @@
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
++[[image:integration-added.png]]
--[[image:new-integration-pending.png]]
--= 5. Verifying the receipt of data from virtual devices =
++= 6. Verifying the receipt of data from virtual devices =
--== 5.1 How does it work? ==
++== 6.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.
--The Mosquitto client publishes messages (payloads) on the topic **v1/devices/me/telemetry**. Of course, you can use any topic for testing.
++The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
--(% 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.
++(% id="cke_bm_37386S" style="display:none" %) (%%)The MQTT payload format is as follows:
  {{code language="none"}}
--{"IMEI": "S31B-NB", "temperature": 27, ......}
++{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
  {{/code}}
--Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
++Once ThingsBoard receives this message, it forwards this payload to the matching device through the integration.
  == 5.2 Sending messages ==
--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.
++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.
  {{code language="none"}}
--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}'
++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}'
  {{/code}}
  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
@@ -526,15 +526,9 @@
  [[image:integration-active.png]]
--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**.
++== 6.3 Viewing messages ==
--[[image:new-device.png]]
--
--
--== 5.3 Viewing messages ==
--
--
  Go back to the **Integrations** page.
  Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
@@ -550,29 +550,40 @@
  Then click on the **Apply changes** (//**tick icon**//) button.
--[[image:Screenshot 2025-03-18 at 09.23.10.png]]
++[[image:debug-enabled.png||height="301" width="700"]]
++
++
  Now go to the **Events** tab.
--Select the Event type as **Debug** from the dropdown list.
++Select the **Event type** as **Debug** from the dropdown list.
--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.
++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:
++{{code language="none"}}
++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}'
++{{/code}}
--[[image:Screenshot 2025-03-16 at 18.38.59.png]]
++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.
++[[image:Screenshot 2025-03-26 at 19.49.31.png]]
++
++
++
  Then click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
--[[image:Screenshot 2025-03-16 at 18.39.12.png]]
++[[image:Screenshot 2025-03-26 at 19.47.52.png]]
++
++
  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.
--= 6. Creating a Dashboard =
++= 7. 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.
@@ -582,8 +582,7 @@
  First simulate a few messages using MQTT. This time, we have added the 'humidity' field to the payload. Eg:
--{{code language="none"}}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": 22, "humidity":80}'
--{{/code}}
++{{code language="none"}}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": 22, "humidity":80}'{{/code}}
  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
@@ -656,10 +656,10 @@
  [[image:timeseries-4.png||height="316" width="700"]]
--= 7. Configure NB-IoT Sensor =
++= 8. 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 **S31B-NB**.
++Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **TS01-NB**.
  First, configure the NB-IoT device with the necessary MQTT settings using AT commands. Below is a list of AT commands you can use.
@@ -667,7 +667,7 @@
  **AT Commands**
  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
--* **AT+SUBTOPIC=<MQTT subscribe topic> **
++* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
  * **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
  * **AT+CLIENT=null**
  * **AT+UNAME=<MQTT Username>**
@@ -675,11 +675,13 @@
  * **AT+SERVADDR=<Broker address, Port>**
  Test your uplink by pressing the ACT button for 1 second.
++
  The following image shows the uplink payload of a real Dragino device. The publish topic is **TS01-NB**, and the device name is **861275077962896**, which is represented by the **IMEI**.
--[[image:image-4.png]]
++{{info}}
++The ThingsBoard uses the device's IMEI number included in the payload to create a device in the Devices section.
++{{/info}}
--
--
++[[image:image-4.png]]

Screenshot 2025-03-16 at 18.39.12.png

Size

@@ -1,1 +1,1 @@
--277.0 KB
++211.9 KB

Content

add-integration-basic-settings.png

Size

@@ -1,1 +1,1 @@
--122.5 KB
++123.8 KB

Content

add-integration-connection.png

Size

@@ -1,1 +1,1 @@
--153.2 KB
++158.1 KB

Content

integration-active.png

Size

@@ -1,1 +1,1 @@
--64.2 KB
++64.1 KB

Content

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

Screenshot 2025-03-26 at 19.47.52.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+168.4 KB

Content

Screenshot 2025-03-26 at 19.49.31.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+133.0 KB

Content

add-integartion-connection.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+110.3 KB

Content

add-integartion-connetcion.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+146.0 KB

Content

add-integration-ul-data-converter.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+121.2 KB

Content

debug-enabled.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+196.3 KB

Content

integration-added.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+196.2 KB

Content

integration-dl-skip.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+105.5 KB

Content

ul-data-converter-added.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+189.4 KB

Content

ul-data-converter-device-a.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.pradeeka

Size

...	...	@@ -1,0 +1,1 @@
	1	+168.3 KB

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation