Wiki source code of Notes for ChirpStack

Version 224.1 by Kilight Cao on 2024/09/23 14:18

version	line-number	content
108.4	1	~ Table of Contents:
1.2	2
1.1	3	{{toc/}}
	4
86.4	5
	6
	7
108.4	8	= 1. Introduction =
1.1	9
108.4	10
53.1	11	(% style="color:black" %)The ChirpStack open-source LoRaWAN Network Server stack provides open-source components for LoRaWAN networks And the Chirpstack supports the users in building a private LoRaWAN Server. For more info please refer to this [[link>>url:https://www.chirpstack.io/]]
1.1	12
1.5	13	(((
51.1	14	(% style="color:black" %)The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station.
108.4	15
	16
1.5	17	)))
1.1	18
108.4	19	(% style="color:blue" %)Prerequisite:
1.1	20
108.4	21	1) Have a Chirstack Server.
1.1	22
172.1	23	[[image:image-20230821114047-4.png\|\|height="524" width="990"]]
1.1	24
1.2	25	ChirpStack home page
1.1	26
54.2	27
1.1	28
108.4	29	2) Gateway model support
	30
1.2	31	(% class="box" %)
	32	(((
1.5	33	(((
1.2	34	Semtech UDP : All Model
108.4	35	Basic Station : [[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]]
	36	(% style="color:red" %)Note (%%): the firmware needs >[[lgw~~-~~-build-v5.4.1640315898>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]] if use the Bais station
1.2	37	)))
1.5	38	)))
1.1	39
176.2	40
164.1	41	= 2. Node usage introduction =
86.5	42
164.1	43	== 2.1 Register Node ==
1.1	44
	45
176.2	46	Step 1: Add application
	47
220.1	48	[[image:image-20240831154333-1.png\|\|height="553" width="1074"]]
108.4	49
164.1	50
176.2	51	Step 2：Fill name
	52
164.1	53	[[image:image-20230702094852-2.png]]
	54
	55
176.2	56	Step3 ：Add device profile
	57
164.1	58	[[image:image-20230702095114-4.png\|\|height="448" width="1061"]]
	59
	60
176.2	61	Step4 ：Configure your device profile
164.1	62
	63	[[image:image-20230702095557-5.png\|\|height="648" width="1121"]]
	64
	65	Does node support class-c
	66
	67	[[image:image-20230702095641-6.png\|\|height="349" width="1114"]]
	68
	69	Add node's decoder
	70
	71	[[image:image-20230702095827-7.png\|\|height="490" width="1138"]]
	72
	73
176.2	74	Step5 ：add device
164.1	75
	76	[[image:image-20230702094944-3.png\|\|height="439" width="1153"]]
	77
	78
176.2	79	[[image:image-20230702100312-8.png\|\|height="550" width="1106"]]
164.1	80
	81
	82	[[image:image-20230702100543-10.png\|\|height="313" width="1099"]]
	83
176.2	84
164.1	85	[[image:image-20230702100930-11.png\|\|height="613" width="1098"]]
	86
	87
176.1	88	= 3. Semtech UDP for ChirpStack v3 =
164.1	89
	90	== 3.1 Step 1. Add the Network-servers ==
	91
	92
1.2	93	The network-Servers address varies depending on the ChirpStack server setup environment
1.1	94
1.3	95	(% class="box" %)
	96	(((
108.5	97	Windows ~-~-> Network-server server * : localhost:8000
	98	Linux ~-~-> Network-server server * : chirpstack-network-server:8000
1.3	99	)))
1.1	100
108.4	101
108.6	102	(% style="color:red" %)If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.
1.1	103
151.2	104	[[image:image-20220531171609-1.png\|\|height="638" width="1268"]](% style="display:none" %)
1.2	105
	106	Add the Network-servers
	107
84.2	108
164.1	109	== 3.2 Step 2. Create Gateway-profiles ==
1.2	110
108.6	111
151.2	112	[[image:image-20220531171651-2.png\|\|height="632" width="1264"]](% style="display:none" %)
1.2	113
	114	Create Gateway-profiles
	115
84.2	116
164.1	117	== 3.3 Step 3. Create Service-profiles ==
108.6	118
	119
151.2	120	[[image:image-20220531171809-3.png\|\|height="761" width="1265"]]
1.2	121
	122	Create Service-profiles
	123
89.3	124
1.2	125	In Step 3. Create Service-profiles, the above parameters can be set. If necessary, you can set them by yourself. This is only an example.
	126
1.4	127	(% style="color:red" %)Note : Before add the gateway, the user needs to complete the preceding three steps.
1.2	128
84.2	129	If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %)
1.2	130
84.2	131
164.1	132	== 3.4 Step 4. Add the gateway ==
1.2	133
108.7	134
1.2	135	The example gateway id is: a840411e96744150
	136
1.5	137	(((
1.4	138	(% style="color:red" %)Note : The Gateway EUI and server addresses must match the ChirpStack configuration.
1.5	139	)))
1.2	140
151.2	141	[[image:image-20220531171923-4.png\|\|height="745" width="1253"]](% style="display:none" %)
1.2	142
	143	Add the gateway
	144
