Wiki source code of Notes for TTN

Version 1.3 by Xiaoling on 2022/05/17 08:55

version	line-number	content
1.2	1	Contents：
1.1	2
	3
	4
1.2	5	= 1. The Things Network-V3 =
1.1	6
1.2	7	== 1.1 Introduction ==
1.1	8
1.2	9	=== 1.1.1 What is The Things Network ===
1.1	10
1.2	11	(((
	12	The Things Network is a global collaborative Internet of Things ecosystem that creates networks, devices and solutions using LoRaWAN.
	13	)))
1.1	14
1.2	15	(((
	16	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.
	17	)))
1.1	18
1.2	19	=== 1.1.2 Login or crate an account ===
1.1	20
1.2	21	(((
	22	[[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.
	23	)))
1.1	24
1.2	25	(((
	26	Once you have an account,get started by following steps for adding Gateway,Device and Intergrations.
	27	)))
1.1	28
1.2	29	=== 1.1.3 List the support products and Requirements ===
1.1	30
1.2	31	LoRaWAN Gateway model: Existing Gateway
1.1	32
1.2	33	= 2. Gateway Registration for Semtech UDP =
1.1	34
1.3	35	== 2.1 Primary LoRaWAN Server ==
1.1	36
1.3	37	[[image:https://wiki.dragino.com/images/thumb/0/0c/TTN_v3_Primary_001.png/600px-TTN_v3_Primary_001.png\|\|height="296" width="600"]]
1.2	38
	39	Register Gateway
	40
	41
1.3	42	[[image:https://wiki.dragino.com/images/thumb/b/ba/TTN_v3_Primary_002.png/600px-TTN_v3_Primary_002.png\|\|height="283" width="600"]]
	43
1.2	44	Put Gateway ID
	45
	46
1.3	47	[[image:https://wiki.dragino.com/images/thumb/a/a6/TTN_v3_Primary_003.png/600px-TTN_v3_Primary_003.png\|\|height="279" width="600"]]
	48
1.2	49	Choose Frequency Band
	50
	51
1.3	52	[[image:https://wiki.dragino.com/images/thumb/4/44/TTN_v3_Primary_004.png/600px-TTN_v3_Primary_004.png\|\|height="350" width="600"]]
	53
1.2	54	Show Status
	55
1.3	56	== 2.2 Secondary LoRaWAN Server ==
1.2	57
1.3	58	=== 2.2.1 Introduction ===
1.2	59
	60	The Dragino gateway has supports the Secondary server settings.
	61
1.3	62	=== 2.2.2 Below list the support products and Requirements: ===
1.2	63
	64	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]]
	65
	66	1. Firmware version since :[[lgw~~-~~-build-v5.4.1644658774>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LIG16/Firmware/Release/]]
	67
1.3	68	=== 2.2.3 Example ===
1.2	69
	70	The following takes Helium as a Secondary LoRaWAN server as an example,
	71
1.3	72	=== 2.2.4 Step 1: Download and Install the helium gateway-rs ===
1.2	73
	74	The users is needing to download and install the helium gateway-rs then click the button of Save&Apply
	75
1.3	76	[[image:https://wiki.dragino.com/images/thumb/f/f8/Helium_Secondary_001.png/600px-Helium_Secondary_001.png\|\|height="350" width="600"]]
1.2	77
	78	Download and Install gateway-rs
	79
1.3	80	=== 2.2.5 Step 2: Back to Semtech UDP page ===
1.2	81
	82	Back to the page of Semtech UDP check the secondary server settings and click the button of Save&Apply
	83
1.3	84	[[image:https://wiki.dragino.com/images/thumb/c/c8/Helium_Secondary_002.png/600px-Helium_Secondary_002.png\|\|height="415" width="600"]]
1.2	85
	86	Configuration of helium
	87
1.3	88	= 3. Gateway Registration for Basics Station =
1.2	89
1.3	90	== 3.1 Introduction ==
1.2	91
1.3	92	(((
1.2	93	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	94	)))
1.2	95
	96	Below list the support products and Requirements:
	97
1.3	98	1. (((
	99	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]]
	100	)))
1.2	101
1.3	102	1. (((
	103	Firmware version since :[[lgw~~-~~-build-v5.4.1640315898>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
	104	)))
1.2	105
	106	What do you need to prepare
	107
1.3	108	(((
1.2	109	A gateway that can access the internet normally
1.3	110	)))
1.2	111
1.3	112	== 3.2 Step 1. Add Gateway ==
1.2	113
1.3	114	(((
1.2	115	The example for EU
1.3	116	)))
1.2	117
1.3	118	(((
1.2	119	User can add your gateway into The Things Network V3 according to the previous step
1.3	120	)))
1.2	121
1.3	122	(((
1.2	123	Following picture is the successful added.
1.3	124	)))
1.2	125
1.3	126	[[image:https://wiki.dragino.com/images/thumb/5/5f/Add_gateway_1.1.png/600px-Add_gateway_1.1.png\|\|height="397" width="600"]]
1.2	127
	128	Add Gateway
	129
1.3	130	== 3.3 Step 2. Create the API key ==
1.2	131
	132	user need to create the CUPS API key and LNS API key.
	133
1.3	134	[[image:https://wiki.dragino.com/images/thumb/c/c6/Create_cups_api_key.png/600px-Create_cups_api_key.png\|\|height="394" width="600"]]
1.2	135
	136	Create CUPS API key
	137
	138
1.3	139	[[image:https://wiki.dragino.com/images/thumb/5/55/Create_lns_api_key.png/600px-Create_lns_api_key.png\|\|height="403" width="600"]]
	140
1.2	141	Create LNS API key
	142
1.3	143	Note : Please copy the API key.
1.2	144
1.3	145	== 3.4 Step 3. Update the gateway setting ==
1.2	146
	147	In the LoRa Basics Station LNS Authentication Key field, paste the API key you generated in the previous step.
	148
1.3	149	[[image:https://wiki.dragino.com/images/thumb/2/2f/Paste_the_lns_API_key.png/600px-Paste_the_lns_API_key.png\|\|height="363" width="600"]]
1.2	150
	151	paste the API key
	152
1.3	153	== 3.5 Step 4. Access the gateway GUI ==
1.2	154
	155	User need to update the API key and install the Certificate
	156
1.3	157	[[image:https://wiki.dragino.com/images/thumb/a/a3/Access_gateway_gui_ttnstation.png/600px-Access_gateway_gui_ttnstation.png\|\|height="354" width="600"]]
1.2	158
	159	Access the gateway GUI
	160
1.3	161	== 3.6 Step 5. Configure Station ==
1.2	162
	163	User need to input Server URI, Server CUPS Key and LNS Key, as well as install CUPS certificate.
	164
	165	just to clarify.
	166
	167	{{{ CUPS Server URI --> Server Adress
	168	CUPS Authorization Key --> Server CUPS API Key
	169	LNS Authorization Key --> Server LNS API Key
	170	CUPS certificate --> Server CA(user can use the button to install the certificate by default)
	171	}}}
	172
1.3	173	[[image:https://wiki.dragino.com/images/thumb/8/8c/Confiure_station_cao.png/600px-Confiure_station_cao.png\|\|height="321" width="600"]]
1.2	174
	175	Congfigure Station
	176
1.3	177	== 3.7 Start Station ==
1.2	178
1.3	179	(((
1.2	180	When the user has finished the configuration,Please click Sace&Apply to start station to connect The Things Network.
1.3	181	)))
1.2	182
1.3	183	== 3.8 Siccessful Connection ==
1.2	184
	185	If user completes the above steps,which will see live date in the TTN.
	186
1.3	187	[[image:https://wiki.dragino.com/images/thumb/4/49/Station_live_date_cao.png/600px-Station_live_date_cao.png\|\|height="391" width="600"]]
1.2	188
	189	Station live date
	190
1.3	191	== 3.9 Trouble Shooting ==
1.2	192
	193	User can check the station log in the logread/system log page.
	194
1.3	195	[[image:https://wiki.dragino.com/images/thumb/7/7c/Station_log_xiao.png/600px-Station_log_xiao.png\|\|height="457" width="600"]]
1.2	196
	197	Station Log
	198
	199	and recode the station log in the system/Recode log page.
	200
1.3	201	[[image:https://wiki.dragino.com/images/thumb/5/50/Recore_log_xiao.png/600px-Recore_log_xiao.png\|\|height="147" width="600"]]
1.2	202
	203	Recore Log
	204
1.3	205	= 4. Configure node connection to TTNv3 =
1.2	206
1.3	207	(((
1.2	208	Following is an example for how to join the TTN v3 LoRaWAN Network.
1.3	209	)))
1.2	210
1.3	211	(((
1.2	212	The gateway is already set up to connect to the TTN network, so we now need to configure the TTNv3 server.
1.3	213	)))
1.2	214
1.3	215	(((
1.2	216	We take LES01 as an example.
1.3	217	)))
1.2	218
1.3	219	== 4.1 Step1 ==
1.2	220
1.3	221	(((
1.2	222	Create a device in TTN with the OTAA keys from LSE01.
1.3	223	)))
1.2	224
1.3	225	(((
1.2	226	Each LSE01 is shipped with a sticker with the default device EUI as below:
1.3	227	)))
1.2	228
1.3	229	(((
1.2	230	You can enter this key in the LoRaWAN Server portal. Below is TTN screen shot:
1.3	231	)))
1.2	232
1.3	233	[[image:https://wiki.dragino.com/images/thumb/c/c7/TTNv3--01.png/600px-TTNv3--01.png\|\|alt="TTNv3--01.png" height="277" width="600"]]
1.2	234
1.3	235	[[image:https://wiki.dragino.com/images/thumb/1/17/TTNv3--02.png/600px-TTNv3--02.png\|\|alt="TTNv3--02.png" height="226" width="600"]]
1.2	236
1.3	237	== 4.2 Step2 ==
1.2	238
1.3	239	(((
1.2	240	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	241	)))
1.2	242
1.3	243	[[image:https://wiki.dragino.com/images/thumb/f/fc/TTNv3--03.png/600px-TTNv3--03.png\|\|alt="TTNv3--03.png" height="333" width="600"]]
1.2	244
1.3	245	== 4.3 Step3 ==
1.2	246
	247	Add APP EUI in the application:
	248
1.3	249	[[image:https://wiki.dragino.com/images/thumb/9/9f/TTNv3--04.png/600px-TTNv3--04.png\|\|alt="TTNv3--04.png" height="439" width="600"]]
1.2	250
1.3	251	== 4.4 Step4 ==
1.2	252
	253	Add APP KEY and DEV EUI:
	254
1.3	255	[[image:https://wiki.dragino.com/images/thumb/a/a4/TTNv3--05.png/600px-TTNv3--05.png\|\|alt="TTNv3--05.png" height="500" width="600"]]
1.2	256
1.3	257	= 5. TTN V3 integrated into MQTT server =
1.2	258
1.3	259	== 5.1 Introduction ==
1.2	260
1.3	261	(((
1.2	262	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	263	)))
1.2	264
1.3	265	== 5.2 Create device steps at MQTT ==
1.2	266
1.3	267	(((
1.2	268	The user creates a new API KEY after creating a device on TTN V3.
1.3	269	)))
1.2	270
1.3	271	(((
1.2	272	Then copy the password and open MQTT.fx.
1.3	273	)))
1.2	274
1.3	275	(((
1.2	276	Fill in Broker Address and Broker port.
1.3	277	)))
1.2	278
1.3	279	[[image:https://wiki.dragino.com/images/thumb/8/82/V3_MQTT1_.png/600px-V3_MQTT1_.png\|\|alt="V3 MQTT1 .png" height="325" width="600"]]
1.2	280
	281	Fill in the username and password into MQTT.
	282
	283
1.3	284	[[image:https://wiki.dragino.com/images/thumb/6/6a/V3_MQTT2.png/600px-V3_MQTT2.png\|\|alt="V3 MQTT2.png" height="434" width="600"]]
	285
1.2	286	The Application Server publishes uplink traffic on the following topics:
	287
	288	{{{ v3/{application id}@{tenant id}/devices/{device id}/join
	289	v3/{application id}@{tenant id}/devices/{device id}/up
	290	v3/{application id}@{tenant id}/devices/{device id}/down/queued
	291	v3/{application id}@{tenant id}/devices/{device id}/down/sent
	292	v3/{application id}@{tenant id}/devices/{device id}/down/ack
	293	v3/{application id}@{tenant id}/devices/{device id}/down/nack
	294	v3/{application id}@{tenant id}/devices/{device id}/down/failed
	295	v3/{application id}@{tenant id}/devices/{device id}/service/data
	296	v3/{application id}@{tenant id}/devices/{device id}/location/solved
	297	}}}
	298
1.3	299	(((
1.2	300	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	301	)))
1.2	302
1.3	303	[[image:https://wiki.dragino.com/images/thumb/d/dc/V3_MQTT3.png/600px-V3_MQTT3.png\|\|alt="V3 MQTT3.png" height="400" width="600"]]
1.2	304
1.3	305	(((
1.2	306	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	307	)))
1.2	308
1.3	309	[[image:https://wiki.dragino.com/images/thumb/e/e8/V3_MQTT4.jpg/600px-V3_MQTT4.jpg\|\|alt="V3 MQTT4.jpg" height="326" width="600"]]
1.2	310
1.3	311	(((
1.2	312	Downlinks can be scheduled by publishing the message to the topic v3/{application id}@{tenant id}/devices/{device id}/down/push.
1.3	313	)))
1.2	314
1.3	315	(((
1.2	316	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	317	)))
1.2	318
1.3	319	(((
1.2	320	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	321	)))
1.2	322
1.3	323	[[image:https://wiki.dragino.com/images/thumb/e/e8/V3_MQTT5.png/600px-V3_MQTT5.png\|\|alt="V3 MQTT5.png" height="289" width="600"]]
1.2	324
1.3	325	(((
1.2	326	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	327	)))
1.2	328
1.3	329	(((
1.2	330	Note: Use this handy tool to convert hexadecimal to base64.
1.3	331	)))
1.2	332
1.3	333	[[image:https://wiki.dragino.com/images/thumb/9/9f/V3_MQTT6.png/600px-V3_MQTT6.png\|\|alt="V3 MQTT6.png" height="313" width="600"]]
1.2	334
1.3	335	== 5.3 Send Downlink message ==
1.2	336
1.3	337	(((
1.2	338	How to configure downlink in TTN V3?
1.3	339	)))
1.2	340
1.3	341	(((
1.2	342	A few examples: set the transmission interval to 90 seconds.
1.3	343	)))
1.2	344
1.3	345	(((
1.2	346	Downlink command:01 00 00 5A
1.3	347	)))
1.2	348
1.3	349	[[image:https://wiki.dragino.com/images/thumb/9/90/Downlink_50.png/600px-Downlink_50.png\|\|height="327" width="600"]]
1.2	350
	351	downlink
	352
	353	After sending, you can view it in live data.
	354
1.3	355	[[image:https://wiki.dragino.com/images/thumb/1/15/Downlink_51.png/600px-Downlink_51.png\|\|height="141" width="600"]]
1.2	356
	357	downlink
	358
1.3	359	(((
1.2	360	When downlink is successfully sent, the downlink information can be received on the serial port.
1.3	361	)))
1.2	362
1.3	363	(((
1.2	364	Note: If the downlink byte sent is longer, the number of bytes will be displayed.
1.3	365	)))
1.2	366
1.3	367	[[image:https://wiki.dragino.com/images/thumb/c/c9/Downlink_52.png/600px-Downlink_52.png\|\|height="407" width="600"]]
1.2	368
	369	downlink
	370
1.3	371	(((
1.2	372	If you want to get a successful reply to send downlink in TTN v3. You need to set the response level.
1.3	373	)))
1.2	374
1.3	375	(((
1.2	376	If the equipment uses CLASS A. You can set AT+RPL=2 or send the downlink command: 2102
1.3	377	)))
1.2	378
1.3	379	(((
1.2	380	If the equipment uses CLASS C. You can set AT+RPL=4 or send the downlink command: 2104
1.3	381	)))
1.2	382
1.3	383	(((
1.2	384	When the device successfully receives the downlink, the server will receive a confirmation packet of 00.
1.3	385	)))
1.2	386
1.3	387	[[image:https://wiki.dragino.com/images/thumb/d/d9/Downlink_54.png/600px-Downlink_54.png\|\|height="127" width="600"]]
1.2	388
	389	downlink
	390
1.3	391	= 6. Request Remote Support =
1.2	392
1.3	393	(((
1.2	394	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.
	395	\\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]] 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	396	)))
1.2	397
	398	* End node is connected to serial port to show the Join frequency and DR. (If possible)
	399	* Gateway (from gateway UI) traffic to show the packet got from end node and receive from Server. (If possible)
	400	* Gateway traffic (from server UI) to shows the data exchange between gateway and server. (Normally possible)
	401	* End Node traffic (from server UI) to shows end node activity in server. (Normally possible)
	402	* 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)
	403
	404
	405	~1. End Device Join Screen shot, we can check:
	406
	407	* If the device is sending join request to server?
	408	* What frequency the device is sending?
	409
1.3	410	[[image:https://wiki.dragino.com/images/thumb/7/77/LoRaWAN_Communication_Debug1.png/600px-LoRaWAN_Communication_Debug1.png\|\|height="596" width="600"]]
1.2	411
	412	Console Output from End device to see the transmit frequency
	413
	414	User can run AT+CFG command to print configuration information.
	415
	416	* Is the device in OTAA mode or ABP mode? AT+NJM=1 (OTAA mode), AT+NJM=0 (ABP mode)
	417
1.3	418	[[image:https://wiki.dragino.com/images/thumb/c/c5/LoRaWAN_Communication_Debug23.png/600px-LoRaWAN_Communication_Debug23.png\|\|height="514" width="600"]]
1.2	419
	420	Console Output from End device to see the transmit frequency
	421
	422	2. Gateway packet traffic in gateway web or ssh. we can check:
	423
	424	* If the gateway receive the Join request packet from sensor? (If this fail, check if the gateway and sensor works on the match frequency)
	425	* If the gateway gets the Join Accept message from server and transmit it via LoRa?
	426
1.3	427	[[image:https://wiki.dragino.com/images/thumb/1/1c/OTAA_Join-2.png/600px-OTAA_Join-2.png\|\|height="325" width="600"]]
1.2	428
	429	Console Output from Gateway to see packets between end node and server.
	430
	431
	432	3. Gateway Traffic Page in LoRaWAN Server
	433
	434	* If the Join Request packet arrive the gateway traffic in server? If not, check the internet connection and gateway LoRaWAN server settings.
	435	* 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.
	436	* 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.
	437
1.3	438	[[image:https://wiki.dragino.com/images/thumb/d/da/LoRaWAN_Communication_Debug22.png/600px-LoRaWAN_Communication_Debug22.png\|\|height="268" width="600"]]
1.2	439
	440	The Traffic for the End node in the server, use TTNv3 as example
	441
	442
1.3	443	[[image:https://wiki.dragino.com/images/thumb/4/4b/LoRaWAN_Communication_Debug3.png/600px-LoRaWAN_Communication_Debug3.png\|\|height="281" width="600"]]
	444
1.2	445	The Traffic for the End node in the server, use TTNv3 as example
	446
	447	4. Data Page in LoRaWAN server
	448
1.3	449	* (((
	450	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.
	451	)))
1.2	452
1.3	453	[[image:https://wiki.dragino.com/images/thumb/9/99/LoRaWAN_Communication_Debug4.png/600px-LoRaWAN_Communication_Debug4.png\|\|height="222" width="600"]]
1.2	454
	455	The data for the end device set in server
	456
1.3	457	[[image:https://wiki.dragino.com/images/thumb/6/69/LoRaWAN_Communication_Debug5.png/600px-LoRaWAN_Communication_Debug5.png\|\|height="279" width="600"]]
1.2	458
	459	Check if OTAA Keys match the keys in device

Wiki source code of Notes for TTN

Applications

Navigation