Wiki source code of Notes for TTN

Version 1.6 by Xiaoling on 2022/05/17 09:09

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

Wiki source code of Notes for TTN

Applications

Navigation