108.7	145
91.2	146	[[image:image-20220531172031-5.png]]
1.2	147
	148	Configure the gateway
	149
84.2	150
164.1	151	== 3.5 Step 5. Checking gateway Status ==
108.8	152
	153
151.2	154	[[image:image-20220531172158-6.png\|\|height="704" width="1167"]](% style="display:none" %)
1.2	155
84.2	156
108.8	157
1.2	158	gateway Status
	159
151.2	160	[[image:image-20220531172304-7.png\|\|height="628" width="1165"]]
1.2	161
	162	gateway Status
	163
176.2	164
176.1	165	= 4. Semtech UDP for ChirpStack v4 =
86.6	166
176.1	167	== 4.1 Step 1. Add the gateway ==
9.1	168
176.2	169
176.1	170	[[image:image-20230926092907-1.png\|\|height="598" width="1007"]]
108.8	171
176.1	172
	173	[[image:image-20230926093057-2.png\|\|height="541" width="1002"]]
	174
	175
	176	== 4.2 Step 2. Checking gateway Status ==
	177
	178	[[image:image-20230926093233-3.png\|\|height="581" width="1018"]]
	179
	180	= 5. Gateway Registration for Basics Station =
	181
	182	== 5.1 Introduction ==
	183
	184
9.1	185	The [[Semtech Basic Station>>url:https://doc.sm.tc/station/]] backend implements the [[LNS protocol>>url:https://doc.sm.tc/station/tcproto.html]]. It exposes a WebSocket handler to which Basic Station powered gateways can connect.
	186
	187	ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
	188
	189
108.8	190	(% style="color:blue" %)Below list the support products and Requirements:
	191
9.1	192	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]]
	193	1. Firmware version since :[[lgw~~-~~-build-v5.4.1651822913>>url:https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Test_Firmware/lgw--build-v5.4.1651822913-20220506-1543/]]
	194
108.8	195	(% style="color:blue" %)How to set up chirpStack Basic Station
	196
9.1	197	Users can check out the ChirpStack Basic Station [[link>>https://www.chirpstack.io/gateway-bridge/backends/basic-station/]] and [[forum>>https://forum.chirpstack.io/search?q=basic%20station]]
	198
	199
108.8	200	(% style="color:blue" %)What do you need to prepare
	201
9.1	202	A gateway that can access the internet normally
	203
86.7	204
176.1	205	== 5.2 Add Gateway ==
9.1	206
108.9	207
20.2	208	[[image:image-20220524164205-10.png]]
9.1	209
86.8	210
176.1	211	== 5.3 Access the gateway GUI ==
9.1	212
108.9	213
9.1	214	Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
	215
20.2	216	[[image:image-20220524164319-11.png]]
9.1	217
108.9	218
9.1	219	User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
	220
	221	(% class="box" %)
	222	(((
	223	Service Provider ~-~-> Choose the ChirpStack/Senet ~-~- Basic Station
	224
165.1	225	LNS URI ~-~-> Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:443 or ws:~/~/xxxx.chirpstack.com:3001
9.1	226
	227	LNS TLS trust ~-~-> Upload the TLS Certificate
	228	)))
	229
	230	(% class="wikigeneratedid" %)
20.2	231	[[image:image-20220524164341-12.png]]
9.1	232
86.9	233
176.1	234	== 5.4 Start Station ==
9.1	235
108.9	236
108.14	237	When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack.
9.1	238
86.10	239
176.1	240	== 5.5 Successful Connection ==
9.1	241
108.9	242
9.1	243	If user completes the above steps, which will see live date in the ChirpStack.
	244
23.2	245	[[image:image-20220524164448-13.png]]
9.1	246
86.11	247
176.1	248	== 5.6 Trouble Shooting ==
108.9	249
	250
9.1	251	User can check the station log in the logread/system log page.
	252
95.2	253	[[image:image-20220531172837-8.png]]
9.1	254
86.13	255
9.1	256	and recode the station log in the system/Recode log page.
	257
95.2	258	[[image:image-20220531172857-9.png]]
9.1	259
86.12	260
176.1	261	= 6. How the gateway connects to Chirpstack v3 via gateway-bridge =
108.9	262
1.2	263
128.1	264	(% style="color:blue" %)Below list the support products and Requirements:
	265
	266	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]],[[LPS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html]],[[LG308N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/229-lg308n.html]],[[DLOS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/225-dlos8n.html]]
138.1	267	1. Firmware version since: [[Chirpstack-Bridge-V3.14.6>>https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/Chirpstack-Bridge-V3.14.6-Bridge--build-v5.4.1679487778-20230322-2024/]]
128.1	268
	269	(% style="color:blue" %)What do you need to prepare
	270
	271	A gateway that can access the internet normally
	272
1.2	273
138.1	274	The following example does not have configuration certificates:
	275
138.2	276
176.1	277	== 6.1 Configure Packet Forwarder ==
131.2	278
	279
