Wiki source code of Notes for TTN

Version 99.10 by Xiaoling on 2022/07/25 08:46

Show last authors
1 **~ Table of Contents:**
2
3 {{toc/}}
4
5
6
7 = 1. The Things Network-V3 =
8
9
10 == 1.1  Introduction ==
11
12
13 === 1.1.1  What is The Things Network ===
14
15
16 (((
17 The Things Network is a global collaborative Internet of Things ecosystem that creates networks, devices and solutions using LoRaWAN.
18 )))
19
20 (((
21 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.
22
23
24
25 )))
26
27 === 1.1.2  Login or crate an account ===
28
29
30 (((
31 [[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.
32 )))
33
34 (((
35 Once you have an account,get started by following steps for adding Gateway,Device and Intergrations.
36
37
38
39 )))
40
41 === 1.1.3  List the support products and Requirements ===
42
43
44 LoRaWAN Gateway model: Existing Gateway
45
46
47
48 = 2.  Gateway Registration for Semtech UDP =
49
50
51 == 2.1  Primary LoRaWAN Server ==
52
53
54 [[image:image-20220526134633-2.png||height="616" width="1323"]]
55
56 Register Gateway
57
58
59
60 [[image:image-20220526134826-4.png]]
61
62 Put Gateway ID
63
64
65
66 [[image:image-20220526134759-3.png]]
67
68 Choose Frequency Band
69
70
71
72 [[image:image-20220526134919-5.png]]
73
74 Show Status
75
76
77
78 == 2.2  Secondary LoRaWAN Server ==
79
80
81 === 2.2.1  Introduction ===
82
83
84 The Dragino gateway has supports the Secondary server settings.
85
86
87 === 2.2.2  Below list the support products and Requirements: ===
88
89
90 (((
91 ~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]]
92 )))
93
94 (((
95 2. Firmware version since :[[lgw~~-~~-build-v5.4.1644658774>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LIG16/Firmware/Release/]]
96 )))
97
98
99
100 === 2.2.3  Example ===
101
102
103 The following takes Helium as a Secondary LoRaWAN server as an example
104
105
106
107 === 2.2.4  Step 1: Download and Install the helium gateway-rs ===
108
109
110 The users is needing to download and install the helium gateway-rs then click the button of Save&Apply
111
112 [[image:image-20220526135049-6.png]]
113
114 Download and Install gateway-rs
115
116
117
118 === 2.2.5  Step 2: Back to Semtech UDP page ===
119
120
121 Back to the page of Semtech UDP check the secondary server settings and click the button of Save&Apply
122
123 ​​​​[[image:image-20220526135125-7.png]]
124
125 Configuration of helium
126
127
128
129 = 3.  Gateway Registration for Basics Station =
130
131
132 == 3.1  Introduction ==
133
134
135 (((
136 (((
137 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/]]
138 )))
139 )))
140
141 (((
142 **Below list the support products and Requirements:**
143 )))
144
145 (((
146 (((
147 ~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]]
148 )))
149
150 (((
151 2. Firmware version since :[[lgw~~-~~-build-v5.4.1640315898>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
152 )))
153 )))
154
155 (((
156 **What do you need to prepare**
157 )))
158
159 (((
160 (((
161 A gateway that can access the internet normally
162
163
164 )))
165 )))
166
167 == 3.2 Step 1. Add Gateway ==
168
169 (((
170 (((
171 The example for **EU**
172 )))
173 )))
174
175 (((
176 (((
177 User can add your gateway into The Things Network V3 according to the previous step
178 )))
179 )))
180
181 (((
182 (((
183 Following picture is the successful added.
184 )))
185 )))
186
187 [[image:image-20220526135316-8.png]]
188
189 Add Gateway
190
191
192 == 3.3 Step 2. Create the API key ==
193
194 user need to create the CUPS API key and LNS API key.
195
196 [[image:image-20220526135349-9.png]]
197
198 Create CUPS API key
199
200
201 [[image:image-20220526135428-10.png]]
202
203 Create LNS API key
204
205 (% style="color:red" %)**Note : Please copy the API key.**
206
207
208 == 3.4 Step 3. Update the gateway setting ==
209
210 In the LoRa Basics Station LNS Authentication Key field, paste the API key you generated in the previous step.
211
212 [[image:image-20220526135528-11.png]]
213
214 paste the API key
215
216
217 == 3.5 Step 4. Access the gateway GUI ==
218
219 User need to update the API key and install the Certificate
220
221 [[image:image-20220526135601-12.png]]
222
223 Access the gateway GUI
224
225
226 == 3.6 Step 5. Configure Station ==
227
228 User need to input Server URI, Server CUPS Key and LNS Key, as well as install CUPS certificate.
229
230 **just to clarify.**
231
232 (% class="box" %)
233 (((
234 CUPS Server URI  ~-~-> Server Adress
235 CUPS Authorization Key         ~-~-> Server CUPS API Key
236 LNS Authorization Key  ~-~-> Server LNS API Key
237 CUPS certificate  ~-~-> Server CA(user can use the button to install the certificate by default)
238 )))
239
240 [[image:image-20220526135654-13.png]]
241
242 Congfigure Station
243
244
245 == 3.7 Start Station ==
246
247 (((
248 When the user has finished the configuration,Please click Sace&Apply to start station to connect The Things Network.
249
250
251 )))
252
253 == 3.8 Siccessful Connection ==
254
255 If user completes the above steps,which will see live date in the TTN.
256
257 [[image:image-20220526135734-14.png]]
258
259 Station live date
260
261
262 == 3.9 Trouble Shooting ==
263
264 User can check the station log in the logread/system log page.
265
266 [[image:image-20220526135845-15.png]]
267
268 Station Log
269
270
271 and recode the station log in the system/Recode log page.
272
273 [[image:image-20220526135940-16.png]]
274
275 Recore Log
276
277
278 = 4. Configure node connection to TTNv3 =
279
280 (((
281 (((
282 Following is an example for how to join the TTN v3 LoRaWAN Network.
283 )))
284 )))
285
286 (((
287 (((
288 The gateway is already set up to connect to the TTN network, so we now need to configure the TTNv3 server.
289 )))
290 )))
291
292 (((
293 (((
294 We take LES01 as an example.
295
296
297 )))
298 )))
299
300 == 4.1 Step1 ==
301
302 (((
303 (((
304 Create a device in TTN with the OTAA keys from LSE01.
305 )))
306 )))
307
308 (((
309 (((
310 Each LSE01 is shipped with a sticker with the default device EUI as below:
311 )))
312 )))
313
314 (((
315 (((
316 You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot:
317 )))
318 )))
319
320 [[image:image-20220526140015-17.png]]
321
322 [[image:image-20220526140044-18.png]]
323
324
325 == 4.2 Step2 ==
326
327 (((
328 (((
329 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.
330 )))
331 )))
332
333 [[image:image-20220526140132-19.png]]
334
335
336 == 4.3 Step3 ==
337
338 Add APP EUI in the application:
339
340 [[image:image-20220526140205-20.png]]
341
342
343 == 4.4 Step4 ==
344
345 Add APP KEY and DEV EUI:
346
347 [[image:image-20220526140251-21.png]]
348
349
350 = 5. TTN V3 integrated into MQTT server =
351
352 == 5.1 Introduction ==
353
354 (((
355 (((
356 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.
357
358
359 )))
360 )))
361
362 == 5.2 Create device steps at MQTT ==
363
364 (((
365 (((
366 The user creates a new API KEY after creating a device on TTN V3.
367 )))
368 )))
369
370 (((
371 (((
372 Then copy the password and open MQTT.fx.
373 )))
374 )))
375
376 (((
377 (((
378 Fill in Broker Address and Broker port.
379 )))
380 )))
381
382 [[image:image-20220526140347-22.png]]
383
384 Fill in the username and password into MQTT.
385
386
387 [[image:image-20220526140420-23.png]]
388
389 The Application Server publishes uplink traffic on the following topics:
390
391 (% class="box" %)
392 (((
393 v3/{application id}@{tenant id}/devices/{device id}/join
394 v3/{application id}@{tenant id}/devices/{device id}/up
395 v3/{application id}@{tenant id}/devices/{device id}/down/queued
396 v3/{application id}@{tenant id}/devices/{device id}/down/sent
397 v3/{application id}@{tenant id}/devices/{device id}/down/ack
398 v3/{application id}@{tenant id}/devices/{device id}/down/nack
399 v3/{application id}@{tenant id}/devices/{device id}/down/failed
400 v3/{application id}@{tenant id}/devices/{device id}/service/data
401 v3/{application id}@{tenant id}/devices/{device id}/location/solved
402 )))
403
404 (((
405 (((
406 **Note**: Remember that the format of these topics for The Things Stack Open Source would contain {application id} instead of {application id}@{tenant id}.
407 )))
408 )))
409
410 [[image:image-20220526140452-24.png]]
411
412 (((
413 (((
414 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.
415 )))
416 )))
417
418 [[image:image-20220526140708-25.png]]
419
420 (((
421 (((
422 Downlinks can be scheduled by publishing the message to the topic v3/{application id}@{tenant id}/devices/{device id}/down/push.
423 )))
424 )))
425
426 (((
427 (((
428 **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.
429 )))
430 )))
431
432 (((
433 (((
434 Instead of /push, you can also use /replace to replace the downlink queue. Replacing with an empty array clears the downlink queue. Example:
435 )))
436 )))
437
438 [[image:image-20220526140856-26.png]]
439
440 (((
441 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:
442 )))
443
444 (((
445 **Note**: Use this handy tool to convert hexadecimal to base64.
446 )))
447
448 [[image:image-20220526140936-27.png]]
449
450
451 == 5.3 Send Downlink message ==
452
453 (((
454 How to configure downlink in TTN V3?
455 )))
456
457 (((
458 A few examples: set the transmission interval to 90 seconds.
459 )))
460
461 (((
462 Downlink command:01 00 00 5A
463 )))
464
465 [[image:image-20220526141021-28.png]]
466
467 downlink
468
469
470 After sending, you can view it in live data.
471
472 [[image:image-20220526141052-29.png]]
473
474 downlink
475
476
477 (((
478 When downlink is successfully sent, the downlink information can be received on the serial port.
479 )))
480
481 (((
482 **Note**: If the downlink byte sent is longer, the number of bytes will be displayed.
483 )))
484
485 [[image:image-20220526141116-30.png]]
486
487 downlink
488
489
490 (((
491 (((
492 If you want to get a successful reply to send downlink in TTN v3. You need to set the response level.
493 )))
494 )))
495
496 (((
497 (((
498 If the equipment uses CLASS A. You can set **AT+RPL=2** or send the downlink command: **2102**
499 )))
500 )))
501
502 (((
503 (((
504 If the equipment uses CLASS C. You can set** AT+RPL=4** or send the downlink command: **2104**
505 )))
506 )))
507
508 (((
509 (((
510 When the device successfully receives the downlink, the server will receive a confirmation packet of 00.
511 )))
512 )))
513
514 [[image:image-20220526141149-31.png]]
515
516 downlink
517
518
519 = 6. Request Remote Support =
520
521 (((
522 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.
523 \\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:**
524 )))
525
526 * End node is connected to serial port to show the Join frequency and DR. (If possible)
527 * Gateway (from gateway UI) traffic to show the packet got from end node and receive from Server. (If possible)
528 * Gateway traffic (from server UI) to shows the data exchange between gateway and server. (Normally possible)
529 * End Node traffic (from server UI) to shows end node activity in server. (Normally possible)
530 * 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)
531
532 **~1. End Device Join Screen shot, we can check:**
533
534 * If the device is sending join request to server?
535 * What frequency the device is sending?
536
537 [[image:image-20220526141308-33.png]]
538
539 Console Output from End device to see the transmit frequency
540
541 User can run **AT+CFG **command to print configuration information.
542
543 * Is the device in OTAA mode or ABP mode? **AT+NJM=1** (OTAA mode), **AT+NJM=0** (ABP mode)
544
545 [[image:image-20220526141612-36.png]]
546
547
548 Console Output from End device to see the transmit frequency
549
550
551 **2. Gateway packet traffic in gateway web or ssh. we can check:**
552
553 * (((
554 If the gateway receive the Join request packet from sensor? (If this fail, check if the gateway and sensor works on the match frequency)
555 )))
556 * (((
557 If the gateway gets the Join Accept message from server and transmit it via LoRa?
558 )))
559
560 [[image:image-20220526141739-37.png]]
561
562 Console Output from Gateway to see packets between end node and server.
563
564
565 **3. Gateway Traffic Page in LoRaWAN Server**
566
567 * (((
568 If the Join Request packet arrive the gateway traffic in server? If not, check the internet connection and gateway LoRaWAN server settings.
569 )))
570 * (((
571 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.
572 )))
573 * (((
574 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.
575 )))
576
577 [[image:image-20220526141823-38.png||height="501" width="1144"]]
578
579 The Traffic for the End node in the server, use TTNv3 as example
580
581
582 [[image:image-20220526141917-39.png]]
583
584 The Traffic for the End node in the server, use TTNv3 as example
585
586
587 **4. Data Page in LoRaWAN server**
588
589 (((
590 (((
591 (((
592 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.
593
594 [[image:image-20220526141956-40.png]]
595 )))
596 )))
597 )))
598
599 The data for the end device set in server
600
601
602 [[image:image-20220526142033-41.png]]
603
604 Check if OTAA Keys match the keys in device