Changes for page How to Uplink -NB and -CB series devices data by MQTT with Thingseye

Last modified by Alec Chen on 2025/04/02 18:03

From 2.2 to 2.1 From 9.1 to 8.1

From version 8.1

edited by Alec Chen
on 2025/04/02 17:57

Change comment: There is no comment for this version

To version 2.2

edited by Alec Chen
on 2025/04/02 16:28

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 1 removed)
- 1743584347047-327.png

Details

Page properties

Title

@@ -1,1 +1,1 @@
--How to Uplink -NB and -CB series devices data by MQTT with Thingseye
++How to communice Dragino -NB and -CB series devices data by MQTT with Thingseye

Content

@@ -1,7 +1,5 @@
  **Table of Contents:**
--{{toc/}}
--
  = 1. Introduction =
  This document guides you on integrating Dragino **-NB** and **-CB** series devices data with Thingseye.
@@ -17,10 +17,132 @@
  [[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/ins1.png?width=500&height=310&rev=1.1||alt="ins1.png" height="310" width="500"]]
--= (% style="color:#333333; font-family:inherit; font-size:max(23px, min(29px, 12.3333px + 1.38889vw))" %)3. Configure Thingseye's Integration(%%) =
++= 3.General MQTT Connection =
--== 3.1 Creat new MQTT integration ==
++The NB-IoT Sensor can send packet to server use MQTT protocol.
++Below are the commands.
++
++**AT Commands:**
++
++{{code language="none"}}
++AT+PRO=3,0                           //  Set to use MQTT protocol to uplink, Payload Type select Hex payload.
++AT+SERVADDR=120.24.4.116,1883        //  Set MQTT server address and port
++AT+CLIENT=CLIENT                     //  Set up the CLIENT of MQTT
++AT+UNAME=UNAME                       //  Set the username of MQTT
++AT+PWD=PWD                           //  Set the password of MQTT
++AT+PUBTOPIC=NSE01_PUB                //  Set the sending topic of MQTT
++AT+SUBTOPIC=NSE01_SUB                //  Set the subscription topic of MQTT
++{{/code}}
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20230802112413-4.png?rev=1.1||alt="image-20230802112413-4.png"]]
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20230802112413-5.png?width=987&height=530&rev=1.1||alt="image-20230802112413-5.png" height="530" width="987"]]
++
++(% class="text-uppercase small mark" %)##**Notice: MQTT protocol has a much higher power consumption compare with UDP/CoAP protocol. Please check the power analyze document and adjust the uplink**##
++
++(% class="text-uppercase small mark" %)##**period to a suitable interval.**##
++
++= 4. Data Converters =
++
++In **Thingseye**, **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 Thingseye can understand, or vice versa.
++
++== 4.1 Uplink ==
++
++In the left navigation, click **Integrations center**, and then click **Data converters**.
++
++On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
++
++[[image:1743578461281-635.png]]
++
++
++
++
++The **Add data converter** window will appear.
++
++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**.
++
++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:
++
++* Uncomment** line 11**:
++
++//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.
++
++//telemetry: {
++       temperature: data.temperature,
++       humidity: data.humidity,
++       rawData: payloadStr
++   }//
++
++The modified uplink decoder function to match with **Device A** is shown below.
++
++{{code language="nono"}}
++// Decode an uplink message from a buffer
++// payload - array of bytes
++// metadata - key/value object
++
++/** Decoder **/
++
++// decode payload to string
++var payloadStr = decodeToString(payload);
++
++// decode payload to JSON
++var data = decodeToJson(payload);
++
++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';
++
++// 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: data.temperature,
++       humidity: data.humidity,
++       rawData: payloadStr
++   }
++};
++
++/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
++
++return result;
++{{/code}}
++
++Once you modify the decoder function, click on the **Add** button.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/ul-data-converter-device-a.png?width=500&height=524&rev=1.1||alt="ul-data-converter-device-a.png"]]
++
++You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/ul-data-converter-added.png?height=257&rev=1.1||alt="ul-data-converter-added.png"]]
++
++= 5. Add Integration =
++
++== 5.1. Creat new MQTT integration ==
++
  In the left navigation, click **Integrations center**, and then click **Integrations**.
  On the **Integrations** page, click on the '**+**' button.
@@ -80,7 +80,7 @@
  [[image:1743579352961-586.png||height="507" width="502"]]
--[[image:1743584347047-327.png]]
++[[image:1743580606618-281.png||height="495" width="504"]]
  Click on the **Add** button.
@@ -89,16 +89,13 @@
  Since we haven't received data from a device yet, the integration **Status** is shown as **Pending,  Active  instead if it have.**