124.1	280	In the Dragino gateway web interface, you need to configure the Packet Forwarder so that it forwards its data to the port. localhost:1700 or 127.0.0.1:1700
121.2	281
138.3	282	* In the (% style="color:blue" %)LoRaWAN (%%)menu, click on (% style="color:blue" %)LoRaWAN ~-~- Semtech UDP
138.2	283
124.1	284	* Make sure the following settings are set:
138.4	285	Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
	286	LoRaWAN Server Address:** //localhost or 127.0.0.1//
	287	Server port for upstream:** //1700//
	288	Server port for downstream:** //1700//
138.2	289
138.3	290	Click (% style="color:blue" %)Save & Apply.
124.1	291
	292	[[image:image-20221222114220-2.png\|\|height="748" width="931"]]
	293
	294
176.1	295	== 6.2 Configuring gateway frequency ==
124.1	296
127.1	297
131.2	298	(% style="color:red" %)Note: Gateway frequencies must match
	299
127.1	300	[[image:image-20221222134830-3.png\|\|height="408" width="923"]]
	301
	302
176.1	303	== 6.3 Generate and modify the gateway-bridge configuration file ==
127.1	304
	305
138.1	306	1）Generate the gateway-bridge configuration file
	307
	308	By default, the configuration file is not up-to-date,so the user needs to rebuild the gateway-bridge configuration file.
	309
	310	Users need to access the command line of the gateway through SSH,Then type the following command:
	311
	312	(% class="box infomessage" %)
	313	(((
138.5	314	/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
138.1	315	)))
	316
	317
	318	2）modify the gateway-bridge configuration file
	319
	320	The user needs to modify the server address in line 252 in the configuration file
	321
	322	(% class="box infomessage" %)
	323	(((
138.5	324	vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
138.1	325	)))
	326
	327	[[image:image-20230415165254-1.png\|\|height="583" width="956"]]
	328
	329
