Wiki source code of Notes for TTN

Version 75.1 by Xiaoling on 2022/05/26 13:59

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
69.2	164
1.3	165	== 3.3 Step 2. Create the API key ==
1.2	166
	167	user need to create the CUPS API key and LNS API key.
	168
69.2	169	[[image:image-20220526135349-9.png]]
1.2	170
	171	Create CUPS API key
	172
	173
69.2	174	[[image:image-20220526135428-10.png]]
1.3	175
1.2	176	Create LNS API key
	177
1.7	178	(% style="color:red" %)Note : Please copy the API key.
1.2	179
71.2	180
1.3	181	== 3.4 Step 3. Update the gateway setting ==
1.2	182
	183	In the LoRa Basics Station LNS Authentication Key field, paste the API key you generated in the previous step.
	184
70.2	185	[[image:image-20220526135528-11.png]]
1.2	186
	187	paste the API key
	188
71.2	189
1.3	190	== 3.5 Step 4. Access the gateway GUI ==
1.2	191
	192	User need to update the API key and install the Certificate
	193
71.2	194	[[image:image-20220526135601-12.png]]
1.2	195
	196	Access the gateway GUI
	197
73.2	198
1.3	199	== 3.6 Step 5. Configure Station ==
1.2	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
1.7	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	)))
1.2	212
73.2	213	[[image:image-20220526135654-13.png]]
1.2	214
	215	Congfigure Station
	216
73.2	217
1.3	218	== 3.7 Start Station ==
1.2	219
1.3	220	(((
1.2	221	When the user has finished the configuration,Please click Sace&Apply to start station to connect The Things Network.
73.2	222
	223
1.3	224	)))
1.2	225
1.3	226	== 3.8 Siccessful Connection ==
1.2	227
	228	If user completes the above steps,which will see live date in the TTN.
	229
73.2	230	[[image:image-20220526135734-14.png]]
1.2	231
	232	Station live date
	233
74.2	234
1.3	235	== 3.9 Trouble Shooting ==
1.2	236
	237	User can check the station log in the logread/system log page.
	238
74.2	239	[[image:image-20220526135845-15.png]]
1.2	240
	241	Station Log
	242
	243	and recode the station log in the system/Recode log page.
	244
24.2	245	[[image:image-20220525090705-15.png]]
1.2	246
	247	Recore Log
	248
1.3	249	= 4. Configure node connection to TTNv3 =
1.2	250
1.3	251	(((
1.8	252	(((
1.2	253	Following is an example for how to join the TTN v3 LoRaWAN Network.
1.3	254	)))
1.8	255	)))
1.2	256
1.3	257	(((
1.8	258	(((
1.2	259	The gateway is already set up to connect to the TTN network, so we now need to configure the TTNv3 server.
1.3	260	)))
1.8	261	)))
1.2	262
1.3	263	(((
1.8	264	(((
1.2	265	We take LES01 as an example.
1.3	266	)))
1.8	267	)))
1.2	268
1.3	269	== 4.1 Step1 ==
1.2	270
1.3	271	(((
1.8	272	(((
1.2	273	Create a device in TTN with the OTAA keys from LSE01.
1.3	274	)))
1.8	275	)))
1.2	276
1.3	277	(((
1.8	278	(((
1.2	279	Each LSE01 is shipped with a sticker with the default device EUI as below:
1.3	280	)))
1.8	281	)))
1.2	282
1.3	283	(((
1.8	284	(((
1.2	285	You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot:
1.3	286	)))
1.8	287	)))
1.2	288
24.2	289	[[image:image-20220525090739-16.png]]
1.2	290
24.2	291	[[image:image-20220525090833-17.png]]
1.2	292
1.3	293	== 4.2 Step2 ==
1.2	294
1.3	295	(((
1.8	296	(((
1.2	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.
1.3	298	)))
1.8	299	)))
1.2	300
24.2	301	[[image:image-20220525090920-18.png]]
1.2	302
1.3	303	== 4.3 Step3 ==
1.2	304
	305	Add APP EUI in the application:
	306
24.2	307	[[image:image-20220525091022-19.png]]
1.2	308
1.3	309	== 4.4 Step4 ==
1.2	310
	311	Add APP KEY and DEV EUI:
	312
24.2	313	[[image:image-20220525091128-20.png]]
1.2	314
1.3	315	= 5. TTN V3 integrated into MQTT server =
1.2	316
1.3	317	== 5.1 Introduction ==
1.2	318
1.3	319	(((
1.9	320	(((
1.2	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.
1.3	322	)))
1.9	323	)))
1.2	324
1.3	325	== 5.2 Create device steps at MQTT ==
1.2	326
1.3	327	(((
1.9	328	(((
1.2	329	The user creates a new API KEY after creating a device on TTN V3.
1.3	330	)))
1.9	331	)))
1.2	332
1.3	333	(((
1.9	334	(((
1.2	335	Then copy the password and open MQTT.fx.
1.3	336	)))
1.9	337	)))
1.2	338
1.3	339	(((
1.9	340	(((
1.2	341	Fill in Broker Address and Broker port.
1.3	342	)))
1.9	343	)))
1.2	344
24.2	345	[[image:image-20220525091251-22.png]]
1.2	346
	347	Fill in the username and password into MQTT.
	348
	349
