Wiki source code of Notes for ChirpStack

Version 210.1 by Mengting Qiu on 2024/01/17 17:58

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
164.1	48	[[image:image-20230702094608-1.png\|\|height="537" width="1015"]]
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" %)How to set up chirpStack Gateway-bridge
	270
138.1	271	Users can check out the ChirpStack gateway-bridge v3 [[link>>https://www.chirpstack.io/gateway-bridge/gateway/dragino/]]
128.1	272
	273
	274	(% style="color:blue" %)What do you need to prepare
	275
	276	A gateway that can access the internet normally
	277
1.2	278
138.1	279	The following example does not have configuration certificates:
	280
138.2	281
176.1	282	== 6.1 Configure Packet Forwarder ==
131.2	283
	284
124.1	285	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	286
138.3	287	* In the (% style="color:blue" %)LoRaWAN (%%)menu, click on (% style="color:blue" %)LoRaWAN ~-~- Semtech UDP
138.2	288
124.1	289	* Make sure the following settings are set:
138.4	290	Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
	291	LoRaWAN Server Address:** //localhost or 127.0.0.1//
	292	Server port for upstream:** //1700//
	293	Server port for downstream:** //1700//
138.2	294
138.3	295	Click (% style="color:blue" %)Save & Apply.
124.1	296
	297	[[image:image-20221222114220-2.png\|\|height="748" width="931"]]
	298
	299
176.1	300	== 6.2 Configuring gateway frequency ==
124.1	301
127.1	302
131.2	303	(% style="color:red" %)Note: Gateway frequencies must match
	304
127.1	305	[[image:image-20221222134830-3.png\|\|height="408" width="923"]]
	306
	307
176.1	308	== 6.3 Generate and modify the gateway-bridge configuration file ==
127.1	309
	310
138.1	311	1）Generate the gateway-bridge configuration file
	312
	313	By default, the configuration file is not up-to-date,so the user needs to rebuild the gateway-bridge configuration file.
	314
	315	Users need to access the command line of the gateway through SSH,Then type the following command:
	316
	317	(% class="box infomessage" %)
	318	(((
138.5	319	/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge configfile > /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
138.1	320	)))
	321
	322
	323	2）modify the gateway-bridge configuration file
	324
	325	The user needs to modify the server address in line 252 in the configuration file
	326
	327	(% class="box infomessage" %)
	328	(((
138.5	329	vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
138.1	330	)))
	331
	332	[[image:image-20230415165254-1.png\|\|height="583" width="956"]]
	333
	334
176.1	335	== 6.4 Debug ==
138.1	336
	337
	338	After the above configuration is completed, the user can enter the command to debug the gateway-bridge connection
	339
	340	(% class="box infomessage" %)
	341	(((
138.5	342	/opt/chirpstack-gateway-bridge/chirpstack-gateway-bridge ~-~-config /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
138.1	343	)))
	344
	345	If the gateway-bridge connection is normal, the debug log displays "connected to mqtt broker".
	346
	347	[[image:image-20230415170404-2.png]]
	348
	349
	350	If the debug log shows "connection error", check that the server port or server is correct
	351
	352	[[image:image-20230415170854-3.png]]
	353
	354
	355	More information can be found on the [[ChirpStack website>>https://www.chirpstack.io/docs/]]or [[Forum>>url:https://forum.chirpstack.io/]]
	356
	357
176.1	358	== 6.5 (Re)start and stop gateway-bridge ==
138.1	359
	360
	361	Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
	362
	363	(% class="box infomessage" %)
	364	(((
	365	# start
	366
	367	/etc/init.d/chirpstack-gateway-bridge start
	368
	369	# stop
	370
	371	/etc/init.d/chirpstack-gateway-bridge stop
	372
	373	# restart
	374
	375	/etc/init.d/chirpstack-gateway-bridge restart
	376	)))
	377
	378
176.1	379	= 7. How the gateway connects to Chirpstack v4 via gateway-bridge =
138.1	380
	381
	382	(% style="color:blue" %)Below list the support products and Requirements:
	383
	384	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]]
	385	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/]]
	386
	387	(% style="color:blue" %)How to set up chirpStack Gateway-bridge
	388
	389	Users can check out the ChirpStack gateway-bridge v4 [[link>>https://www.chirpstack.io/docs/chirpstack-gateway-bridge/install/dragino.html]]
	390
	391
	392	(% style="color:blue" %)What do you need to prepare
	393
	394	A gateway that can access the internet normally
	395
	396
176.1	397	== 7.1 Configure Packet Forwarder ==
138.1	398
	399
	400	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
	401
138.5	402	* In the (% style="color:blue" %)LoRaWAN(%%) menu, click on (% style="color:blue" %)LoRaWAN ~-~- Semtech UDP
	403
138.1	404	* Make sure the following settings are set:
	405	Service Provider:** //~-~-Custom/Private LoRaWAN~-~-//
	406	LoRaWAN Server Address:** //localhost or 127.0.0.1//
	407	Server port for upstream:** //1700//
	408	Server port for downstream:** //1700//
	409
138.5	410	Click (% style="color:blue" %)Save & Apply.
138.1	411
	412	[[image:image-20221222114220-2.png\|\|height="748" width="931"]]
	413
	414
176.1	415	== 7.2 Configuring gateway frequency ==
138.1	416
	417
	418	(% style="color:red" %)Note: Gateway frequencies must match
	419
	420	[[image:image-20221222134830-3.png\|\|height="408" width="923"]]
	421
	422
176.1	423	== 7.3 Modify the gateway-bridge configuration file ==
138.1	424
	425
127.1	426	Run the gateway command line command to modify the gateway-bridge configuration file:
	427
	428	(% class="box infomessage" %)
	429	(((
138.5	430	root@dragino-1d27d4:~~# vim /etc/chirpstack-gateway-bridge/chirpstack-gateway-bridge.toml
127.1	431	)))
	432
124.1	433	[[image:image-20221222113302-1.png]]
	434
131.2	435
127.1	436	[[image:image-20221222140203-4.png\|\|height="875" width="806"]]
	437
176.2	438
133.1	439	[[image:image-20221230094246-1.png\|\|height="768" width="783"]]
127.1	440
	441	(% class="wikigeneratedid" id="H" %)
	442	After the modification, run the following command: /etc/init.d/chirpstack-gateway-bridge restart
	443
	444
176.1	445	== 7.4 (Re)start and stop gateway-bridge ==
131.2	446
	447
127.1	448	Use the following commands to (re)start and stop the ChirpStack Gateway Bridge Service:
	449
	450	(% class="box infomessage" %)
	451	(((
	452	# start
	453
	454	/etc/init.d/chirpstack-gateway-bridge start
	455
	456	# stop
	457
	458	/etc/init.d/chirpstack-gateway-bridge stop
	459
	460	# restart
	461
	462	/etc/init.d/chirpstack-gateway-bridge restart
	463	)))
	464
131.1	465
176.1	466	== 7.5 Successful Connection ==
131.1	467
131.2	468
131.1	469	[[image:image-20221222141754-5.png\|\|height="488" width="1150"]]
	470
131.2	471
131.1	472	[[image:image-20221222141830-6.png\|\|height="582" width="1153"]]
	473
131.2	474
176.1	475	= 8. Downlink =
124.1	476
183.1	477
177.2	478	=== 8.1 Chirpstack Downlink Note ===
124.1	479
	480
184.1	481	==== Select HEX format for downlink ====
108.9	482
183.1	483
177.2	484	(% 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	485
	486
183.1	487	[[image:image-20231108171112-5.png\|\|height="629" width="1117"]]
111.1	488
	489
183.1	490	[[image:image-20231108171145-6.png\|\|height="497" width="1101"]]
121.2	491
111.1	492
	493
	494
1.2	495
121.2	496	[[image:image-20220531173236-10.png\|\|height="597" width="1215"]]
1.2	497
121.2	498	Check ChripStack downlink DataRate
86.15	499
121.2	500
	501
65.2	502	[[image:image-20220525101326-11.png]]
1.2	503
121.2	504	Make sure the RX2DR is the same in the end node
1.2	505
86.16	506
176.1	507	== 8.3 Loraserver Downlink Note ==
108.9	508
	509
1.2	510	User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
	511
1.5	512	(((
108.9	513	Below is examples:
1.5	514	)))
1.2	515
1.4	516	(% class="box" %)
	517	(((
	518	Connect to your server via MQTT：
	519	MQTT Client ID: Any
	520	Protocol：mqtt/tcp Server IP：loraserver_ip:1883
1.2	521	User name: User name Password: password
1.4	522	)))
1.2	523
97.2	524	[[image:image-20220531173419-11.png]]
1.2	525
1.5	526	(((
121.2	527	MQTT Connect to ChirpStack
86.17	528
108.9	529
86.17	530
1.5	531	)))
1.2	532
1.5	533	(((
108.9	534	After connect
1.5	535	)))
1.2	536
1.4	537	(% class="box" %)
	538	(((
	539	Subscribe : Format：application/ID/device/ Device EUI/rx
1.2	540	Example: application/7/device/00aedb3da649cb23/rx
1.4	541	)))
1.2	542
1.4	543	(% class="box" %)
	544	(((
	545	Publish:
1.2	546	Format: Top: application/ID/device/ Device EUI/tx
	547	Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
	548	Example: Top: application/7/device/00aedb3da649cb23/tx
	549	Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
1.4	550	)))
1.2	551
98.2	552	[[image:image-20220531173519-12.png]]
1.2	553
121.2	554	MQTT Connect to ChirpStack
1.2	555
86.18	556
1.2	557
177.2	558	(((
	559	Downlink payload encode javescript code.
1.2	560
177.2	561	We can run the following Javsscript code on the site:
1.5	562	)))
1.2	563
1.4	564	(% class="box" %)
	565	(((
	566	function sha1_to_base64(sha1)
1.2	567	{
	568	var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
	569	var base64_rep = "";
	570	var cnt = 0;
	571	var bit_arr = 0;
	572	var bit_num = 0;
1.5	573	\\ for(var n = 0; n < sha1.length; ++n)
1.2	574	{
	575	if(sha1[n] >= 'A' && sha1[n] <= 'Z')
	576	{
121.1	577	ascv = sha1.charCodeAt( n ) - 55;
1.2	578	}
	579	else if(sha1[n] >= 'a' && sha1[n] <= 'z')
	580	{
121.1	581	ascv = sha1.charCodeAt( n ) - 87;
1.2	582	}
	583	else
	584	{
121.1	585	ascv = sha1.charCodeAt( n ) - 48;
1.2	586	}
1.5	587	\\ bit_arr = (bit_arr << 4) \| ascv;
1.2	588	bit_num += 4;
	589	if(bit_num >= 6)
	590	{
1.4	591	bit_num -= 6;
1.2	592	base64_rep += digits[bit_arr >>> bit_num];
1.4	593	bit_arr &= ~~(-1 << bit_num);
1.2	594	}
	595	}
1.5	596	\\ if(bit_num > 0)
1.2	597	{
	598	bit_arr <<= 6 - bit_num;
	599	base64_rep += digits[bit_arr];
	600	}
1.5	601	\\ var padding = base64_rep.length % 4;
	602	\\ if(padding > 0)
1.2	603	{
	604	for(var n = 0; n < 4 - padding; ++n)
	605	{
	606	base64_rep += "=";
	607	}
	608	}
	609	return base64_rep;
	610	}
1.5	611	\\console.log(sha1_to_base64("data"));
	612	\\data is downlink payload required by end node.
1.4	613	e.g console.log(sha1_to_base64("030101"));
	614	result: AwEB
1.2	615	AwEB is the 0x030101's base 64 Encode.
1.5	616	\\e.g console.log(sha1_to_base64("030000"));
1.4	617	result: AwAA
	618	AwAA is 0x030000's base 64 Encode.
	619	)))
1.2	620
86.21	621
176.1	622	== 8.4 Add the decode function in Chirpstack for the payload ==
108.9	623
	624
1.2	625	User enters the payload code according to the steps.
	626
150.1	627	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]]
	628
121.2	629	[[image:image-20220531173754-15.png\|\|height="474" width="1334"]]
1.2	630
	631
102.2	632	[[image:image-20220531173856-16.png]]
1.2	633
102.2	634
106.2	635	[[image:image-20220531174120-20.png]]
84.2	636
105.2	637	[[image:image-20220531174046-19.png]]
1.2	638
86.22	639
176.1	640	= 9. Multiply Uplink in ChirpStack =
108.9	641
	642
1.4	643	(((
1.2	644	nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
1.4	645	)))
1.2	646
1.4	647	(((
1.2	648	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	649
	650
1.4	651	)))
1.2	652
121.2	653	[[image:image-20220526091912-7.png\|\|height="241" width="1336"]]
1.2	654
108.9	655
1.5	656	(((
1.2	657	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	658
	659
1.5	660	)))
1.2	661
76.2	662	[[image:image-20220525104359-21.png]]
1.2	663
1.4	664	(((
1.2	665	Above behaviour will cause the platform shows below two cases of error:
108.9	666
	667
1.4	668	)))
1.2	669
1.4	670	(((
1.2	671	Error of duplicate Frame Counter
1.4	672	)))
1.2	673
76.2	674	[[image:image-20220525104437-22.png]]
1.2	675
86.23	676
108.9	677
121.2	678	Duplicate transmission in short time
1.2	679
176.2	680	[[image:image-20220601102430-1.png\|\|height="508" width="1120"]]
1.2	681
86.24	682
176.1	683	== 9.1 Solution ==
108.9	684
	685
1.2	686	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]]
	687