--[[image:1743580606618-281.png||height="495" width="504"]]
--= 4. Configure Thingseye's Data Converters =
--First, you need to download the [[**MQTT uplink/downlink JS** **code**>>url:https://www.dropbox.com/scl/fo/d5s1wf36f4syv30a8laup/AK8FjVpNXYXCWodRnnQ1Hig?rlkey=jrz1ip0f0xwwq5z2m2gu1tuij&e=1&st=kl4caub0&dl=0]].
--In **Thingseye**, **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 Thingseye can understand, or vice versa.
++== 5.2. Setup uplink and downlink converters ==
--== 4.1 Uplink ==
++First, you need to download the [[**MQTT uplink/downlink JS** **code**>>url:https://www.dropbox.com/scl/fo/d5s1wf36f4syv30a8laup/AK8FjVpNXYXCWodRnnQ1Hig?rlkey=jrz1ip0f0xwwq5z2m2gu1tuij&e=1&st=kl4caub0&dl=0]].
  * **Uplink Converter**
@@ -114,12 +114,8 @@
  [[image:1743581965585-763.png]]
--== 4.2 Downlink ==
++* **Downlink Converter**
--* (((
--**Downlink Converter**
--)))
--
  Go to the **Integrations center** -> **Data converters** page, and find that MQTT downlink converter that was newly created when the integration was created.
@@ -127,60 +127,165 @@
  [[image:1743582084494-111.png]]
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126190737-17.png?width=1114&height=527&rev=1.1||alt="image-20241126190737-17.png" height="527" width="1114"]]
--== 4.3 Simulate with MQTT.fx ==
--[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126191118-18.png?width=835&height=605&rev=1.1||alt="image-20241126191118-18.png"]]
--[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126193252-25.png?width=803&height=663&rev=1.1||alt="image-20241126193252-25.png"]]
++==  ==
++== 6. Verifying the receipt of data from virtual devices ==
--= 5. Configure Physical NB-IoT Sensor =
++== 6.1 How does it work? ==
--First you need to configure the certificate to the -NB node. Follow the instructions in this **[[link>>url:https://wiki.dragino.com/xwiki/bin/view/Dragino%20NB%20device%20connection%20to%20AWS%20platform%20instructions/#H4.1.2Configurecertificate]]** to configure the certificate.
++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.
--Screenshot of successful certificate configuration:
++The Mosquitto client publishes messages (payloads) on the topic **/device/a**. Of course, you can use any topic for testing.
--* Configuring the CA Certificate
++The MQTT payload format is as follows:
--[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126192009-19.png?width=697&height=431&rev=1.1||alt="image-20241126192009-19.png" height="431" width="697"]]
++{{code language="none"}}
++{"IMEI": "350693903995577", "temperature":25, "humidity":80, "pressure":1005}
++{{/code}}
--[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126192130-21.png?width=694&height=426&rev=1.1||alt="image-20241126192130-21.png" height="426" width="694"]]
++Once Thingseye receives this message, it forwards this payload to the matching device through the integration.
--* Configure client certificate
++== 5.2 Sending messages ==
--[[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126192246-22.png?width=693&height=397&rev=1.1||alt="image-20241126192246-22.png" height="397" width="693"]][[image:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126192315-23.png?width=645&height=402&rev=1.1||alt="image-20241126192315-23.png" height="402" width="645"]]
++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.
--* Configure client private key
++{{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:https://wiki.dragino.com/xwiki/bin/download/Main/General%20Configure%20to%20Connect%20to%20IoT%20server%20for%20-NB%20%26%20-NS%20NB-IoT%20models/WebHome/image-20241126192415-24.png?width=737&height=435&rev=1.1||alt="image-20241126192415-24.png" height="435" width="737"]]
++If the integration was performed without errors, the status of the integration changes to 'Active' after the first telemetry transmission.
--When the certificate is configured, burn the boot program, burn the working firmware, and then restart the device.
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/integration-active.png?rev=1.2||alt="integration-active.png"]]
--Then configure the -NB node to connect to the ThingsEye platform:
++== 6.3 Viewing messages ==
--**AT Commands**
++Go back to the **Integrations** page.
--* **AT+PRO=3,5      **~/~/ Use MQTT Connection & Json Payload
--* **AT+SERVADDR=lns1.thingseye.io,8883**
--* **AT+SUBTOPIC=8899     **~/~/ Consistent with the Topic of MQTT integration created by ThingsEye
--* **AT+PUBTOPIC=8899     **~/~/ Consistent with the Topic of MQTT integration created by ThingsEye
--* **AT+CLIENT=NULL**
--* **AT+UNAME=NULL**
--* **AT+PWD=NULL**
--* **AT+TLSMOD=1,2**
++Click on the **MQTT integration NB/CB** in the **Integrations** page to see its details.
--(% class="box warningmessage" %)
++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.
++
++Then click on the **Apply changes** (//**tick icon**//) button.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/debug-enabled.png?width=700&height=301&rev=1.1||alt="debug-enabled.png"]]
++
++Now go to the **Events** tab.
++
++Select the **Event type** as **Debug** from the dropdown list.
++
++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:
++
++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}'
++
++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:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/Screenshot%202025-03-26%20at%2019.49.31.png?rev=1.1||alt="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:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/Screenshot%202025-03-26%20at%2019.47.52.png?rev=1.1||alt="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 Thingseye, and the device is provisioned.
++
++= 7. Creating a Dashboard =
++
++Thingseye **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.
++
++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 Thingseye 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 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":22, "humidity":80, "pressure":1005}'
++
++{{/code}}
++
++In **Thingseye**, from the left navigation menu, click **Dashboards**. Then, click the **+** button and select **Create new dashboard** from the dropdown menu.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/dashboard-1.png?rev=1.1||alt="dashboard-1.png"]]
++
++In the **Title** text box, enter **NB/CB Test Dashboard** as the title of the dashboard.
++
++Click on the **Add** button.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/dashboard-2.png?width=500&height=526&rev=1.1||alt="dashboard-2.png"]]
++
++Click on the **Add widget / Add new widget** button.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/dashboard-3.png?rev=1.1||alt="dashboard-3.png"]]
++
++In the **Select widgets bundle** window, click **Charts**.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/dashboard-4.png?width=700&height=537&rev=1.1||alt="dashboard-4.png"]]
++
++In the **Charts: select widget** window, click **Time series chart**.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/dashboard-5.png?width=700&height=525&rev=1.1||alt="dashboard-5.png"]]
++
++Configure the **Time series chart** widget as follows:
++
++* **Datasource** - select **Device A** device you provisioned.
++* **Series**:
++** **temperature** - you can see this key by default.
++** **humidity** - Click **Add series** button. Then add the **humidity** for the key and then type **%** as its unit.
++* Click on the **Add** button.
++
++(% class="box infomessage" %)
  (((
--Be careful, “ Topic” should be same of device & serve. If your device not belongs Dragino, address should be same of the broker which using.
++You can add only the relevant fields from the device's payload to display data on a widget. These fields are called 'keys'.
  )))
