Wiki source code of Notes for TTN

Version 66.2 by Xiaoling on 2022/05/26 13:51

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

Wiki source code of Notes for TTN

Applications

Navigation