1.5	688	(((
108.11	689	(% 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	690	)))
1.2	691
79.2	692	[[image:image-20220525104532-24.png]]
1.2	693
86.25	694
108.9	695	installation path:
1.2	696
79.2	697	[[image:image-20220525104554-25.png]]
1.2	698
86.25	699
108.9	700
1.5	701	(((
108.11	702	(% style="color:blue" %)2. Environment variable settings:
1.5	703	)))
1.2	704
1.5	705	(((
1.2	706	1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
1.5	707	)))
1.2	708
1.5	709	(((
108.9	710	2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
1.5	711	)))
1.2	712
43.2	713	[[image:image-20220524165433-33.png]]
1.2	714
86.26	715
108.9	716	3) Modify the system variable Path and add C:\Go\bin\:
1.2	717
43.2	718	[[image:image-20220524165452-34.png]]
1.2	719
106.3	720
1.2	721	User variable setting file generation directory: D:\go:
	722
43.2	723	[[image:image-20220524165517-35.png]]
1.2	724
86.27	725
1.2	726
108.11	727	(% 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	728
1.2	729	The name of the plugin: Example ADR plugin:
	730
48.2	731	[[image:image-20220524165540-36.png]]
1.2	732
	733	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.
	734
48.2	735	[[image:image-20220524165557-37.png]]
1.2	736
86.28	737
1.2	738
108.11	739	(% style="color:blue" %)4. Compile the ADR configuration file and generate the exe file.
108.9	740
1.2	741	1) Create a folder named adr-setting
	742
	743	2) Open the adr-setting folder
	744
	745	3) Put adr.setting.go in this folder.
	746
	747	4) Open the computer cmd and run the following commands in sequencecd adr-setting
	748
	749	go mod init adr-setting
	750
	751	go get github.com/brocaar/chirpstack-network-server/v3/adr
	752
	753	go get github.com/hashicorp/go-plugin
	754
	755	go get adr-setting
	756
	757	go build
	758
	759	5) Finally generate this file：
	760
