Wiki source code of Notes for TTN

Version 69.1 by Xiaoling on 2022/05/26 13:54

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

Wiki source code of Notes for TTN

Applications

Navigation