Wiki source code of Notes for TTN

Version 99.18 by Xiaoling on 2022/07/25 09:19

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

Wiki source code of Notes for TTN

Applications

Navigation