Changes for page ThingsBoard

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

From 166.1 to 165.1 From 174.1 to 173.1

From version 173.1

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

Change comment: Uploaded new attachment "add-integration-connection.png", version {1}

To version 166.1

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

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

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (1 modified, 0 added, 1 removed)
- add-integration-connection.png
- integration-dl-skip.png

Details

Page properties

Content

@@ -329,10 +329,72 @@
  [[image:data-converter-list-showing-uplink-dc.png]]
++== 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
++
++// 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 =
@@ -376,17 +376,15 @@
  **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: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)
@@ -395,7 +395,7 @@
  * **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, even you can use just the device name, for example ts02-nb)
++* **Topic: v1/devices/+/telemetry** (the + replaces any 'device name' will create a device in the Entities -> Devices)
  * **QoS:** 0-At most once
  [[image:add-integration-connection.png||height="511" width="500"]]
@@ -472,46 +472,29 @@
  [[image:new-device.png]]
--== 5.3 Viewing messages ==
++Click on the **MQTT integration NB/CB **list in the **Integrations** page to see its details.
++Then go to the **Events** tab.
--Go back to the **Integrations** page.
++You can see the uplink message you sent from the MQTT broker.
--Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
--Click on the **Edit** button (//**pen icon**//).
++[[image:Screenshot 2025-03-16 at 18.38.59.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.
--Click on the **Apply** button.
--Then click on the **Apply changes** (//**tick icon**//) button.
++Now 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-18 at 09.23.10.png]]
--
--
--Now go to the **Events** tab.
--
--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.
--
--
--[[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.
++
  = 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.
@@ -520,11 +520,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.
@@ -581,11 +581,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}}
@@ -598,7 +598,7 @@
  = 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.
@@ -606,8 +606,8 @@
  **AT Commands**
  * **AT+PRO=3,3    **~/~/ Use MQTT to connect to ThingsBoard. Payload Type set to 3.
--* **AT+SUBTOPIC=<MQTT subscribe topic> **
--* **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>**
@@ -614,16 +614,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]]
--
--
--

add-integration-connection.png

Size

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

Content

integration-dl-skip.png

Author

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

Size

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

Content

Changes for page ThingsBoard

Summary

Details

Applications

Navigation