27.2	350	[[image:image-20220525091333-23.png]]
1.3	351
1.2	352	The Application Server publishes uplink traffic on the following topics:
	353
1.9	354	(% class="box" %)
	355	(((
	356	v3/{application id}@{tenant id}/devices/{device id}/join
1.2	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
1.9	365	)))
1.2	366
1.3	367	(((
1.9	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}.
1.3	370	)))
1.9	371	)))
1.2	372
27.2	373	[[image:image-20220525091430-24.png]]
1.2	374
1.3	375	(((
1.9	376	(((
1.2	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.
1.3	378	)))
1.9	379	)))
1.2	380
27.2	381	[[image:image-20220525091458-25.png]]
1.2	382
1.3	383	(((
1.10	384	(((
1.2	385	Downlinks can be scheduled by publishing the message to the topic v3/{application id}@{tenant id}/devices/{device id}/down/push.
1.3	386	)))
1.10	387	)))
1.2	388
1.3	389	(((
1.10	390	(((
2.2	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.
1.3	392	)))
1.10	393	)))
1.2	394
1.3	395	(((
1.10	396	(((
1.2	397	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	398	)))
1.10	399	)))
1.2	400
34.2	401	[[image:image-20220525091618-27.png]]
1.2	402
1.3	403	(((
1.2	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:
1.3	405	)))
1.2	406
1.3	407	(((
2.2	408	Note: Use this handy tool to convert hexadecimal to base64.
1.3	409	)))
1.2	410
34.2	411	[[image:image-20220525091702-28.png]]
1.2	412
1.3	413	== 5.3 Send Downlink message ==
1.2	414
1.3	415	(((
1.2	416	How to configure downlink in TTN V3?
1.3	417	)))
1.2	418
1.3	419	(((
1.2	420	A few examples: set the transmission interval to 90 seconds.
1.3	421	)))
1.2	422
1.3	423	(((
1.2	424	Downlink command:01 00 00 5A
1.3	425	)))
1.2	426
34.2	427	[[image:image-20220525091752-29.png]]
1.2	428
	429	downlink
	430
	431	After sending, you can view it in live data.
	432
34.2	433	[[image:image-20220525091816-30.png]]
1.2	434
	435	downlink
	436
1.3	437	(((
1.2	438	When downlink is successfully sent, the downlink information can be received on the serial port.
1.3	439	)))
1.2	440
1.3	441	(((
2.2	442	Note: If the downlink byte sent is longer, the number of bytes will be displayed.
1.3	443	)))
1.2	444
34.2	445	[[image:image-20220525091855-31.png]]
1.2	446
	447	downlink
	448
1.3	449	(((
1.14	450	(((
1.2	451	If you want to get a successful reply to send downlink in TTN v3. You need to set the response level.
1.3	452	)))
1.14	453	)))
1.2	454
1.3	455	(((
1.14	456	(((
2.2	457	If the equipment uses CLASS A. You can set AT+RPL=2 or send the downlink command: 2102
1.3	458	)))
1.14	459	)))
1.2	460
1.3	461	(((
1.14	462	(((
2.4	463	If the equipment uses CLASS C. You can set AT+RPL=4 or send the downlink command: 2104
1.3	464	)))
1.14	465	)))
1.2	466
1.3	467	(((
1.14	468	(((
1.2	469	When the device successfully receives the downlink, the server will receive a confirmation packet of 00.
1.3	470	)))
1.14	471	)))
1.2	472
34.2	473	[[image:image-20220525091925-32.png]]
1.2	474
	475	downlink
	476
1.3	477	= 6. Request Remote Support =
1.2	478
1.3	479	(((
1.2	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.
1.13	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:
1.3	482	)))
1.2	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
36.2	495	[[image:image-20220525092012-33.png]]
1.2	496
	497	Console Output from End device to see the transmit frequency
	498
2.3	499	User can run AT+CFG command to print configuration information.
1.2	500
2.3	501	* Is the device in OTAA mode or ABP mode? AT+NJM=1 (OTAA mode), AT+NJM=0 (ABP mode)
1.2	502
36.2	503	[[image:image-20220525092043-34.png]]
1.2	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
1.13	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	)))
1.2	515
37.2	516	[[image:image-20220525092124-35.png]]
1.2	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
1.12	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	)))
1.2	532
39.2	533	[[image:image-20220525092157-36.png]]
1.2	534
	535	The Traffic for the End node in the server, use TTNv3 as example
	536
	537
39.2	538	[[image:image-20220525092231-37.png]]
1.3	539
1.2	540	The Traffic for the End node in the server, use TTNv3 as example
	541
	542	4. Data Page in LoRaWAN server
	543
1.11	544	(((
2.3	545	(((
41.2	546	(((
1.3	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.
41.2	548
	549	[[image:image-20220525092546-1.png]]
1.3	550	)))
1.11	551	)))
2.3	552	)))
1.2	553
	554	The data for the end device set in server
	555
40.2	556	[[image:image-20220525092430-40.png]]
1.2	557
	558	Check if OTAA Keys match the keys in device

Wiki source code of Notes for TTN

Applications

Navigation