Last modified by Hera Guo on 2025/09/25 09:23
From version 1.1
edited by Chxy
on 2024/10/08 12:52
Change comment: There is no comment for this version
To version 23.1
edited by Hera Guo
on 2025/09/25 09:18
Change comment: There is no comment for this version

Summary

Details

Page properties
Author
... ... @@ -1,1 +1,1 @@
1 -XWiki.EdwinChen
1 +XWiki.hera
Content
... ... @@ -1,9 +1,19 @@
1 1  
2 2  
3 -= 1. UDP Procotol  ~-~- Direction Connection =
3 +**Table of Contents:**
4 4  
5 -== 1.1 UDP Interface ==
5 +{{toc/}}
6 6  
7 +
8 += 1. Overview =
9 +
10 +This instructions will show you how to connect a device that has been registered to the server to the Thingseye platform.
11 +
12 +
13 += 2. UDP Procotol  ~-~- Directly Connection =
14 +
15 +== 2.1 UDP Interface ==
16 +
7 7  * Server Address: server1.thingseye.io
8 8  * Port: 11560
9 9  
... ... @@ -11,23 +11,322 @@
11 11  
12 12  Please contact ThingsEye team for detail how to forward data to client.
13 13  
24 +**Note：Currently udp connections require port forwarding, please contact the ThingsEye team to inform them of your device's IMEI before connecting.**
14 14  
15 -== 1.2 Test UDP Interface via Socket Tool ==
16 16  
17 -Download the UDP Test Tool from:  [[https:~~/~~/sourceforge.net/projects/sockettest/ >>https://sourceforge.net/projects/sockettest/]]. Run this tool, and input the server address and UDP port  as below and click send.
27 +----
18 18  
19 -[[image:1728362612869-443.png||height="454" width="540"]]
29 +== 2.2 Test with Dragino NB device ==
20 20  
21 -In server side, Tenant Administrator can check this in Tenant UDP Server location.
31 +=== 2.2.1 Configure NB-IoT End Node ===
22 22  
23 -[[image:1728362834430-749.png||height="510" width="1667"]]
33 +Device here is **[[S31-NB>>https://www.dragino.com/products/temperature-humidity-sensor/item/288-s31-nb-s31b-nb.html]]** : and have been configure below
24 24  
25 -Click and see the debug info as below:
35 +* Set to use ThingsEye UDP server: **AT+SERVADDR=server1.thingseye.io,11560**
36 +* Use UDP Uplink & Json protocol:** AT+PRO=2,5**
37 +* Equip with a NB-IoT SIM Card to access to NB-IoT Network.
26 26  
27 -[[image:1728363020699-203.png]]
39 +The S31-NB's cellular module has the IMEI: **863663062789483**
28 28  
29 -We can see the message arrives, but it shows ERROR because the message doesn't follow with the UDP Server format.
41 +=== 2.2.2 Check Uplink Data ===
30 30  
43 +Turn on debug mod
31 31  
45 +[[image:1758762334133-608.png||height="494" width="1003"]]
32 32  
33 -
47 +----
48 +
49 +Re-activate the S31-NB, and we can see it in the debug window:
50 +
51 +[[image:1758762371290-726.png||height="528" width="1005"]]
52 +
53 +[[image:1728378218744-800.png||_mstalt="295269" height="431" width="1003"]]
54 +
55 +----
56 +
57 +=== 2.2.4 Auto-Create Device ===
58 +
59 +The default **Tenant UDP Server** has already been configured to decode the Dragino -NB / -CB NB-IoT node. So once each end node sends a data to server. Tenant will auto create the device in the server.
60 +
61 +[[image:1728378968101-683.png||_mstalt="297154" height="210" width="1005"]]
62 +
63 +[[image:1728379050044-764.png||_mstalt="295282" height="326" width="1009"]]
64 +
65 +
66 +----
67 +
68 += 3.  Connect to The Things Stack =
69 +
70 +== 3.1 Network Structure ==
71 +
72 +The network diagram below illustrates the connection between the devices and The Things Stack, as well as how the data can be integrated with the ThingsEye IoT platform.
73 +
74 +[[image:1732679444539-853.jpg||_mstalt="296933" height="388" width="1452"]]
75 +
76 +== 3.2 Creat Integration for The Things Stack. ==
77 +
78 +(% class="lead" %)
79 +Add Integration
80 +
81 +[[image:1728535775119-971.png||_mstalt="297661" height="423" width="1007"]]
82 +
83 +
84 +(% class="lead" %)
85 +Choose Connection Type
86 +
87 +[[image:1728535857345-950.png||_mstalt="297154" height="257" width="403"]]
88 +
89 +
90 +(% class="lead" %)
91 +Input Uplink Data Converter Code
92 +
93 +[[image:1728535941851-388.png||_mstalt="297856" height="466" width="398"]]
94 +
95 +Demo JavaScript Code: [[https:~~/~~/raw.githubusercontent.com/ThingsEye-io/te-platform/refs/heads/main/Data%20Converters/The_Things_Network_MQTT_Uplink_Converter.js >>https://raw.githubusercontent.com/ThingsEye-io/te-platform/refs/heads/main/Data%20Converters/The_Things_Network_MQTT_Uplink_Converter.js]]
96 +
97 +
98 +(% class="lead" %)
99 +Input Downlink Converter
100 +
101 +[[image:1728536142721-488.png||_mstalt="296127" height="470" width="407"]]
102 +
103 +Example Javascript Code as below: [[https:~~/~~/raw.githubusercontent.com/ThingsEye-io/te-platform/refs/heads/main/Data%20Converters/The_Things_Network_MQTT_Downlink_Converter.js>>https://raw.githubusercontent.com/ThingsEye-io/te-platform/refs/heads/main/Data%20Converters/The_Things_Network_MQTT_Downlink_Converter.js]]
104 +
105 +
106 +(% class="lead" %)
107 +Set up Connection to The Things Network application
108 +
109 +[[image:1728536305503-380.png||_mstalt="293254" height="431" width="1019"]]
110 +
111 +
112 +
113 +(% class="lead" %)
114 +Test Connection & Add iIntegration
115 +
116 +[[image:1728536374214-962.png||_mstalt="295893" height="380" width="1024"]]
117 +
118 +After add , we can see the integration here:
119 +
120 +[[image:1728536420275-153.png||_mstalt="293748" height="152" width="1026"]]
121 +
122 +
123 +== 3.3 Test Uplink ==
124 +
125 +We can use Simulate Uplink to simulate an uplink in the things stack. Then we should be able to see the message in ThingsEye
126 +
127 +[[image:1728536524638-768.png||_mstalt="298870" height="473" width="1028"]]
128 +
129 +
130 +[[image:1728536541040-814.png||_mstalt="293215" height="424" width="1026"]]
131 +
132 +
133 +
134 += 4.Connect chirpstack to Thingseye by way of MQTT =
135 +
136 +* **How to connect chirpstack to Thingseye by way of MQTT? The following tutorial will show you**
137 +
138 +== 4.1 Network Structure ==
139 +
140 +The network diagram below illustrates the connection between the devices andchirpstack, as well as how the data can be integrated with the ThingsEye IoT platform.
141 +
142 +[[image:1732679647697-982.jpg||_mstalt="299884" height="399" width="1492"]]
143 +
144 +== 4.2 Thingseye adds MQTT integration ==
145 +
146 +Go to the Integrations page in the Integrations center section. Click the plus button to start adding a new integration. Select the type "MQTT" integration and click "Next";
147 +
148 +[[image:1758762634175-353.png||height="783" width="1020"]]
149 +
150 +== 4.3 Add an uplink and downlink data converter ==
151 +
152 +In the function decoder field, specify the uplink script to parse and transform the data.
153 +
154 +[[image:1758763061703-634.png||height="783" width="1020"]]
155 +
156 +* **Uplink——JavaScript：**
157 +
158 +var data = decodeToJson(payload);
159 +
160 +var deviceName = data.deviceInfo.deviceName;
161 +
162 +var deviceType = data.applicationName;
163 +
164 +var devEui = data.deviceInfo.devEui
165 +
166 +var label = data.deviceInfo.devEui
167 +
168 +var model = {};
169 +
170 +var data2 = data.object;
171 +
172 +var flg = data.fPort
173 +
174 +for (var key in data2) {
175 +
176 + ~/~/ 将属性名存入新对象中
177 +
178 + model[key] = data2[key];
179 +
180 +}
181 +
182 +~/~/var obj = {"devid":deviceName}
183 +
184 +var result = {
185 +
186 + deviceName: deviceName,
187 +
188 + deviceType: deviceType,
189 +
190 + telemetry: model,
191 +
192 + groupName: "Case Study",
193 +
194 + ~/~/label:label,
195 +
196 + attributes:{"devEui":devEui,
197 +
198 + ~/~/"timevalue":"test",
199 +
200 + "inactivityTimeout":1260000
201 +
202 + ~/~/ "High_humidity_alarm":"not set",
203 +
204 + ~/~/ "High_temperature_alarm":"not set",
205 +
206 + ~/~/ "Low_humidity_alarm":"not set",
207 +
208 + ~/~/ "Low_temperature_alarm":"not set",
209 +
210 + ~/~/ "Low_voltage_alarm":"not set"
211 +
212 + ~/~/"customerName": "Civionic Engineering & Consulting (2014) Inc."
213 +
214 + }
215 +
216 +};
217 +
218 +function decodeToString(payload) {
219 +
220 + return String.fromCharCode.apply(String, payload);
221 +
222 +}
223 +
224 +function decodeToJson(payload) {
225 +
226 + var str = decodeToString(payload);
227 +
228 + var data = JSON.parse(str);
229 +
230 + return data;
231 +
232 +}
233 +
234 +return result;
235 +
236 +----
237 +
238 +In the function decoder field, specify the downlink script to parse and transform the data.
239 +
240 +[[image:1758763019466-819.png||height="787" width="1022"]]
241 +
242 +* **Dowblink——JavaScript：**
243 +
244 +~/~/ Encode downlink data from incoming Rule Engine message
245 +
246 +~/~/ msg - JSON message payload downlink message json
247 +
248 +~/~/ msgType - type of message, for ex. 'ATTRIBUTES_UPDATED', 'POST_TELEMETRY_REQUEST', etc.
249 +
250 +~/~/ metadata - list of key-value pairs with additional data about the message
251 +
252 +~/~/ integrationMetadata - list of key-value pairs with additional data defined in Integration executing this converter
253 +
254 +~/~/ /~*~* Encoder ~*~*/
255 +
256 +~/~/var data = {"value":99};
257 +
258 +~/~/ ~/~/ Process data from incoming message and metadata
259 +
260 +~/~/ data.tempFreq = msg.temperatureUploadFrequency;
261 +
262 +~/~/ data.humFreq = msg.humidityUploadFrequency;
263 +
264 +~/~/ data.devSerialNumber = metadata['ss_serialNumber'];
265 +
266 +~/~/ ~/~/ Result object with encoded downlink payload
267 +
268 +var result = {
269 +
270 + ~/~/ downlink data content type: JSON, TEXT or BINARY (base64 format)
271 +
272 + contentType: "TEXT",
273 +
274 + ~/~/ downlink data
275 +
276 + data: msg.shared_value ,~/~/JSON.stringify(data),
277 +
278 + ~/~/ Optional metadata object presented in key/value format
279 +
280 + metadata: {
281 +
282 + topic: '/test/down/'+metadata.deviceName
283 +
284 + }
285 +
286 +};
287 +
288 +return result;
289 +
290 +----
291 +
292 +== 4.4 Configure the connection ==
293 +
294 +Generate MQTT certificate integrated on chirpstack
295 +
296 +Chirpstack generates CA certificate, TLS certificate, and TLS key respectively
297 +
298 +They correspond to the CA certificate file, Certificate file, and Private key file on thingseye
299 +
300 +[[image:图片4.png||_mstalt="5131737" height="504" width="1016"]]
301 +
302 +[[image:图片5.png||_mstalt="5131854" height="505" width="1017"]]
303 +
304 +* Copy the contents of the certificates and paste them into the linked file below, a total of three certificates are required
305 +
306 +**Integrated Certificate File demo Download Address：**
307 +
308 +[[https:~~/~~/github.com/ThingsEye-io/te-platform/tree/main/chirpstack>>https://github.com/ThingsEye-io/te-platform/tree/main/chirpstack]]
309 +
310 +Enter the server address Host: lns1.thingseye.io on the Connection configuration
311 +
312 +Port: 8883
313 +
314 +Credentials type: PEM
315 +
316 +Upload the certificate and key file
317 +
318 +[[image:图片6.png||_mstalt="5131971"]]
319 +
320 +[[image:图片7.png||_mstalt="5132088"]]
321 +
322 +The default for Topic is:
323 +
324 +application/**chirpstack application id**/device/+/event/up
325 +
326 +[[image:图片8.png||_mstalt="5132205"]]
327 +
328 +
329 +(% class="wikigeneratedid" %)
330 +[[image:屏幕截图 2024-11-25 095805.png||_mstalt="10831028" height="374" width="1272"]]
331 +
332 +== 4.5 Check the connection ==
333 +
334 +[[image:图片9.png||_mstalt="5132322"]]
335 +
336 +[[image:图片10.png||_mstalt="5142449"]]
337 +
338 += 5. Check Data Uplink Log =
339 +
340 +User can check the devices log in Intergration.
341 +
342 +[[image:1729562069134-315.png||_mstalt="294190" height="587" width="723"]]
1728378195043-766.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +146.8 KB
Content
1728378218744-800.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +104.9 KB
Content
1728378968101-683.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +37.2 KB
Content
1728379050044-764.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +97.6 KB
Content
1728535775119-971.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +84.1 KB
Content
1728535857345-950.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +29.4 KB
Content
1728535941851-388.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +50.3 KB
Content
1728536142721-488.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +55.5 KB
Content
1728536305503-380.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +135.2 KB
Content
1728536374214-962.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +11.8 KB
Content
1728536420275-153.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +35.3 KB
Content
1728536524638-768.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +46.6 KB
Content
1728536541040-814.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +29.0 KB
Content
1728566363151-470.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +61.9 KB
Content
1729562069134-315.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.EdwinChen
Size
... ... @@ -1,0 +1,1 @@
1 +67.5 KB
Content
1732678750938-753.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +173.5 KB
Content
1732679080974-799.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +176.4 KB
Content
1732679444539-853.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +180.5 KB
Content
1732679647697-982.jpg
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +179.2 KB
Content
1758762334133-608.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +161.4 KB
Content
1758762371290-726.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +215.2 KB
Content
1758762634175-353.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +213.8 KB
Content
1758762919291-489.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +209.4 KB
Content
1758763019466-819.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +227.9 KB
Content
1758763061703-634.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +222.0 KB
Content
图片1.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +123.1 KB
Content
图片10.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +173.4 KB
Content
图片2.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +163.3 KB
Content
图片3.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +124.8 KB
Content
图片4.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +68.8 KB
Content
图片5.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +98.5 KB
Content
图片6.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +136.5 KB
Content
图片7.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +143.5 KB
Content
图片8.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +151.0 KB
Content
图片9.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +134.6 KB
Content
屏幕截图 2024-11-25 095805.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +45.7 KB
Content
屏幕截图 2024-11-27 113616.png
Author
... ... @@ -1,0 +1,1 @@
1 +XWiki.hera
Size
... ... @@ -1,0 +1,1 @@
1 +117.5 KB
Content