Wiki source code of Notes for TTN

Version 99.20 by Xiaoling on 2022/07/25 09:20

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

Wiki source code of Notes for TTN

Applications

Navigation