48.2	761	[[image:image-20220524165623-38.png]]
1.2	762
86.29	763
1.2	764
108.11	765	(% style="color:blue" %)5. Add the plugin and run the plugin.
108.9	766
1.5	767	(((
1.2	768	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	769	)))
1.2	770
48.2	771	[[image:image-20220524165641-39.png]]
1.2	772
1.4	773	(((
1.5	774	(((
1.2	775	For example: adr_plugins=[“adr-setting”]
1.4	776	)))
1.5	777	)))
1.2	778
1.4	779	* (((
1.5	780	(((
1.4	781	Adding a single plugin format is adr_plugins=["filename"]
	782	)))
1.5	783	)))
1.2	784
1.4	785	* (((
1.5	786	(((
1.4	787	Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
	788	)))
1.5	789	)))
1.2	790
1.4	791	(((
1.5	792	(((
1.2	793	Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
1.4	794	)))
1.5	795	)))
1.2	796
79.2	797	[[image:image-20220525104647-26.png]]
1.2	798
	799	Finish.
	800
86.30	801
176.1	802	= 10. How to store/get all data traffic for a specific sensor, including raw payload, and uplink/ downlink history. =
108.9	803
1.2	804
115.1	805	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	806
115.1	807	This example will be shown how to store/get all the data in two ways:
108.9	808
138.5	809	(% style="color:blue" %)//1). Chirpstack ~-~-> Node-red//
115.1	810
	811
