Wiki source code of Notes for TTN

Version 103.1 by Xiaoye on 2022/07/26 13:58

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

Wiki source code of Notes for TTN

Applications

Navigation