Wiki source code of ThingsBoard

Version 113.1 by Dilisi S on 2025/03/08 20:00
Show last authors
1 **Table of Contents:**
2
3 {{toc/}}
4
5 {{warning}}
6 Draft Document
7 {{/warning}}
8
9
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 [[image:data-converter-list-showing-uplink-dc.png]]
90
91
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
99 [[image:create-new-converter-menu.png||width="500"]]
100
101
102
103 The **Add data converter** window will appear. Name it ‘**MQTT Downlink Converter NB/CB**’ and select the Type as **Downlink**.
104
105 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.
106
107
108 {{code language="JavaScript"}}
109 // Encode downlink data from incoming Rule Engine message
110
111 // msg - JSON message payload downlink message json
112 // msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
113 // metadata - list of key-value pairs with additional data about the message
114 // integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
115
116 /** Encoder **/
117
118 var data = {};
119
120 // Process data from incoming message and metadata
121
122 data.tempFreq = msg.temperatureUploadFrequency;
123 data.humFreq = msg.humidityUploadFrequency;
124
125 data.devSerialNumber = metadata['ss_serialNumber'];
126
127 // Result object with encoded downlink payload
128 var result = {
129
130 // downlink data content type: JSON, TEXT or BINARY (base64 format)
131 contentType: "JSON",
132
133 // downlink data
134 data: JSON.stringify(data),
135
136 // Optional metadata object presented in key/value format
137 metadata: {
138 topic: metadata['deviceType']+'/'+metadata['deviceName']+'/upload'
139 }
140
141 };
142
143 return result;
144 {{/code}}
145
146
147 Click on the **Add** button.
148
149
150
151 [[image:add-downlink-data-converter.png||height="529" width="500"]]
152
153
154 You should see that the newly added **MQTT Downlink** Converter NB/CB is listed on the **Data Converters** page.
155
156
157 [[image:data-converters-list.png]]
158
159 (% class="wikigeneratedid" %)
160
161
162 = 3. Add Integration =
163
164
165 In the left navigation, click **Integrations center**, and then click **Integrations**.
166
167
168 [[image:integrations-list-empty.png]]
169
170
171 On the **Integrations** page, click on the '**+**' button.
172
173
174 The **Add integration** window appears.
175
176 In the **Add integration** window, configure the following settings:
177
178
179 **Basic settings:**
180
181 * **Integration type**: MQTT
182 * **Name**: MQTT integration NB/CB
183 * **Enable integration**: YES
184 * **Allows create devices or assets**: YES
185
186 Click **Next** button.
187
188
189
190 [[image:add-integration-basic-settings.png||height="511" width="500"]]
191
192
193 **Uplink data converter:**
194
195 * Click on the **Select existing** button.
196 * **Uplink data converter**: Select **MQTT Uplink Converter NB/CB **from the dropdown list.
197
198 Click **Next** button.
199
200
201
202 [[image:add-integration-uplink-data-converter.png||height="511" width="500"]]
203
204
205 **Downlink data converter:**
206
207 * Click on the **Select existing** button.
208 * **Downlink data converter**: Select **MQTT Downlink Converter NB/CB **from the dropdown list.
209
210 Click **Next** button.
211
212
213
214 [[image:add-integration-downlink-data-converter.png||height="511" width="500"]]
215
216
217 **Connection:**
218
219 * **Host**: Cluster URL (Eg. 011731f7928541588a6cdfbbedfc63f4.s1.eu.hivemq.cloud)
220 * **Port**: 8883
221 * **Credentials**: Basic
222 * **Enable SSL**: YES
223 * **Username**: Username (from your HiveMQ Cloud Cluster with your credentials)
224 * **Password:** Password (from your HiveMQ Cloud Cluster with your credentials)
225 * **Topic:** tb/mqtt-integration-tutorial/sensors/+/telemetry (the + replaces any 'device name' and creates devices in the Entities -> Devices)
226 * **QoS:** 0-At most once
227
228
229 [[image:add-integration-connection.png||height="511" width="500"]]
230
231
232 Click on the **Advanced settings** button.
233
234 * **Clean session:** NO
235 * **Retained**: NO
236
237 [[image:add-integration-connection-advanced-settings.png||height="510" width="500"]]
238
239
240 Click on the **Check connection** button to verify the MQTT connection using the provided parameters.
241
242
243
244 [[image:check-connection.png||height="83" width="300"]]
245
246
247 If the connection is successful, you will see the **Connected** message.
248
249
250 [[image:connection-success.png||height="511" width="500"]]
251
252
253 Click on the **Add** button.
254
255
256
257 You should see that the newly added integration is listed on the **Integrations** page.
258
259 Since we haven't received data from a device yet, the integration **Status** is shown as **Pending.**
260
261 [[image:integrations-list-added-pending.png]]
262
263
264 = 5. Verifying the receipt of data from the device =
265
266
267 On the terminal, issue the following MQTT command which simulates the device S31B-NB.
268
269 {{code language="none"}}
270 mosquitto_pub -d -q 1 -h mqtt.eu.thingsboard.cloud -p 1883 -t v1/devices/S31B-NB/telemetry -u "24vk3w9h7sqdld1me5eh" -m "{temperature:20}"
271 {{/code}}
272
273 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.

Applications

Navigation

Copyright ©2010-2024 Dragino Technology Co., LTD. All rights reserved
Dragino Wiki v2.0