176.2	812	[[image:image-20221012184501-1.png\|\|height="608" width="1041"]]
115.1	813
121.2	814
120.1	815	Use MQTT in Nore-red to subscribe to topics published by the chirpstack-application and then continuously write to a file
115.1	816
	817	[[image:image-20221012174220-2.png]]
	818
	819
120.1	820	[[image:image-20221012184655-3.png\|\|height="395" width="1049"]]
	821
	822
121.2	823	Each message is continuously logged to a specified file
115.1	824
	825	[[image:image-20221012174352-3.png]]
	826
	827
138.5	828	(% style="color:blue" %)//2). MQTT Sub//
115.1	829
	830	If you don't want to store the information via node-red, you can get the output via the subscribe command.
	831
	832
	833	If connecting from the same machine, you can use the following command to receive data:
	834
	835	(% class="box infomessage" %)
1.4	836	(((
138.5	837	mosquitto_sub -h localhost -t "application/#" -v
115.1	838	)))
	839
	840
138.5	841	(% style="color:blue" %)Different host
115.1	842
	843	(% class="box infomessage" %)
	844	(((
138.5	845	mosquitto_sub -h IPADDRESS -p 8883 ~-~-insecure ~-~-cafile ca.pem ~-~-cert cert.pem ~-~-key key.pem -t "application/#" -v
115.1	846	)))
	847
