Skip to Content

Changes for page ThingsBoard

Last modified by Dilisi S on 2025/04/23 19:23
From version 94.1
edited by Dilisi S
on 2025/03/08 04:04
Change comment: There is no comment for this version
To version 10.1
edited by Dilisi S
on 2025/03/03 02:31
Change comment: Uploaded new attachment "ThingsBoard-add-integration.png", version {1}

Summary

Details

Page properties
Content
... ... @@ -2,244 +2,9 @@
2 2  
3 3  {{toc/}}
4 4  
5 -{{warning}}
6 -Draft Document
7 -{{/warning}}
8 8  
6 += Introduction =
9 9  
8 +This document guides you on integrating Dragino -NB and -CB series devices with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
10 10  
11 -
12 -= 1. Introduction =
13 -
14 -
15 -This document guides you on integrating Dragino **-NB** and **-CB** series devices data with ThingsBoard. For this guide, we use ThingsBoard Cloud, which is one of the ThingsBoard versions that allows you to try it for free.
16 -
17 -The **NB series** devices end with the suffix **-NB**, and the **CB series** devices end with the suffix **-CB**. For example, **S31B-NB** is an **NB device**, and **S31-CB** is a **CB device**.
18 -
19 -
20 -
21 -
22 -
23 -= 2. Data Converters =
24 -
25 -
26 -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.
27 -
28 -
29 -== 2.1 Uplink ==
30 -
31 -
32 -In the left navigation, click **Integrations center**, and then click **Data converters**.
33 -
34 -
35 -
36 -[[image:data-converters-list-empty.png]]
37 -
38 -
39 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
40 -
41 -
42 -
43 -[[image:create-new-converter-menu.png||height="259" width="500"]]
44 -
45 -
46 -The **Add data converter** window will appear. Name it ‘**MQTT Uplink Converter NB/CB**’ and select the Type as **Uplink**.
47 -
48 -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.
49 -
50 -{{code language="JavaScript"}}
51 -/** Decoder **/
52 -
53 -// decode payload to string
54 -var payloadStr = decodeToString(payload);
55 -var data = JSON.parse(payloadStr);
56 -
57 -var deviceName = metadata.topic.split("/")[3];
58 -// decode payload to JSON
59 -var deviceType = 'sensor';
60 -
61 -// Result object with device attributes/telemetry data
62 -var result = {
63 - deviceName: deviceName,
64 - deviceType: deviceType,
65 - attributes: {
66 - integrationName: metadata['integrationName'],
67 - },
68 - telemetry: {
69 - temperature: data.temperature,
70 - humidity: data.humidity,
71 - }
72 -};
73 -
74 -/** Helper functions 'decodeToString' and 'decodeToJson' are already built-in **/
75 -
76 -return result;
77 -{{/code}}
78 -
79 -
80 -Click on the **Add** button.
81 -
82 -
83 -
84 -[[image:add-uplink-data-converter.png||height="529" width="500"]]
85 -
86 -
87 -You should see that the newly added **MQTT Uplink converter **NB/CB is listed on the **Data Converters** page.
88 -
89 -
90 -
91 -[[image:create-new-converter-menu.png||width="500"]]
92 -
93 -== 3.2 Downlink ==
94 -
95 -
96 -On the **Data converters** page, click on the ‘**+**’ button, and then click on the **Create new converter** from the dropdown menu.
97 -
98 -[[image:ThingsBoard-new-data-converter.png||height="282" width="500"]]
99 -
100 -
101 -The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
102 -
103 -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.
104 -
105 -
106 -{{code language="JavaScript"}}
107 -// Encode downlink data from incoming Rule Engine message
108 -
109 -// msg - JSON message payload downlink message json
110 -// msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
111 -// metadata - list of key-value pairs with additional data about the message
112 -// integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
113 -
114 -/** Encoder **/
115 -
116 -var data = {};
117 -
118 -// Process data from incoming message and metadata
119 -
120 -data.tempFreq = msg.temperatureUploadFrequency;
121 -data.humFreq = msg.humidityUploadFrequency;
122 -
123 -data.devSerialNumber = metadata['ss_serialNumber'];
124 -
125 -// Result object with encoded downlink payload
126 -var result = {
127 -
128 - // downlink data content type: JSON, TEXT or BINARY (base64 format)
129 - contentType: "JSON",
130 -
131 - // downlink data
132 - data: JSON.stringify(data),
133 -
134 - // Optional metadata object presented in key/value format
135 - metadata: {
136 - topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
137 - }
138 -
139 -};
140 -
141 -return result;
142 -{{/code}}
143 -
144 -
145 -Click on the **Add** button.
146 -
147 -
148 -
149 -[[image:add-downlink-data-converter.png||height="529" width="500"]]
150 -
151 -
152 -You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
153 -
154 -
155 -
156 -[[image:data-converters-list.png]]
157 -
158 -= 3. Add Integration =
159 -
160 -
161 -In the left navigation, click **Integrations center**, and then click **Integrations**.
162 -
163 -On the **Integrations** page, click on the '**+**' button.
164 -
165 -[[image:data-converter-list-page.png]]
166 -
167 -
168 -The **Add integration** window appears.
169 -
170 -In the **Add integration** window, configure the following settings:
171 -
172 -
173 -**Basic settings:**
174 -
175 -* **Integration type**: MQTT
176 -* **Name**: MQTT integration NB/CB
177 -
178 -Click **Next** button.
179 -
180 -[[image:add-integration-basic-settings.png||height="511" width="500"]]
181 -
182 -
183 -**Uplink data converter:**
184 -
185 -* Click on the **Select existing** button.
186 -* **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
187 -
188 -Click **Next** button.
189 -
190 -[[image:add-integration-uplink-data-converter.png||width="500"]]
191 -
192 -
193 -**Downlink data converter:**
194 -
195 -* Click on the **Select existing** button.
196 -* **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
197 -
198 -Click **Next** button.
199 -
200 -[[image:add-integration-downlink-data-converter.png||height="510" width="500"]]
201 -
202 -
203 -**Connection:**
204 -
205 -* **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
206 -* **Port**: 8883
207 -* **Credentials**: Basic
208 -* **Enable SSL**: YES
209 -* **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
210 -* **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
211 -* **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
212 -* **QoS:** 0-At most once
213 -* **Clean session:** NO
214 -* **Retained**: NO
215 -
216 -Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
217 -
218 -[[image:add-integration-connection.png||width="500"]]
219 -
220 -
221 -If the connection is successful, you will see the **Connected** message.
222 -
223 -Click on the **Add** button.
224 -
225 -[[image:add-connection-success.png||height="511" width="500"]]
226 -
227 -
228 -You should see that the newly added integration is listed on the **Integrations** page.
229 -
230 -Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
231 -
232 -[[image:integrations-list-added-pending.png]]
233 -
234 -
235 -= 5. Verifying the receipt of data from the device =
236 -
237 -
238 -On the terminal, issue the following MQTT command which simulates the device S31B-NB.
239 -
240 -{{code language="none"}}
241 -mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
242 -{{/code}}
243 -
244 -If the integration was performed without errors, after the transmission of the first telemetry, a new device with the name “S31B-NB” will appear in the Devices → All. Also, you can verify the input and output data, respectively, before and after conversion in Data converters → UDP Uplink Converter NB/CB → Events.
245 -
10 +
add-downlink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -175.2 KB
Content
add-uplink-data-converter.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -174.1 KB
Content
create-new-converter-menu.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -31.5 KB
Content
data-converters-list-empty.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -260.7 KB
Content
data-converters-list.png
Author
... ... @@ -1,1 +1,0 @@
1 -XWiki.pradeeka
Size
... ... @@ -1,1 +1,0 @@
1 -212.2 KB
Content
ThingsBoard-Data-Converters.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content
ThingsBoard-Device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +225.5 KB
Content
ThingsBoard-add-data-converter-downlink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-data-converter-uplink.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-integration.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +128.6 KB
Content
ThingsBoard-add-new-device.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +89.7 KB
Content
ThingsBoard-new-data-converter.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.pradeeka
Size
... ... @@ -1,0 +1,1 @@
1 +100.3 KB
Content