--Test Uplink by click the button for 1~~3 seconds, the MQTT integration in ThingsEye allows you to view the data upstream from the device:
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/Screenshot%202025-03-31%20at%2006.51.15.png?width=700&height=485&rev=1.1||alt="Screenshot 2025-03-31 at 06.51.15.png"]]
++The time-series chart will appear in edit mode. Resize it by clicking and dragging the lower-right corner.
++Click the **Save** button to add the widget to the dashboard.
--Go to **"Device" ** -> ** "Search Device"**, enter the ** IMEI** of the device to find the device.
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/timeseries-3.png?width=700&height=347&rev=1.1||alt="timeseries-3.png"]]
++Now send the following MQTT messages from the terminal to simulate the data.
++{{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":22, "humidity":70, "pressure":1005}'
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":27, "humidity":72, "pressure":1005}'
++
++mosquitto_pub -d -q 1 -h 011731f7928xxxxx.s1.eu.hivemq.cloud -p 8883 -u "xxxxx" -P "xxxxx" -t "device/a" -m '{"IMEI":"350693903995577", "temperature":19, "humidity":80, "pressure":1005}'
++{{/code}}
++
++The chart will update with the values in realtime, as shown in the below image.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/timeseries-4.png?width=700&height=316&rev=1.1||alt="timeseries-4.png"]]
++
++= 8. Configure Physical NB-IoT Sensor =
++
++Now, let's experiment with sending data to Thingseye 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.
++
++**AT Commands**
++
++* **AT+PRO=3,3    **~/~/ Use MQTT to connect to Thingseye. Payload Type set to 3.
++* **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>**
++* **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' that contains fields in the payload, IMEI, IMSI, Model, temperature, etc**. Note that we have created a device named **TS01-NB** in the **Devices** section in advance.
++
++[[image:https://wiki.dragino.com/xwiki/bin/download/Main/ThingsBoard/image-4.png?rev=1.2||alt="image-4.png"]]

1743584347047-327.png

Author

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

Size

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

Content

Changes for page How to Uplink -NB and -CB series devices data by MQTT with Thingseye

Summary

Details

Applications

Navigation