176.2	848	[[image:image-20221012173639-1.png\|\|height="273" width="1206"]]
115.1	849
176.2	850
200.1	851	= 11. How to use Chirpstack API to batch register Sensor Node/Gateway in Chistapstack Server =
184.1	852
	853	The following example is based on the built-in ChirpStack server for LPS8V2
	854
189.1	855	[[image:image-20231201174640-1.png\|\|height="584" width="1148"]]
184.1	856
115.1	857
200.1	858	== 11.1 Generate API Tokens ==
115.1	859
204.1	860	Access the built-in chirpstack , click "API Key" and "Add API Key".
189.1	861
	862	[[image:image-20231201175118-2.png\|\|height="597" width="1156"]]
	863
204.1	864	Save the generated API Tokens
189.1	865
	866	[[image:image-20231201175648-3.png\|\|height="596" width="1155"]]
	867
200.1	868	[[image:image-20231204104802-1.png]]
189.1	869
200.1	870
	871	== 11.2 Template file ==
	872
	873
	874	Click on "Template File Download", the user will download a register.csv template file,
	875
	876	[[image:image-20231204105201-2.png]]
	877
	878
	879	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，
	880
204.1	881	Open the corresponding Application and Device profile and copy their IDs
200.1	882
	883	[[image:image-20231204110902-5.png\|\|height="618" width="1197"]]
	884
	885	[[image:image-20231204111116-7.png\|\|height="619" width="1199"]]
	886
	887	[[image:image-20231204111834-9.png\|\|height="273" width="1205"]]
	888
	889	[[image:image-20231204112107-10.png\|\|height="621" width="1203"]]
	890
	891
	892
204.1	893	== 11.3 Batch Register ==
	894
	895	[[image:image-20231204113136-11.png\|\|height="362" width="1062"]]
	896
	897
	898	Check whether the batch registration is successful
	899
	900	[[image:image-20231204113212-12.png]]
	901
	902	[[image:image-20231204113237-13.png\|\|height="558" width="1081"]]
	903
	904
	905
189.1	906	= 12. Example: Use Local Server ChirpStack and Node-Red in LPS8v2 =
	907
	908
151.1	909	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	910
141.1	911	* LHT65N register on LPS8v2 Built-In ChirpStack server already
	912	* The user is able to see the data on the built-in ChirpStack server device page.
115.1	913
141.1	914	Below are the steps to plot the sensor data on LPS8v2 Node-Red.
	915
