Changes for page ThingsBoard

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

From 153.1 to 152.1 From 178.1 to 177.1

From version 177.1

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

Change comment: Mar 26 edits - part 2

To version 153.1

edited by Dilisi S
on 2025/03/17 00:09

Change comment: Uploaded new attachment "emqx.png", version {1}

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -22,10 +22,7 @@
  To complete this tutorial, you need to have the following:
  * ThingsBoard cloud account
--* MQTT Broker (public or private) such as,
--** **[[HiveMQ Cloud>>https://www.hivemq.com]] - You can create a free account to try it or subscribe for a paid account. - We use HiveMQ Cloud as the MQTT broker to build example in this tutorial.**
--** [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] - The public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
--** [[lns1.thingseye.io>>http://lns1.thingseye.io/]] - This is Dragino's MQTT broker, which requires a CA certificate to use.
++* HiveMQ Cloud account
  == 2.1 ThingsBoard Cloud ==
@@ -69,9 +69,7 @@
  == 2.2 HiveMQ Cloud ==
--=== 2.2.1 HiveMQ Cloud ===
--
  Go to [[https:~~/~~/www.hivemq.com>>https://www.hivemq.com]]
  Click on the **Start Free** button.
@@ -146,152 +146,147 @@
  You will need these MQTT connection parameters when configuring the MQTT integration in the '**Add Integration**' section.
--=== 2.2.2 emqx ===
++= 3. Data Converters =
--The [[emqx>>https://www.emqx.com/zh/mqtt/public-mqtt5-broker]] public MQTT server is only used for MOTT learning and testing, and should not be used in the production environment.
++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.
--[[image:emqx.png||height="420" width="500"]]
++== 3.1 Uplink ==
--=== 2.2.3 Ins1.thingseye.io ===
++In the left navigation, click **Integrations center**, and then click **Data converters**.
--[[lns1.thingseye.io>>http://lns1.thingseye.io/]] is the Dragino's MQTT broker, which requires a CA certificate file, Certificate file, and the Private key file to use.
--If customers need to use this MQTT connection with ThingsBoard, they need to contact the TE team to obtain three license files.
--[[image:ins1.png||height="310" width="500"]]
++[[image:data-converters-list-empty.png]]
--= 3. Creating Devices =
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
--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.
++[[image:create-new-converter-menu.png||height="259" width="500"]]
--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**.
++The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
--In the **Add new device** dialog box, enter the device name in the **Name** text box. For example, we will use **Device A**.
++Click on the **TBEL** button if not selected it by default. Delete the existing decoder function in the code editor. Now copy and paste the following decoder function written in **TBEL (ThingsBoard Expression Language)** in to the **code editor**. This decoder function is compatible for both NB and CB series devices.
--Click the **Add** button.
++{{code language="JavaScript"}}
++/** Decoder **/
--Skip the **connectivity testing** by clicking the **Close** button.
++// decode payload to string
++var payloadStr = decodeToString(payload);
++var data = JSON.parse(payloadStr);
--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.
++var deviceName =  metadata.topic.split("/")[3];
++// decode payload to JSON
++var deviceType = 'sensor';
++// Result object with device attributes/telemetry data
++var result = {
++    deviceName: deviceName,
++    deviceType: deviceType,
++    attributes: {
++        integrationName: metadata['integrationName'],
++    },
++    telemetry: {
++        temperature: data.temperature,
++        humidity: data.humidity,
++    }
++};
--= 4. Data Converters =
++/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++return result;
++{{/code}}
--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.
++Click on the **Add** button.
--== 4.1 Uplink ==
--In the left navigation, click **Integrations center**, and then click **Data converters**.
++[[image:add-uplink-data-converter.png||height="529" width="500"]]
--[[image:data-converters-list-empty.png]]
++You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
++[[image:data-converter-list-showing-uplink-dc.png]]
--On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
++== 3.2 Downlink ==
--[[image:create-new-converter-menu.png||height="259" width="500"]]
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
--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.
++[[image:create-new-converter-menu.png||width="500"]]
--The default TBEL function is shown below.
++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"}}
--// Decode an uplink message from a buffer
--// payload - array of bytes
--// metadata - key/value object
++// Encode downlink data from incoming Rule Engine message
--/** Decoder **/
++// 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
--// decode payload to string
--var payloadStr = decodeToString(payload);
++/** Encoder **/
--// decode payload to JSON
--// var data = decodeToJson(payload);
++var data = {};
--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';
++// Process data from incoming message and metadata
--// Result object with device/asset attributes/telemetry data
--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
--   }
--};
++data.tempFreq = msg.temperatureUploadFrequency;
++data.humFreq = msg.humidityUploadFrequency;
--/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++data.devSerialNumber = metadata['ss_serialNumber'];
--return result;
--{{/code}}
++// Result object with encoded downlink payload
++var result = {
--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.
++    // downlink data content type: JSON, TEXT or BINARY (base64 format)
++    contentType: "JSON",
--For example, if your device name is **Device B**, you can change **Device A** to **Device B**.
++    // downlink data
++    data: JSON.stringify(data),
++    // Optional metadata object presented in key/value format
++    metadata: {
++            topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
++    }
--{{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"]]
++[[image:add-downlink-data-converter.png||height="529" width="500"]]
--You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
++You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
--[[image:data-converter-list-showing-uplink-dc.png]]
++[[image:data-converters-list.png]]
--= 5. Add Integration =
++= 4. Add Integration =
++
  In the left navigation, click **Integrations center**, and then click **Integrations**.
@@ -316,6 +316,7 @@
  Click **Next** button.
++
  [[image:add-integration-basic-settings.png||height="511" width="500"]]
@@ -327,31 +327,31 @@
  Click **Next** button.
++
  [[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
  **Downlink data converter:**
--Dragino NB/CB devices don't require a downlink data converter to decode their payloads, so you can skip this step.
++* Click on the **Select existing** button.
++* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
--* Click on the **Skip **button in the Downlink data converter section.
++Click **Next** button.
--Click **Skip** button.
--[[image:integration-dl-skip.png||height="511" width="500"]]
++[[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
--
  **Connection:**
--* **Host**: Cluster URL (Eg. **//011731f7xxxxxxxxxxxfbbedfc63f4.s1.eu.hivemq.cloud//**)
++* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.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:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
  * **QoS:** 0-At most once
  [[image:add-integration-connection.png||height="511" width="500"]]
@@ -384,35 +384,48 @@
  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.
--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 on the topic v1/devices/[device_name]/telemetry. The [device_name]placeholder can be replaced with any device name, for example, 'S31B-NB'. Then, the MQTT topic would be v1/devices/S31B-NB/telemetry.
--(% 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.
++On the ThingsBoard side, we configure the MQTT topic subscription as v1/devices/+/telemetry. The + wildcard represents any device name and allows ThingsBoard to automatically create (provision) a device with that name, such as S31B-NB, for example.
++
++**The new device is created the first time the MQTT topic is received. For subsequent MQTT topics with the same device name, no duplicate devices will be created.**
++
++
++For example, if you send two MQTT messages with different device names in the topic:
++
++1. v1/devices/**S31B-NB**/telemetry
++1. v1/devices/**LDS25-NB**/telemetry
++
++ThingsBoard will create two devices named **S31B-NB** and **LDS25-NB** in the **//Devices//** section.
++
++
++The MQTT payload format is as follows, which is common for all ~-~-NB and ~-~-CB series devices:
++
  {{code language="none"}}
--{"IMEI": "S31B-NB", "temperature": 27, ......}
++{"temperature":10.4, "humidity":85}
  {{/code}}
--Once ThingsBoard receives this message, it automatically creates (provisions) the device mentioned in the **IMEI**, for example, S31B-NB.
--
  == 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 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 10.4 and 85, 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 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":10.4, "humidity":85}'
  {{/code}}
  If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
@@ -424,51 +424,40 @@
  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**.
--[[image:new-device.png]]
++[[image:device-provision-1.png]]
--== 6.3 Viewing messages ==
++Click on the device S31B-NB on the devices list to see its details.
++Then go to the **Latest telemetry** tab.
--Go back to the **Integrations** page.
++You can see the fields temperature and humidity with the values you previously sent using the MQTT message.
--Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
--Click on the **Edit** button (//**pen icon**//).
++[[image:telemetry-1.png]]
--Click on the **Disabled** button in the upper-right corner.
--Turn on the **All messages (15 min)** option. This will enable displaying all messages in the **Events** tab. This setting will expire in 15 minutes, and you will need to repeat the same steps if you want to view the messages in the Events tab later.
++Now, change the values of the fields and send the MQTT message again. For example, set temperature to 20 and humidity to 70. Observe how the values update in //Latest Telemetry//.
--Click on the **Apply** button.
--Then click on the **Apply changes** (//**tick icon**//) button.
++[[image:telemetry-2.png]]
--[[image:Screenshot 2025-03-18 at 09.23.10.png]]
++Let's provision the second device named **LDS25-NB **with initial telemetry. Use the following MQTT message.
--Now go to the **Events** tab.
++{{code language="none"}}
++mosquitto_pub -d -q 1 -h 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/LDS25-NB/telemetry" -u "pradeeka" -P "Kalpani123@" -m '{"temperature":11, "humidity":87}'
++{{/code}}
--Select the Event type as **Debug** from the dropdown list.
++Now, refresh the **Devices** page, and you will see the second device, **LDS25-NB**, which was recently provisioned.
--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.
++[[image:device-provision-2.png]]
--[[image:Screenshot 2025-03-16 at 18.38.59.png]]
++= 6. Creating a Dashboard =
--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]]
--
--
--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 =
--
  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.
@@ -475,11 +475,6 @@
  This section guides you on how to create a dashboard to display temperature and humidity data from the device on a time-series chart. You may also use other widgets in ThingsBoard to display data according to your requirements.
--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}}
--
--
  In **ThingsBoard**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
@@ -536,11 +536,11 @@
  {{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":70}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":20, "humidity":70}'
--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, "humidity":72}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":22, "humidity":71}'
--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": 19, "humidity":80}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -t "tb/mqtt-integration-tutorial/sensors/S31B-NB/telemetry" -u "xxxxx" -P "xxxxx" -m '{"temperature":18, "humidity":79}'
  {{/code}}
@@ -550,10 +550,10 @@
  [[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**.
++Now, let's experiment with sending data to ThingsBoard using a real NB-IoT device. For example, we will use the **S31B-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.
@@ -561,8 +561,8 @@
  **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+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
++* **AT+SUBTOPIC=<MQTT topic>**
++* **AT+PUBTOPIC=<MQTT topic>**
  * **AT+CLIENT=null**
  * **AT+UNAME=<MQTT Username>**
  * **AT+PWD=<MQTT Password>**
@@ -569,16 +569,3 @@
  * **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**.
--
--{{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.38.59.png

Author

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

Size

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

Content

Screenshot 2025-03-16 at 18.39.12.png

Author

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

Size

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

Content

Screenshot 2025-03-18 at 09.23.10.png

Author

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

Size

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

Content

add-integration-connection.png

Size

@@ -1,1 +1,1 @@
--158.1 KB
++124.4 KB

Content

image-4.png

Author

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

Size

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

Content

ins1.png

Author

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

Size

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

Content

integration-dl-skip.png

Author

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

Size

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

Content

mqtt-uplink.png

Author

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

Size

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

Content

new-device.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation