Skip to Content

Wiki source code of Notes for TTN

Version 67.1 by Xiaoling on 2022/05/26 13:53
Show last authors
1 **~ Contents：**
2
3 {{toc/}}
4
5
6 = 1. The Things Network-V3 =
7
8 == 1.1 Introduction ==
9
10 === 1.1.1 What is The Things Network ===
11
12 (((
13 The Things Network is a global collaborative Internet of Things ecosystem that creates networks, devices and solutions using LoRaWAN.
14 )))
15
16 (((
17 The Things Network runs The Things Stack Community Edition, which is a crowdsourced, open and decentralized LoRaWAN network. This network is a great way to get started testing devices, applications, and integrations, and get familiar with LoRaWAN.
18
19
20 )))
21
22 === 1.1.2 Login or crate an account ===
23
24 (((
25 [[Login or create an account>>url:https://console.cloud.thethings.network/]] to get started with The Things Network and start using The Things Stack Console.
26 )))
27
28 (((
29 Once you have an account,get started by following steps for adding Gateway,Device and Intergrations.
30
31
32 )))
33
34 === 1.1.3 List the support products and Requirements ===
35
36 LoRaWAN Gateway model: Existing Gateway
37
38
39 = 2. Gateway Registration for Semtech UDP =
40
41 == 2.1 Primary LoRaWAN Server ==
42
43 [[image:image-20220526134633-2.png||height="616" width="1323"]]
44
45 Register Gateway
46
47
48 [[image:image-20220526134826-4.png]]
49
50 Put Gateway ID
51
52
53 [[image:image-20220526134759-3.png]]
54
55 Choose Frequency Band
56
57
58 [[image:image-20220526134919-5.png]]
59
60 Show Status
61
62
63 == 2.2 Secondary LoRaWAN Server ==
64
65 === 2.2.1 Introduction ===
66
67 The Dragino gateway has supports the Secondary server settings.
68
69
70 === 2.2.2 Below list the support products and Requirements: ===
71
72 (((
73 ~1. LoRaWAN Gateway model: [[LIG16>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/171-lig16.html]], [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]], [[DLOS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/160-dlos8.html]] [[LPS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/148-lps8.html]]
74 )))
75
76 (((
77 2. Firmware version since :[[lgw~~-~~-build-v5.4.1644658774>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LIG16/Firmware/Release/]]
78 )))
79
80
81 === 2.2.3 Example ===
82
83 The following takes Helium as a Secondary LoRaWAN server as an example
84
85
86 === 2.2.4 Step 1: Download and Install the helium gateway-rs ===
87
88 The users is needing to download and install the helium gateway-rs then click the button of Save&Apply
89
90 [[image:image-20220526135049-6.png]]
91
92 Download and Install gateway-rs
93
94
95 === 2.2.5 Step 2: Back to Semtech UDP page ===
96
97 Back to the page of Semtech UDP check the secondary server settings and click the button of Save&Apply
98
99 ​​​​[[image:image-20220526135125-7.png]]
100
101 Configuration of helium
102
103 = 3. Gateway Registration for Basics Station =
104
105 == 3.1 Introduction ==
106
107 (((
108 (((
109 The LoRa Basics™ Station protocol simplifies management of large scale LoRaWAN networks. LoRa Basics™ Station is the preferred way of connecting Gateways to The Things Stack. [[The LoRa Basics Station doc>>url:https://www.thethingsindustries.com/docs/gateways/lora-basics-station/]]
110 )))
111 )))
112
113 (((
114 **Below list the support products and Requirements:**
115 )))
116
117 (((
118 (((
119 ~1. LoRaWAN Gateway model: [[LIG16>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/171-lig16.html]], [[LG308>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/140-lg308.html]], [[DLOS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/160-dlos8.html]] [[LPS8>>url:http://www.dragino.com/products/lora-lorawan-gateway/item/148-lps8.html]]
120 )))
121
122 (((
123 2. Firmware version since :[[lgw~~-~~-build-v5.4.1640315898>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
124 )))
125 )))
126
127 (((
128 **What do you need to prepare**
129 )))
130
131 (((
132 (((
133 A gateway that can access the internet normally
134 )))
135 )))
136
137 == 3.2 Step 1. Add Gateway ==
138
139 (((
140 (((
141 The example for **EU**
142 )))
143 )))
144
145 (((
146 (((
147 User can add your gateway into The Things Network V3 according to the previous step
148 )))
149 )))
150
151 (((
152 (((
153 Following picture is the successful added.
154 )))
155 )))
156
157 [[image:image-20220525094010-2.png]]
158
159 Add Gateway
160
161 == 3.3 Step 2. Create the API key ==
162
163 user need to create the CUPS API key and LNS API key.
164
165 [[image:image-20220525094115-3.png]]
166
167 Create CUPS API key
168
169
170 [[image:image-20220525094146-4.png]]
171
172 Create LNS API key
173
174 (% style="color:red" %)**Note : Please copy the API key.**
175
176 == 3.4 Step 3. Update the gateway setting ==
177
178 In the LoRa Basics Station LNS Authentication Key field, paste the API key you generated in the previous step.
179
180 [[image:image-20220525094220-5.png]]
181
182 paste the API key
183
184 == 3.5 Step 4. Access the gateway GUI ==
185
186 User need to update the API key and install the Certificate
187
188 [[image:image-20220525094257-6.png]]
189
190 Access the gateway GUI
191
192 == 3.6 Step 5. Configure Station ==
193
194 User need to input Server URI, Server CUPS Key and LNS Key, as well as install CUPS certificate.
195
196 **just to clarify.**
197
198 (% class="box" %)
199 (((
200 CUPS Server URI  ~-~-> Server Adress
201 CUPS Authorization Key         ~-~-> Server CUPS API Key
202 LNS Authorization Key  ~-~-> Server LNS API Key
203 CUPS certificate  ~-~-> Server CA(user can use the button to install the certificate by default)
204 )))
205
206 [[image:image-20220525094329-7.png]]
207
208 Congfigure Station
209
210 == 3.7 Start Station ==
211
212 (((
213 When the user has finished the configuration,Please click Sace&Apply to start station to connect The Things Network.
214 )))
215
216 == 3.8 Siccessful Connection ==
217
218 If user completes the above steps,which will see live date in the TTN.
219
220 [[image:image-20220525094409-8.png]]
221
222 Station live date
223
224 == 3.9 Trouble Shooting ==
225
226 User can check the station log in the logread/system log page.
227
228 [[image:image-20220525090622-14.png]]
229
230 Station Log
231
232 and recode the station log in the system/Recode log page.
233
234 [[image:image-20220525090705-15.png]]
235
236 Recore Log
237
238 = 4. Configure node connection to TTNv3 =
239
240 (((
241 (((
242 Following is an example for how to join the TTN v3 LoRaWAN Network.
243 )))
244 )))
245
246 (((
247 (((
248 The gateway is already set up to connect to the TTN network, so we now need to configure the TTNv3 server.
249 )))
250 )))
251
252 (((
253 (((
254 We take LES01 as an example.
255 )))
256 )))
257
258 == 4.1 Step1 ==
259
260 (((
261 (((
262 Create a device in TTN with the OTAA keys from LSE01.
263 )))
264 )))
265
266 (((
267 (((
268 Each LSE01 is shipped with a sticker with the default device EUI as below:
269 )))
270 )))
271
272 (((
273 (((
274 You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot:
275 )))
276 )))
277
278 [[image:image-20220525090739-16.png]]
279
280 [[image:image-20220525090833-17.png]]
281
282 == 4.2 Step2 ==
283
284 (((
285 (((
286 There are all our nodes in the repository. Users can choose the corresponding brand, model, firmware version and frequency.The decoder and configuration information of the node are pre-configured.Users do not need to configure them.
287 )))
288 )))
289
290 [[image:image-20220525090920-18.png]]
291
292 == 4.3 Step3 ==
293
294 Add APP EUI in the application:
295
296 [[image:image-20220525091022-19.png]]
297
298 == 4.4 Step4 ==
299
300 Add APP KEY and DEV EUI:
301
302 [[image:image-20220525091128-20.png]]
303
304 = 5. TTN V3 integrated into MQTT server =
305
306 == 5.1 Introduction ==
307
308 (((
309 (((
310 The Application Server exposes an MQTT server to work with streaming events. In order to use the MQTT server you need to create a new API key, which will function as connection password. You can also use an existing API key, as long as it has the necessary rights granted.
311 )))
312 )))
313
314 == 5.2 Create device steps at MQTT ==
315
316 (((
317 (((
318 The user creates a new API KEY after creating a device on TTN V3.
319 )))
320 )))
321
322 (((
323 (((
324 Then copy the password and open MQTT.fx.
325 )))
326 )))
327
328 (((
329 (((
330 Fill in Broker Address and Broker port.
331 )))
332 )))
333
334 [[image:image-20220525091251-22.png]]
335
336 Fill in the username and password into MQTT.
337
338
339 [[image:image-20220525091333-23.png]]
340
341 The Application Server publishes uplink traffic on the following topics:
342
343 (% class="box" %)
344 (((
345 v3/{application id}@{tenant id}/devices/{device id}/join
346 v3/{application id}@{tenant id}/devices/{device id}/up
347 v3/{application id}@{tenant id}/devices/{device id}/down/queued
348 v3/{application id}@{tenant id}/devices/{device id}/down/sent
349 v3/{application id}@{tenant id}/devices/{device id}/down/ack
350 v3/{application id}@{tenant id}/devices/{device id}/down/nack
351 v3/{application id}@{tenant id}/devices/{device id}/down/failed
352 v3/{application id}@{tenant id}/devices/{device id}/service/data
353 v3/{application id}@{tenant id}/devices/{device id}/location/solved
354 )))
355
356 (((
357 (((
358 **Note**: Remember that the format of these topics for The Things Stack Open Source would contain {application id} instead of {application id}@{tenant id}.
359 )))
360 )))
361
362 [[image:image-20220525091430-24.png]]
363
364 (((
365 (((
366 While you could subscribe to all of these topics separately, for the simplicity of this tutorial we use # to subscribe to all topics, i.e. to receive all uplink traffic.
367 )))
368 )))
369
370 [[image:image-20220525091458-25.png]]
371
372 (((
373 (((
374 Downlinks can be scheduled by publishing the message to the topic v3/{application id}@{tenant id}/devices/{device id}/down/push.
375 )))
376 )))
377
378 (((
379 (((
380 **Note**: Remember that the format of this topic for The Things Stack Open Source deployment would be v3/{application id}/devices/{device id}/down/push.
381 )))
382 )))
383
384 (((
385 (((
386 Instead of /push, you can also use /replace to replace the downlink queue. Replacing with an empty array clears the downlink queue. Example:
387 )))
388 )))
389
390 [[image:image-20220525091618-27.png]]
391
392 (((
393 To send an unconfirmed downlink message to the device dev1 in application app1 in tenant tenant1 with the hexadecimal payload BE EF on FPort 15 with normal priority, use the topic v3/app1@tenant1/devices/dev1/down/push with the following contents:
394 )))
395
396 (((
397 **Note**: Use this handy tool to convert hexadecimal to base64.
398 )))
399
400 [[image:image-20220525091702-28.png]]
401
402 == 5.3 Send Downlink message ==
403
404 (((
405 How to configure downlink in TTN V3?
406 )))
407
408 (((
409 A few examples: set the transmission interval to 90 seconds.
410 )))
411
412 (((
413 Downlink command:01 00 00 5A
414 )))
415
416 [[image:image-20220525091752-29.png]]
417
418 downlink
419
420 After sending, you can view it in live data.
421
422 [[image:image-20220525091816-30.png]]
423
424 downlink
425
426 (((
427 When downlink is successfully sent, the downlink information can be received on the serial port.
428 )))
429
430 (((
431 **Note**: If the downlink byte sent is longer, the number of bytes will be displayed.
432 )))
433
434 [[image:image-20220525091855-31.png]]
435
436 downlink
437
438 (((
439 (((
440 If you want to get a successful reply to send downlink in TTN v3. You need to set the response level.
441 )))
442 )))
443
444 (((
445 (((
446 If the equipment uses CLASS A. You can set **AT+RPL=2** or send the downlink command: **2102**
447 )))
448 )))
449
450 (((
451 (((
452 If the equipment uses CLASS C. You can set** AT+RPL=4** or send the downlink command: **2104**
453 )))
454 )))
455
456 (((
457 (((
458 When the device successfully receives the downlink, the server will receive a confirmation packet of 00.
459 )))
460 )))
461
462 [[image:image-20220525091925-32.png]]
463
464 downlink
465
466 = 6. Request Remote Support =
467
468 (((
469 These pages are useful to check what is wrong on the Join process. Below shows the four steps that we can check the Join Process.
470 \\If problem not solve, and you need dragino remote support, please follow to this document: [[TTN Support instruction>>url:https://www.dragino.com/downloads/index.php?dir=&file=TTNv3_Support_Guide.pdf]](% style="color:red" %) **If user has checked below steps and still can't solve the problem, please send us (support @ dragino.com) the screenshots for each step to check. They include:**
471 )))
472
473 * End node is connected to serial port to show the Join frequency and DR. (If possible)
474 * Gateway (from gateway UI) traffic to show the packet got from end node and receive from Server. (If possible)
475 * Gateway traffic (from server UI) to shows the data exchange between gateway and server. (Normally possible)
476 * End Node traffic (from server UI) to shows end node activity in server. (Normally possible)
477 * End Node Keys screen shot shows in end node and server. so we can check if the keys are correct. (In most case, we found keys doesn't match, especially APP EUI)
478
479 **~1. End Device Join Screen shot, we can check:**
480
481 * If the device is sending join request to server?
482 * What frequency the device is sending?
483
484 [[image:image-20220525092012-33.png]]
485
486 Console Output from End device to see the transmit frequency
487
488 User can run **AT+CFG **command to print configuration information.
489
490 * Is the device in OTAA mode or ABP mode? **AT+NJM=1** (OTAA mode), **AT+NJM=0** (ABP mode)
491
492 [[image:image-20220525092043-34.png]]
493
494 Console Output from End device to see the transmit frequency
495
496 **2. Gateway packet traffic in gateway web or ssh. we can check:**
497
498 * (((
499 If the gateway receive the Join request packet from sensor? (If this fail, check if the gateway and sensor works on the match frequency)
500 )))
501 * (((
502 If the gateway gets the Join Accept message from server and transmit it via LoRa?
503 )))
504
505 [[image:image-20220525092124-35.png]]
506
507 Console Output from Gateway to see packets between end node and server.
508
509
510 **3. Gateway Traffic Page in LoRaWAN Server**
511
512 * (((
513 If the Join Request packet arrive the gateway traffic in server? If not, check the internet connection and gateway LoRaWAN server settings.
514 )))
515 * (((
516 If the server send back a Join Accept for the Join Request? if not, check if the keys from the device match the keys you put in the server, or try to choose a different server route for this end device.
517 )))
518 * (((
519 If the Join Accept message are in correct frequency? If you set the server to use US915 band, and your end node and gateway is EU868, you will see the Join Accept message are in US915 band so no possible to Join success.
520 )))
521
522 [[image:image-20220525092157-36.png]]
523
524 The Traffic for the End node in the server, use TTNv3 as example
525
526
527 [[image:image-20220525092231-37.png]]
528
529 The Traffic for the End node in the server, use TTNv3 as example
530
531 **4. Data Page in LoRaWAN server**
532
533 (((
534 (((
535 (((
536 If this data page shows the Join Request message from the end node? If not, most properly you have wrong settings in the keys. Keys in the server doesn't match the keys in End Node.
537
538 [[image:image-20220525092546-1.png]]
539 )))
540 )))
541 )))
542
543 The data for the end device set in server
544
545 [[image:image-20220525092430-40.png]]
546
547 Check if OTAA Keys match the keys in device