Wiki source code of Notes for TTN

Version 41.3 by Xiaoling on 2022/05/25 09:26

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

Wiki source code of Notes for TTN

Applications

Navigation