Skip to Content

Wiki source code of Notes for TTN

Version 75.1 by Xiaoling on 2022/05/26 13:59
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
104 = 3. Gateway Registration for Basics Station =
105
106 == 3.1 Introduction ==
107
108 (((
109 (((
110 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/]]
111 )))
112 )))
113
114 (((
115 **Below list the support products and Requirements:**
116 )))
117
118 (((
119 (((
120 ~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]]
121 )))
122
123 (((
124 2. Firmware version since :[[lgw~~-~~-build-v5.4.1640315898>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
125 )))
126 )))
127
128 (((
129 **What do you need to prepare**
130 )))
131
132 (((
133 (((
134 A gateway that can access the internet normally
135
136
137 )))
138 )))
139
140 == 3.2 Step 1. Add Gateway ==
141
142 (((
143 (((
144 The example for **EU**
145 )))
146 )))
147
148 (((
149 (((
150 User can add your gateway into The Things Network V3 according to the previous step
151 )))
152 )))
153
154 (((
155 (((
156 Following picture is the successful added.
157 )))
158 )))
159
160 [[image:image-20220526135316-8.png]]
161
162 Add Gateway
163
164
165 == 3.3 Step 2. Create the API key ==
166
167 user need to create the CUPS API key and LNS API key.
168
169 [[image:image-20220526135349-9.png]]
170
171 Create CUPS API key
172
173
174 [[image:image-20220526135428-10.png]]
175
176 Create LNS API key
177
178 (% style="color:red" %)**Note : Please copy the API key.**
179
180
181 == 3.4 Step 3. Update the gateway setting ==
182
183 In the LoRa Basics Station LNS Authentication Key field, paste the API key you generated in the previous step.
184
185 [[image:image-20220526135528-11.png]]
186
187 paste the API key
188
189
190 == 3.5 Step 4. Access the gateway GUI ==
191
192 User need to update the API key and install the Certificate
193
194 [[image:image-20220526135601-12.png]]
195
196 Access the gateway GUI
197
198
199 == 3.6 Step 5. Configure Station ==
200
201 User need to input Server URI, Server CUPS Key and LNS Key, as well as install CUPS certificate.
202
203 **just to clarify.**
204
205 (% class="box" %)
206 (((
207 CUPS Server URI  ~-~-> Server Adress
208 CUPS Authorization Key         ~-~-> Server CUPS API Key
209 LNS Authorization Key  ~-~-> Server LNS API Key
210 CUPS certificate  ~-~-> Server CA(user can use the button to install the certificate by default)
211 )))
212
213 [[image:image-20220526135654-13.png]]
214
215 Congfigure Station
216
217
218 == 3.7 Start Station ==
219
220 (((
221 When the user has finished the configuration,Please click Sace&Apply to start station to connect The Things Network.
222
223
224 )))
225
226 == 3.8 Siccessful Connection ==
227
228 If user completes the above steps,which will see live date in the TTN.
229
230 [[image:image-20220526135734-14.png]]
231
232 Station live date
233
234
235 == 3.9 Trouble Shooting ==
236
237 User can check the station log in the logread/system log page.
238
239 [[image:image-20220526135845-15.png]]
240
241 Station Log
242
243 and recode the station log in the system/Recode log page.
244
245 [[image:image-20220525090705-15.png]]
246
247 Recore Log
248
249 = 4. Configure node connection to TTNv3 =
250
251 (((
252 (((
253 Following is an example for how to join the TTN v3 LoRaWAN Network.
254 )))
255 )))
256
257 (((
258 (((
259 The gateway is already set up to connect to the TTN network, so we now need to configure the TTNv3 server.
260 )))
261 )))
262
263 (((
264 (((
265 We take LES01 as an example.
266 )))
267 )))
268
269 == 4.1 Step1 ==
270
271 (((
272 (((
273 Create a device in TTN with the OTAA keys from LSE01.
274 )))
275 )))
276
277 (((
278 (((
279 Each LSE01 is shipped with a sticker with the default device EUI as below:
280 )))
281 )))
282
283 (((
284 (((
285 You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot:
286 )))
287 )))
288
289 [[image:image-20220525090739-16.png]]
290
291 [[image:image-20220525090833-17.png]]
292
293 == 4.2 Step2 ==
294
295 (((
296 (((
297 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.
298 )))
299 )))
300
301 [[image:image-20220525090920-18.png]]
302
303 == 4.3 Step3 ==
304
305 Add APP EUI in the application:
306
307 [[image:image-20220525091022-19.png]]
308
309 == 4.4 Step4 ==
310
311 Add APP KEY and DEV EUI:
312
313 [[image:image-20220525091128-20.png]]
314
315 = 5. TTN V3 integrated into MQTT server =
316
317 == 5.1 Introduction ==
318
319 (((
320 (((
321 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.
322 )))
323 )))
324
325 == 5.2 Create device steps at MQTT ==
326
327 (((
328 (((
329 The user creates a new API KEY after creating a device on TTN V3.
330 )))
331 )))
332
333 (((
334 (((
335 Then copy the password and open MQTT.fx.
336 )))
337 )))
338
339 (((
340 (((
341 Fill in Broker Address and Broker port.
342 )))
343 )))
344
345 [[image:image-20220525091251-22.png]]
346
347 Fill in the username and password into MQTT.
348
349
350 [[image:image-20220525091333-23.png]]
351
352 The Application Server publishes uplink traffic on the following topics:
353
354 (% class="box" %)
355 (((
356 v3/{application id}@{tenant id}/devices/{device id}/join
357 v3/{application id}@{tenant id}/devices/{device id}/up
358 v3/{application id}@{tenant id}/devices/{device id}/down/queued
359 v3/{application id}@{tenant id}/devices/{device id}/down/sent
360 v3/{application id}@{tenant id}/devices/{device id}/down/ack
361 v3/{application id}@{tenant id}/devices/{device id}/down/nack
362 v3/{application id}@{tenant id}/devices/{device id}/down/failed
363 v3/{application id}@{tenant id}/devices/{device id}/service/data
364 v3/{application id}@{tenant id}/devices/{device id}/location/solved
365 )))
366
367 (((
368 (((
369 **Note**: Remember that the format of these topics for The Things Stack Open Source would contain {application id} instead of {application id}@{tenant id}.
370 )))
371 )))
372
373 [[image:image-20220525091430-24.png]]
374
375 (((
376 (((
377 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.
378 )))
379 )))
380
381 [[image:image-20220525091458-25.png]]
382
383 (((
384 (((
385 Downlinks can be scheduled by publishing the message to the topic v3/{application id}@{tenant id}/devices/{device id}/down/push.
386 )))
387 )))
388
389 (((
390 (((
391 **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.
392 )))
393 )))
394
395 (((
396 (((
397 Instead of /push, you can also use /replace to replace the downlink queue. Replacing with an empty array clears the downlink queue. Example:
398 )))
399 )))
400
401 [[image:image-20220525091618-27.png]]
402
403 (((
404 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:
405 )))
406
407 (((
408 **Note**: Use this handy tool to convert hexadecimal to base64.
409 )))
410
411 [[image:image-20220525091702-28.png]]
412
413 == 5.3 Send Downlink message ==
414
415 (((
416 How to configure downlink in TTN V3?
417 )))
418
419 (((
420 A few examples: set the transmission interval to 90 seconds.
421 )))
422
423 (((
424 Downlink command:01 00 00 5A
425 )))
426
427 [[image:image-20220525091752-29.png]]
428
429 downlink
430
431 After sending, you can view it in live data.
432
433 [[image:image-20220525091816-30.png]]
434
435 downlink
436
437 (((
438 When downlink is successfully sent, the downlink information can be received on the serial port.
439 )))
440
441 (((
442 **Note**: If the downlink byte sent is longer, the number of bytes will be displayed.
443 )))
444
445 [[image:image-20220525091855-31.png]]
446
447 downlink
448
449 (((
450 (((
451 If you want to get a successful reply to send downlink in TTN v3. You need to set the response level.
452 )))
453 )))
454
455 (((
456 (((
457 If the equipment uses CLASS A. You can set **AT+RPL=2** or send the downlink command: **2102**
458 )))
459 )))
460
461 (((
462 (((
463 If the equipment uses CLASS C. You can set** AT+RPL=4** or send the downlink command: **2104**
464 )))
465 )))
466
467 (((
468 (((
469 When the device successfully receives the downlink, the server will receive a confirmation packet of 00.
470 )))
471 )))
472
473 [[image:image-20220525091925-32.png]]
474
475 downlink
476
477 = 6. Request Remote Support =
478
479 (((
480 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.
481 \\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:**
482 )))
483
484 * End node is connected to serial port to show the Join frequency and DR. (If possible)
485 * Gateway (from gateway UI) traffic to show the packet got from end node and receive from Server. (If possible)
486 * Gateway traffic (from server UI) to shows the data exchange between gateway and server. (Normally possible)
487 * End Node traffic (from server UI) to shows end node activity in server. (Normally possible)
488 * 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)
489
490 **~1. End Device Join Screen shot, we can check:**
491
492 * If the device is sending join request to server?
493 * What frequency the device is sending?
494
495 [[image:image-20220525092012-33.png]]
496
497 Console Output from End device to see the transmit frequency
498
499 User can run **AT+CFG **command to print configuration information.
500
501 * Is the device in OTAA mode or ABP mode? **AT+NJM=1** (OTAA mode), **AT+NJM=0** (ABP mode)
502
503 [[image:image-20220525092043-34.png]]
504
505 Console Output from End device to see the transmit frequency
506
507 **2. Gateway packet traffic in gateway web or ssh. we can check:**
508
509 * (((
510 If the gateway receive the Join request packet from sensor? (If this fail, check if the gateway and sensor works on the match frequency)
511 )))
512 * (((
513 If the gateway gets the Join Accept message from server and transmit it via LoRa?
514 )))
515
516 [[image:image-20220525092124-35.png]]
517
518 Console Output from Gateway to see packets between end node and server.
519
520
521 **3. Gateway Traffic Page in LoRaWAN Server**
522
523 * (((
524 If the Join Request packet arrive the gateway traffic in server? If not, check the internet connection and gateway LoRaWAN server settings.
525 )))
526 * (((
527 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.
528 )))
529 * (((
530 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.
531 )))
532
533 [[image:image-20220525092157-36.png]]
534
535 The Traffic for the End node in the server, use TTNv3 as example
536
537
538 [[image:image-20220525092231-37.png]]
539
540 The Traffic for the End node in the server, use TTNv3 as example
541
542 **4. Data Page in LoRaWAN server**
543
544 (((
545 (((
546 (((
547 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.
548
549 [[image:image-20220525092546-1.png]]
550 )))
551 )))
552 )))
553
554 The data for the end device set in server
555
556 [[image:image-20220525092430-40.png]]
557
558 Check if OTAA Keys match the keys in device