147.2	916
189.1	917	== 12.1 Link Node-Red to Local ChirpStack ==
141.1	918
147.2	919
145.1	920	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	921
	922	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]]
	923
	924	After importing the Input Flow is complete, the user needs to edit the MQTT in the node
	925
	926
145.1	927	(% style="color:blue" %)1. Change the Topic
	928
141.1	929	Topic modifies it to the following format:
	930
145.1	931	application/(% style="color:red" %)Application ID(%%)/device/(% style="color:red" %)End device ID(%%)/event/up
141.1	932
152.1	933	Reference link: [[Node-RED integration >>https://www.chirpstack.io/docs/guides/node-red-integration.html]]
	934
145.1	935	[[image:image-20230527143923-1.png\|\|height="588" width="1132"]]
141.1	936
	937
145.1	938
	939	(% style="color:blue" %)2. Enter the MQTT configuration information
	940
	941	[[image:image-20230527144206-2.png\|\|height="590" width="1136"]]
	942
	943
176.2	944	(% style="color:blue" %)3. Finally, click "Update" and Deploy
147.1	945
	946	"Connected" indicates that the Link Node-red to Local Chirpstack is normal.
	947
	948	[[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"]]
	949
	950
189.1	951	== 12.2 Check result. ==
147.1	952
147.2	953
147.1	954	Users can check logs by adding debug.
	955
	956	Browser access: Node-Red-Server-Address:1880/ui
	957
	958	[[image:image-20230529150923-1.png\|\|height="424" width="1118"]]
	959
147.2	960
189.1	961	= 13. Trouble Shooting =
141.1	962
189.1	963	== 13.1 MIC Mismatch or MIC Failed ==
141.1	964
	965
115.1	966	(((
1.2	967	When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
1.4	968	)))
1.2	969
1.4	970	(((
1.2	971	Under normal circumstances, users need to change the APPKEY to solve this problem.
131.2	972
169.1	973
189.1	974	== 13.2 The node is very close to the gateway, but the signal is poor ==
169.1	975
176.2	976
169.1	977	If you are using US915 or AU915, you found the frequency points of different subband ranges in your uplink
	978
	979	Like that：Both 905.1Mhz and 902.3Mhz appear on uplink
	980	But they belong to Subband1 and Subband2 of US915 respectively
	981
	982	Cause: The server and the gateway use different frequency bands (the server uses Subband1, and the gateway uses Subband2)
	983
	984	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.
	985
	986	How to check the frequency band used by the server：
	987
	988	You can view the information sent by the server: ch_mask in Unconfirmdedatadown
	989
	990	[[image:image-20230821113255-1.png]]
	991
	992	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.
	993
170.1	994	[[image:image-20230821113539-2.png]]
169.1	995
	996	In the second message, the channel 0~~7 is true, which means that your server is using subband2.
	997
170.1	998	[[image:image-20230821113618-3.png]]
169.1	999
176.2	1000	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]]
	1001
210.1	1002
	1003
	1004
	1005	== 13.3 How to get the log information of the node？ ==
	1006
	1007
	1008	~1. Get information about a single node.
	1009
	1010	* Download this file in the node's live data interface.
	1011
	1012	[[image:image-20240117173123-1.png\|\|height="526" width="1086"]]
	1013
	1014	* The LoRaWAN frames download gateway receives real-time data from the current node.
	1015
	1016	[[image:image-20240117174452-2.png\|\|height="525" width="1081"]]
	1017
	1018
	1019	2. Get information about the entire Gateway.
	1020
	1021	* Click to select the online gateway of the current node.
	1022
	1023	[[image:image-20240117175058-4.png\|\|height="532" width="1077"]]
	1024
	1025
	1026	* Download this file on the LoRaWAN frames interface.
	1027
	1028	[[image:image-20240117175009-3.png\|\|height="524" width="1076"]]
	1029
	1030
	1031
	1032	After the data collection is completed, you can send this file directly to our technical support personnel for analysis.
	1033
	1034
	1035	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.
	1036
	1037	[[image:image-20240117175738-5.png]]
	1038
	1039	== ==
1.4	1040	)))

Wiki source code of Notes for ChirpStack

Applications

Navigation