Changes for page ThingsBoard

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

From 165.1 to 166.1 From 176.1 to 177.1

From version 166.1

edited by Dilisi S
on 2025/03/19 03:34

Change comment: Uploaded new attachment "image-4.png", version {1}

To version 176.1

edited by Dilisi S
on 2025/03/26 20:27

Change comment: Mar 26 edits - part 1

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -164,13 +164,33 @@
  [[image:ins1.png||height="310" width="500"]]
--= 3. Data Converters =
++(% class="wikigeneratedid" %)
++= 3. Creating Devices =
++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.
--== 3.1 Uplink ==
++== 4.1 Uplink ==
  In the left navigation, click **Integrations center**, and then click **Data converters**.
@@ -192,6 +192,9 @@
  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.
++{{info}}
++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.
++{{/info}}
  {{code language="JavaScript"}}
  //Version: 0.1
@@ -329,75 +329,9 @@
  [[image:data-converter-list-showing-uplink-dc.png]]
--== 3.2 Downlink ==
++= 5. Add Integration =
--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
--
--// 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
--
--/** Encoder **/
--
--var data = {};
--
--// Process data from incoming message and metadata
--
--data.tempFreq = msg.temperatureUploadFrequency;
--data.humFreq = msg.humidityUploadFrequency;
--
--data.devSerialNumber = metadata['ss_serialNumber'];
--
--// Result object with encoded downlink payload
--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'
--    }
--
--};
--
--return result;
--{{/code}}
--
--
--Click on the **Add** button.
--
--
--[[image:add-downlink-data-converter.png||height="529" width="500"]]
--
--
--You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
--
--
--[[image:data-converters-list.png]]
--
--
--= 4. Add Integration =
--
--
  In the left navigation, click **Integrations center**, and then click **Integrations**.
@@ -438,15 +438,17 @@
  **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)
@@ -455,9 +455,10 @@
  * **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/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
++* **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.)
  * **QoS:** 0-At most once
++
  [[image:add-integration-connection.png||height="511" width="500"]]
@@ -488,14 +488,13 @@
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
--
  [[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.
@@ -532,31 +532,48 @@
  [[image:new-device.png]]
--Click on the **MQTT integration NB/CB **list in the **Integrations** page to see its details.
++== 6.3 Viewing messages ==
--Then go to the **Events** tab.
--You can see the uplink message you sent from the MQTT broker.
++Go back to the **Integrations** page.
++Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
--[[image:Screenshot 2025-03-16 at 18.38.59.png]]
++Click on the **Edit** button (//**pen icon**//).
++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.
++Click on the **Apply** button.
--Now click on the **three dots (...)** in the **Message** column. You can see the uplink message's **payload** in the **Message** window.
++Then click on the **Apply changes** (//**tick icon**//) button.
--[[image:Screenshot 2025-03-16 at 18.39.12.png]]
++[[image:Screenshot 2025-03-18 at 09.23.10.png]]
++Now go to the **Events** tab.
--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.
++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.
--= 6. Creating a Dashboard =
++[[image:Screenshot 2025-03-16 at 18.38.59.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]]
++
++
++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.
@@ -563,6 +563,11 @@
  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.
@@ -619,11 +619,11 @@
  {{code language="none"}}
--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": 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":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": 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":18, "humidity":79}'
++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}'
  {{/code}}
@@ -633,10 +633,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.
@@ -644,8 +644,8 @@
  **AT Commands**
  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
--* **AT+SUBTOPIC=<MQTT topic>**
--* **AT+PUBTOPIC=<MQTT topic>**
++* **AT+SUBTOPIC=<MQTT subscribe topic> Eg: TS01-NB**
++* **AT+PUBTOPIC=<MQTT publish topic> Eg: TS01-NB**
  * **AT+CLIENT=null**
  * **AT+UNAME=<MQTT Username>**
  * **AT+PWD=<MQTT Password>**
@@ -652,3 +652,16 @@
  * **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.39.12.png

Size

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

Content

add-integration-connection.png

Size

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

Content

integration-dl-skip.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation