Wiki source code of Notes for TTN

Version 71.1 by Xiaoling on 2022/05/26 13:56

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

Wiki source code of Notes for TTN

Applications

Navigation