176.1	330	== 6.4 Debug ==
138.1	331
	332
	333	After the above configuration is completed, the user can enter the command to debug the gateway-bridge connection
	334
	335	(% class="box infomessage" %)
	336	(((
138.5	337	/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge ~-~-config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
138.1	338	)))
	339
	340	If the gateway-bridge connection is normal, the debug log displays "connected to mqtt broker".
	341
	342	[[image:image-20230415170404-2.png]]
	343
	344
	345	If the debug log shows "connection error", check that the server port or server is correct
	346
	347	[[image:image-20230415170854-3.png]]
	348
	349
	350	More information can be found on the [[ChirpStack website>>https://www.chirpstack.io/docs/]]or [[Forum>>url:https://forum.chirpstack.io/]]
	351
	352
176.1	353	== 6.5 (Re)start and stop gateway-bridge ==
138.1	354
	355
	356	Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
	357
	358	(% class="box infomessage" %)
	359	(((
	360	# start
	361
	362	/etc/init.d/chirpstack-gateway-bridge start
	363
	364	# stop
	365
	366	/etc/init.d/chirpstack-gateway-bridge stop
	367
	368	# restart
	369
	370	/etc/init.d/chirpstack-gateway-bridge restart
	371	)))
	372
	373
176.1	374	= 7. How the gateway connects to Chirpstack v4 via gateway-bridge =
138.1	375
	376
	377	(% style="color:blue" %)Below list the support products and Requirements:
	378
	379	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]],[[LPS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/200-lps8n.html]],[[LG308N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/229-lg308n.html]],[[DLOS8N>>url:https://www.dragino.com/products/lora-lorawan-gateway/item/225-dlos8n.html]]
	380	1. Firmware version since: [[Chirpstack-Bridge-V4>>https://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/Chirpstack-gateway-bridge/Chirpstack-Bridge-V4--build-v5.4.1670655072-20221210-1452/]]
	381
	382	(% style="color:blue" %)What do you need to prepare
	383
	384	A gateway that can access the internet normally
	385
	386
176.1	387	== 7.1 Configure Packet Forwarder ==
138.1	388
	389
	390	In the Dragino gateway web interface, you need to configure the Packet Forwarder so that it forwards its data to the port. localhost:1700 or 127.0.0.1:1700
	391
138.5	392	* In the (% style="color:blue" %)LoRaWAN(%%) menu, click on (% style="color:blue" %)LoRaWAN ~-~- Semtech UDP
	393
138.1	394	* Make sure the following settings are set:
	395	Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
	396	LoRaWAN Server Address:** //localhost or 127.0.0.1//
	397	Server port for upstream:** //1700//
	398	Server port for downstream:** //1700//
	399
138.5	400	Click (% style="color:blue" %)Save & Apply.
138.1	401
	402	[[image:image-20221222114220-2.png\|\|height="748" width="931"]]
	403
	404
176.1	405	== 7.2 Configuring gateway frequency ==
138.1	406
	407
	408	(% style="color:red" %)Note: Gateway frequencies must match
	409
	410	[[image:image-20221222134830-3.png\|\|height="408" width="923"]]
	411
	412
176.1	413	== 7.3 Modify the gateway-bridge configuration file ==
138.1	414
	415
127.1	416	Run the gateway command line command to modify the gateway-bridge configuration file:
	417
	418	(% class="box infomessage" %)
	419	(((
138.5	420	root@dragino-1d27d4:~~# vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
127.1	421	)))
	422
124.1	423	[[image:image-20221222113302-1.png]]
	424
131.2	425
127.1	426	[[image:image-20221222140203-4.png\|\|height="875" width="806"]]
	427
176.2	428
211.1	429	Configure the server address to which the gateway needs to be connected,"tcp:~/~/chirpstack_address:1883"
	430
133.1	431	[[image:image-20221230094246-1.png\|\|height="768" width="783"]]
127.1	432
	433	(% class="wikigeneratedid" id="H" %)
	434	After the modification, run the following command: /etc/init.d/chirpstack-gateway-bridge restart
	435
	436
176.1	437	== 7.4 (Re)start and stop gateway-bridge ==
131.2	438
	439
127.1	440	Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
	441
	442	(% class="box infomessage" %)
	443	(((
	444	# start
	445
	446	/etc/init.d/chirpstack-gateway-bridge start
	447
	448	# stop
	449
	450	/etc/init.d/chirpstack-gateway-bridge stop
	451
	452	# restart
	453
	454	/etc/init.d/chirpstack-gateway-bridge restart
	455	)))
	456
131.1	457
176.1	458	== 7.5 Successful Connection ==
131.1	459
131.2	460
131.1	461	[[image:image-20221222141754-5.png\|\|height="488" width="1150"]]
	462
131.2	463
131.1	464	[[image:image-20221222141830-6.png\|\|height="582" width="1153"]]
	465
131.2	466
176.1	467	= 8. Downlink =
124.1	468
183.1	469
177.2	470	=== 8.1 Chirpstack Downlink Note ===
124.1	471
	472
184.1	473	==== Select HEX format for downlink ====
108.9	474
183.1	475
177.2	476	(% style="color:red" %)Note: The end node user manual provides HEX format of the downlink commands, so users can directly select HEX format downlink.
111.1	477
	478
183.1	479	[[image:image-20231108171112-5.png\|\|height="629" width="1117"]]
111.1	480
	481
183.1	482	[[image:image-20231108171145-6.png\|\|height="497" width="1101"]]
121.2	483
111.1	484
	485
	486
1.2	487
121.2	488	[[image:image-20220531173236-10.png\|\|height="597" width="1215"]]
1.2	489
121.2	490	Check ChripStack downlink DataRate
86.15	491
121.2	492
	493
65.2	494	[[image:image-20220525101326-11.png]]
1.2	495
121.2	496	Make sure the RX2DR is the same in the end node
1.2	497
86.16	498
176.1	499	== 8.3 Loraserver Downlink Note ==
108.9	500
	501
1.2	502	User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
	503
1.5	504	(((
108.9	505	Below is examples:
1.5	506	)))
1.2	507
1.4	508	(% class="box" %)
	509	(((
	510	Connect to your server via MQTT：
	511	MQTT Client ID: Any
	512	Protocol：mqtt/tcp Server IP：loraserver_ip:1883
1.2	513	User name: User name Password: password
1.4	514	)))
1.2	515
97.2	516	[[image:image-20220531173419-11.png]]
1.2	517
1.5	518	(((
121.2	519	MQTT Connect to ChirpStack
86.17	520
108.9	521
86.17	522
1.5	523	)))
1.2	524
1.5	525	(((
108.9	526	After connect
1.5	527	)))
1.2	528
1.4	529	(% class="box" %)
	530	(((
	531	Subscribe : Format：application/ID/device/ Device EUI/rx
1.2	532	Example: application/7/device/00aedb3da649cb23/rx
1.4	533	)))
1.2	534
1.4	535	(% class="box" %)
	536	(((
	537	Publish:
1.2	538	Format: Top: application/ID/device/ Device EUI/tx
	539	Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
	540	Example: Top: application/7/device/00aedb3da649cb23/tx
	541	Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
1.4	542	)))
1.2	543
98.2	544	[[image:image-20220531173519-12.png]]
1.2	545
121.2	546	MQTT Connect to ChirpStack
1.2	547
86.18	548
1.2	549
177.2	550	(((
	551	Downlink payload encode javescript code.
1.2	552
177.2	553	We can run the following Javsscript code on the site:
1.5	554	)))
1.2	555
1.4	556	(% class="box" %)
	557	(((
	558	function sha1_to_base64(sha1)
1.2	559	{
	560	var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
	561	var base64_rep = "";
	562	var cnt = 0;
	563	var bit_arr = 0;
	564	var bit_num = 0;
1.5	565	\\ for(var n = 0; n < sha1.length; ++n)
1.2	566	{
	567	if(sha1[n] >= 'A' && sha1[n] <= 'Z')
	568	{
121.1	569	ascv = sha1.charCodeAt( n ) - 55;
1.2	570	}
	571	else if(sha1[n] >= 'a' && sha1[n] <= 'z')
	572	{
121.1	573	ascv = sha1.charCodeAt( n ) - 87;
1.2	574	}
	575	else
	576	{
121.1	577	ascv = sha1.charCodeAt( n ) - 48;
1.2	578	}
1.5	579	\\ bit_arr = (bit_arr << 4) \| ascv;
1.2	580	bit_num += 4;
	581	if(bit_num >= 6)
	582	{
1.4	583	bit_num -= 6;
1.2	584	base64_rep += digits[bit_arr >>> bit_num];
1.4	585	bit_arr &= ~~(-1 << bit_num);
1.2	586	}
	587	}
1.5	588	\\ if(bit_num > 0)
1.2	589	{
	590	bit_arr <<= 6 - bit_num;
	591	base64_rep += digits[bit_arr];
	592	}
1.5	593	\\ var padding = base64_rep.length % 4;
	594	\\ if(padding > 0)
1.2	595	{
	596	for(var n = 0; n < 4 - padding; ++n)
	597	{
	598	base64_rep += "=";
	599	}
	600	}
	601	return base64_rep;
	602	}
1.5	603	\\console.log(sha1_to_base64("data"));
	604	\\data is downlink payload required by end node.
1.4	605	e.g console.log(sha1_to_base64("030101"));
	606	result: AwEB
1.2	607	AwEB is the 0x030101's base 64 Encode.
1.5	608	\\e.g console.log(sha1_to_base64("030000"));
1.4	609	result: AwAA
	610	AwAA is 0x030000's base 64 Encode.
	611	)))
1.2	612
86.21	613
176.1	614	== 8.4 Add the decode function in Chirpstack for the payload ==
108.9	615
	616
1.2	617	User enters the payload code according to the steps.
	618
150.1	619	Add the node device decoder you are using. The decoder for each node device is different. The decoder is found in this link: [[decoder for dragino end node>>https://github.com/dragino/dragino-end-node-decoder]]
	620
121.2	621	[[image:image-20220531173754-15.png\|\|height="474" width="1334"]]
1.2	622
	623
102.2	624	[[image:image-20220531173856-16.png]]
1.2	625
102.2	626
106.2	627	[[image:image-20220531174120-20.png]]
84.2	628
105.2	629	[[image:image-20220531174046-19.png]]
1.2	630
86.22	631
221.1	632	= 9. Chirpstack Multicast Configuration =
	633
	634
	635	== 9.1 Introduction ==
	636
	637	ChirpStack has support for creating multicast-groups to which devices can be assigned. When enqueueing a downlink payload for a multicast-group, ChirpStack will analyze which gateways must be used for broadcasting to cover the complete multicast-group. This means that potentially, a single multicast downlink payload will be emitted multiple times.
	638
	639	Multicast can be used for the following device-classes:
	640
	641	* Class-B
	642	* Class-C
	643
223.1	644	== 9.2 Example to configure chirpstack Multicast ==
221.1	645
	646
223.1	647	This section illustrates how to configure ChirpStack Multicast. Below is the network structure, we use our LPS8v2 as the LoRaWAN gateway and SN50v3-LB as the LoRaWAN end-node here.
221.1	648
223.1	649	[[image:image-20240923105725-1.png]]
221.1	650
223.1	651	The LPS8V2 is already set to connect to Chirpstack. So what we need to do now is only configure register these devices to Chirpstack:
221.1	652
	653
223.1	654	=== Step 1. Create the multicast group ===
	655
	656
	657
176.1	658	= 9. Multiply Uplink in ChirpStack =
108.9	659
	660
1.4	661	(((
1.2	662	nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
1.4	663	)))
1.2	664
1.4	665	(((
1.2	666	ChirpStack will auto adjust nbtrans according to uplink rssi. [[link to source>>url:https://github.com/brocaar/chirpstack-network-server/blob/master/internal/adr/adr.go]]
108.9	667
	668
1.4	669	)))
1.2	670
121.2	671	[[image:image-20220526091912-7.png\|\|height="241" width="1336"]]
1.2	672
108.9	673
1.5	674	(((
1.2	675	nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.
108.9	676
	677
1.5	678	)))
1.2	679
76.2	680	[[image:image-20220525104359-21.png]]
1.2	681
1.4	682	(((
1.2	683	Above behaviour will cause the platform shows below two cases of error:
108.9	684
	685
1.4	686	)))
1.2	687
1.4	688	(((
1.2	689	Error of duplicate Frame Counter
1.4	690	)))
1.2	691
76.2	692	[[image:image-20220525104437-22.png]]
1.2	693
86.23	694
108.9	695
121.2	696	Duplicate transmission in short time
1.2	697
176.2	698	[[image:image-20220601102430-1.png\|\|height="508" width="1120"]]
1.2	699
86.24	700
176.1	701	== 9.1 Solution ==
108.9	702
	703
1.2	704	This example uses the Windows version as a template, other versions can refer to this. Similiar reference: [[https:~~/~~/confluence.alitecs.de/plugins/servlet/mobile?contentId=79790102#content/view/79790102>>url:https://confluence.alitecs.de/plugins/servlet/mobile?contentId=79790102#content/view/79790102]]
	705
1.5	706	(((
108.11	707	(% style="color:blue" %)1. Install the GO compilation environment: Download the corresponding version of the Go compiler at [[https:~~/~~/go.dev/dl/>>url:https://go.dev/dl/]] and install it.
1.5	708	)))
1.2	709
79.2	710	[[image:image-20220525104532-24.png]]
1.2	711
86.25	712
108.9	713	installation path:
1.2	714
79.2	715	[[image:image-20220525104554-25.png]]
1.2	716
86.25	717
108.9	718
1.5	719	(((
108.11	720	(% style="color:blue" %)2. Environment variable settings:
1.5	721	)))
1.2	722
1.5	723	(((
1.2	724	1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
1.5	725	)))
1.2	726
1.5	727	(((
108.9	728	2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
1.5	729	)))
1.2	730
43.2	731	[[image:image-20220524165433-33.png]]
1.2	732
86.26	733
108.9	734	3) Modify the system variable Path and add C:\Go\bin\:
1.2	735
43.2	736	[[image:image-20220524165452-34.png]]
1.2	737
106.3	738
1.2	739	User variable setting file generation directory: D:\go:
	740
43.2	741	[[image:image-20220524165517-35.png]]
1.2	742
86.27	743
1.2	744
108.11	745	(% style="color:blue" %)3. Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.
108.9	746
1.2	747	The name of the plugin: Example ADR plugin:
	748
48.2	749	[[image:image-20220524165540-36.png]]
1.2	750
	751	Set Nbtrans: Nbtrans=1 (Nbtrans is the number of retransmissions, if it is 1, no retransmission, it is recommended to be 1). To enable it, you need to uncomment.
	752
48.2	753	[[image:image-20220524165557-37.png]]
1.2	754
86.28	755
1.2	756
108.11	757	(% style="color:blue" %)4. Compile the ADR configuration file and generate the exe file.
108.9	758
1.2	759	1) Create a folder named adr-setting
	760
	761	2) Open the adr-setting folder
	762
	763	3) Put adr.setting.go in this folder.
	764
	765	4) Open the computer cmd and run the following commands in sequencecd adr-setting
	766
	767	go mod init adr-setting
	768
	769	go get github.com/brocaar/chirpstack-network-server/v3/adr
	770
	771	go get github.com/hashicorp/go-plugin
	772
	773	go get adr-setting
	774
	775	go build
	776
	777	5) Finally generate this file：
	778
48.2	779	[[image:image-20220524165623-38.png]]
1.2	780
86.29	781
1.2	782
108.11	783	(% style="color:blue" %)5. Add the plugin and run the plugin.
108.9	784
1.5	785	(((
1.2	786	The exe file generated in the previous step is placed in the same root directory as chirpstack-network-server.toml, and the ADR plugin is added to the toml file. The location of the addition is as follows:
1.5	787	)))
1.2	788
48.2	789	[[image:image-20220524165641-39.png]]
1.2	790
1.4	791	(((
1.5	792	(((
1.2	793	For example: adr_plugins=[“adr-setting”]
1.4	794	)))
1.5	795	)))
1.2	796
1.4	797	* (((
1.5	798	(((
1.4	799	Adding a single plugin format is adr_plugins=["filename"]
	800	)))
1.5	801	)))
1.2	802
1.4	803	* (((
1.5	804	(((
1.4	805	Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
	806	)))
1.5	807	)))
1.2	808
1.4	809	(((
1.5	810	(((
1.2	811	Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
1.4	812	)))
1.5	813	)))
1.2	814
79.2	815	[[image:image-20220525104647-26.png]]
1.2	816
	817	Finish.
	818
86.30	819
176.1	820	= 10. How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. =
108.9	821
1.2	822
115.1	823	All data is published to the MQTT topics. if you want to store/get the data, you would have to create an MQTT handler and store the data yourself.
1.2	824
115.1	825	This example will be shown how to store/get all the data in two ways:
108.9	826
138.5	827	(% style="color:blue" %)//1). Chirpstack ~-~-> Node-red//
115.1	828
	829
176.2	830	[[image:image-20221012184501-1.png\|\|height="608" width="1041"]]
115.1	831
121.2	832
120.1	833	Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file
115.1	834
	835	[[image:image-20221012174220-2.png]]
	836
	837
120.1	838	[[image:image-20221012184655-3.png\|\|height="395" width="1049"]]
	839
	840
121.2	841	Each message is continuously logged to a specified file
115.1	842
	843	[[image:image-20221012174352-3.png]]
	844
	845
138.5	846	(% style="color:blue" %)//2). MQTT Sub//
115.1	847
	848	If you don't want to store the information via node-red, you can get the output via the subscribe command.
	849
	850
	851	If connecting from the same machine, you can use the following command to receive data:
	852
	853	(% class="box infomessage" %)
1.4	854	(((
138.5	855	mosquitto_sub -h localhost -t "application/#" -v
115.1	856	)))
	857
	858
138.5	859	(% style="color:blue" %)Different host
115.1	860
	861	(% class="box infomessage" %)
	862	(((
138.5	863	mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v
115.1	864	)))
	865
176.2	866	[[image:image-20221012173639-1.png\|\|height="273" width="1206"]]
115.1	867
176.2	868
200.1	869	= 11. How to use Chirpstack API to batch register Sensor Node/Gateway in Chistapstack Server =
184.1	870
	871	The following example is based on the built-in ChirpStack server for LPS8V2
	872
189.1	873	[[image:image-20231201174640-1.png\|\|height="584" width="1148"]]
184.1	874
115.1	875
200.1	876	== 11.1 Generate API Tokens ==
115.1	877
204.1	878	Access the built-in chirpstack , click "API Key" and "Add API Key".
189.1	879
	880	[[image:image-20231201175118-2.png\|\|height="597" width="1156"]]
	881
204.1	882	Save the generated API Tokens
189.1	883
	884	[[image:image-20231201175648-3.png\|\|height="596" width="1155"]]
	885
200.1	886	[[image:image-20231204104802-1.png]]
189.1	887
200.1	888
	889	== 11.2 Template file ==
	890
	891
	892	Click on "Template File Download", the user will download a register.csv template file,
	893
	894	[[image:image-20231204105201-2.png]]
	895
	896
	897	Before registering in batches, the user needs to add an Application and Device profile, If you have already added them, you do not need to add them again，
	898
204.1	899	Open the corresponding Application and Device profile and copy their IDs
200.1	900
	901	[[image:image-20231204110902-5.png\|\|height="618" width="1197"]]
	902
	903	[[image:image-20231204111116-7.png\|\|height="619" width="1199"]]
	904
	905	[[image:image-20231204111834-9.png\|\|height="273" width="1205"]]
	906
	907	[[image:image-20231204112107-10.png\|\|height="621" width="1203"]]
	908
	909
	910
204.1	911	== 11.3 Batch Register ==
	912
	913	[[image:image-20231204113136-11.png\|\|height="362" width="1062"]]
	914
	915
	916	Check whether the batch registration is successful
	917
	918	[[image:image-20231204113212-12.png]]
	919
	920	[[image:image-20231204113237-13.png\|\|height="558" width="1081"]]
	921
	922
	923
189.1	924	= 12. Example: Use Local Server ChirpStack and Node-Red in LPS8v2 =
	925
	926
151.1	927	LPS8v2 includes a local ChirpStack Server and Node-Red. This example shows how to configure LHT65N to use with the local Node-Red server. This example assumes users already have:
115.1	928
141.1	929	* LHT65N register on LPS8v2 Built-In ChirpStack server already
	930	* The user is able to see the data on the built-in ChirpStack server device page.
115.1	931
141.1	932	Below are the steps to plot the sensor data on LPS8v2 Node-Red.
	933
147.2	934
189.1	935	== 12.1 Link Node-Red to Local ChirpStack ==
141.1	936
147.2	937
145.1	938	Users can download the Node-Red decoder from this link and import it into the Node-Red platform: [[attach:LHT65N-ChirpStack-node-red.json\|\|target="_blank"]]
141.1	939
	940	For more information on importing Input Flow, check out this link: [[Import Input Flow for Dragino Sensors>>url:http://wiki.dragino.com/xwiki/bin/view/Main/Node-RED/#H3.A0ImportInputFlowforDraginoSensors]]
	941
	942	After importing the Input Flow is complete, the user needs to edit the MQTT in the node
	943
	944
145.1	945	(% style="color:blue" %)1. Change the Topic
	946
141.1	947	Topic modifies it to the following format:
	948
145.1	949	application/(% style="color:red" %)Application ID(%%)/device/(% style="color:red" %)End device ID(%%)/event/up
141.1	950
152.1	951	Reference link: [[Node-RED integration >>https://www.chirpstack.io/docs/guides/node-red-integration.html]]
	952
145.1	953	[[image:image-20230527143923-1.png\|\|height="588" width="1132"]]
141.1	954
	955
145.1	956
	957	(% style="color:blue" %)2. Enter the MQTT configuration information
	958
	959	[[image:image-20230527144206-2.png\|\|height="590" width="1136"]]
	960
	961
176.2	962	(% style="color:blue" %)3. Finally, click "Update" and Deploy
147.1	963
	964	"Connected" indicates that the Link Node-red to Local Chirpstack is normal.
	965
	966	[[image:http://wiki.dragino.com/xwiki/bin/download/Main/Notes%20for%20TTN/WebHome/image-20220914140918-5.png?width=1121&height=602&rev=1.1\|\|alt="image-20220914140918-5.png"]]
	967
	968
189.1	969	== 12.2 Check result. ==
147.1	970
147.2	971
147.1	972	Users can check logs by adding debug.
	973
	974	Browser access: Node-Red-Server-Address:1880/ui
	975
	976	[[image:image-20230529150923-1.png\|\|height="424" width="1118"]]
	977
147.2	978
189.1	979	= 13. Trouble Shooting =
141.1	980
189.1	981	== 13.1 MIC Mismatch or MIC Failed ==
141.1	982
	983
115.1	984	(((
1.2	985	When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
1.4	986	)))
1.2	987
1.4	988	(((
1.2	989	Under normal circumstances, users need to change the APPKEY to solve this problem.
131.2	990
169.1	991
189.1	992	== 13.2 The node is very close to the gateway, but the signal is poor ==
169.1	993
176.2	994
169.1	995	If you are using US915 or AU915, you found the frequency points of different subband ranges in your uplink
	996
	997	Like that：Both 905.1Mhz and 902.3Mhz appear on uplink
	998	But they belong to Subband1 and Subband2 of US915 respectively
	999
	1000	Cause: The server and the gateway use different frequency bands (the server uses Subband1, and the gateway uses Subband2)
	1001
	1002	In server side, it shows the frequency is 905.1Mhz, which is sub-band2. But the RSSI is very low, Because this is not a signal in 905.1Mhz, it is on 902.3Mhz, the signal is too strong and appear a noise in 905.1Mhz.
	1003
	1004	How to check the frequency band used by the server：
	1005
	1006	You can view the information sent by the server: ch_mask in Unconfirmdedatadown
	1007
	1008	[[image:image-20230821113255-1.png]]
	1009
	1010	According to lorawan's protocol, your first ch_mask is 7 for ChMaskCntl = 7 then 125 kHz channels are disabled. Simultaneously the channels 64 to 71 are set according to the ChMask bit mask.
	1011
170.1	1012	[[image:image-20230821113539-2.png]]
169.1	1013
	1014	In the second message, the channel 0~~7 is true, which means that your server is using subband2.
	1015
170.1	1016	[[image:image-20230821113618-3.png]]
169.1	1017
176.2	1018	Note: lorawan's protocol link——[[LoRaWAN® Regional Parameters v1.0.3revA (lora-alliance.org)>>url:https://resources.lora-alliance.org/document/lorawan-regional-parameters-v1-0-3reva]]
	1019
210.1	1020
216.1	1021	== 13.3 ChirpStackv4 node device displays "UPLINK_F_CNT_RETRANSMISSION" ==
210.1	1022
	1023
216.1	1024	This is because the node's packets are retransmitted, and the Fcnt of these packets is the same.
210.1	1025
216.1	1026	The user can Disable frame-counter validation on the chirpstack node and this warning message will not appear in the logs.
210.1	1027
216.1	1028
218.1	1029	The packet is retransmitted because the node device has enabled the acknowledgment uplink packet mode and the node cannot receive the ACK acknowledgment packet delivered by the gateway.
216.1	1030
	1031
218.1	1032	The possible reasons are:
	1033
	1034	~1. The signal of the node device and the gateway is not good
	1035
	1036	2. Too many node devices affect the downlink of the gateway
	1037
	1038
	1039	[[image:image-20240717085339-1.jpeg]]
	1040
	1041
	1042	* Disable frame-counter validation
	1043
	1044	[[image:image-20240717102613-5.png\|\|height="803" width="1211"]]
	1045
	1046
	1047	* Result
	1048
216.1	1049	[[image:image-20240717092428-4.jpeg]]
	1050
218.1	1051
216.1	1052	== 13.4 How to get the log information of the node？ ==
	1053
	1054
210.1	1055	~1. Get information about a single node.
	1056
	1057	* Download this file in the node's live data interface.
	1058
	1059	[[image:image-20240117173123-1.png\|\|height="526" width="1086"]]
	1060
	1061	* The LoRaWAN frames download gateway receives real-time data from the current node.
	1062
	1063	[[image:image-20240117174452-2.png\|\|height="525" width="1081"]]
	1064
	1065
	1066	2. Get information about the entire Gateway.
	1067
	1068	* Click to select the online gateway of the current node.
	1069
	1070	[[image:image-20240117175058-4.png\|\|height="532" width="1077"]]
	1071
	1072
	1073	* Download this file on the LoRaWAN frames interface.
	1074
	1075	[[image:image-20240117175009-3.png\|\|height="524" width="1076"]]
	1076
	1077
	1078
	1079	After the data collection is completed, you can send this file directly to our technical support personnel for analysis.
	1080
	1081
	1082	You can also use the packet analysis tool developed by our company to check it yourself. Please refer to the following [[link>>http://wiki.dragino.com/xwiki/bin/view/Main/User%20Manual%20of%20Dragino%20LoRaWAN%20Packet%20Analyze%20Tool/#H4.Chirpstack]] to use this tool.
	1083
	1084	[[image:image-20240117175738-5.png]]
	1085
216.1	1086	(% class="wikigeneratedid" id="H" %)
	1087
1.4	1088	)))

Wiki source code of Notes for ChirpStack

Applications

Navigation