Wiki source code of Notes for ChirpStack

Version 108.9 by Xiaoling on 2022/07/23 14:21

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
54.2	23	[[image:image-20220525100058-1.png]]
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
86.5	40
	41
108.4	42	= 2. Semtech UDP =
1.1	43
108.4	44	== 2.1 Step 1. Add the Network-servers ==
1.1	45
108.4	46
1.2	47	The network-Servers address varies depending on the ChirpStack server setup environment
1.1	48
1.3	49	(% class="box" %)
	50	(((
108.5	51	Windows ~-~-> Network-server server * : localhost:8000
	52	Linux ~-~-> Network-server server * : chirpstack-network-server:8000
1.3	53	)))
1.1	54
108.4	55
108.6	56	(% style="color:red" %)If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.
1.1	57
108.4	58
87.2	59	[[image:image-20220531171609-1.png]]
1.2	60
	61	Add the Network-servers
	62
84.2	63
108.4	64
108.6	65	== 2.2 Step 2. Create Gateway-profiles ==
1.2	66
108.6	67
88.2	68	[[image:image-20220531171651-2.png]]
1.2	69
	70	Create Gateway-profiles
	71
84.2	72
1.2	73
108.6	74	== 2.3 Step 3. Create Service-profiles ==
	75
	76
89.2	77	[[image:image-20220531171809-3.png]]
1.2	78
	79	Create Service-profiles
	80
89.3	81
1.2	82	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.
	83
1.4	84	(% style="color:red" %)Note : Before add the gateway, the user needs to complete the preceding three steps.
1.2	85
84.2	86	If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %)
1.2	87
84.2	88
108.6	89
108.7	90	== 2.4 Step 4. Add the gateway ==
1.2	91
108.7	92
1.2	93	The example gateway id is: a840411e96744150
	94
1.5	95	(((
1.4	96	(% style="color:red" %)Note : The Gateway EUI and server addresses must match the ChirpStack configuration.
108.7	97
	98
1.5	99	)))
1.2	100
90.2	101	[[image:image-20220531171923-4.png]](% style="display:none" %)
1.2	102
	103	Add the gateway
	104
108.7	105
	106
91.2	107	[[image:image-20220531172031-5.png]]
1.2	108
	109	Configure the gateway
	110
84.2	111
1.2	112
108.8	113	== 2.5 Step 5. Checking gateway Status ==
	114
	115
92.2	116	[[image:image-20220531172158-6.png]](% style="display:none" %)
1.2	117
84.2	118
108.8	119
1.2	120	gateway Status
	121
93.2	122	[[image:image-20220531172304-7.png]]
1.2	123
	124	gateway Status
	125
86.6	126
108.8	127
108.9	128	= 3. Gateway Registration for Basics Station =
1.2	129
108.8	130
108.9	131	== 3.1 Introduction ==
9.1	132
108.8	133
9.1	134	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.
	135
	136	ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
	137
	138
108.8	139	(% style="color:blue" %)Below list the support products and Requirements:
	140
9.1	141	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]]
	142	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/]]
	143
	144
108.8	145	(% style="color:blue" %)How to set up chirpStack Basic Station
	146
9.1	147	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]]
	148
	149
108.8	150	(% style="color:blue" %)What do you need to prepare
	151
9.1	152	A gateway that can access the internet normally
	153
86.7	154
108.8	155
108.9	156	== 3.2 Add Gateway ==
9.1	157
108.9	158
20.2	159	[[image:image-20220524164205-10.png]]
9.1	160
86.8	161
108.9	162	== 3.3 Access the gateway GUI ==
9.1	163
108.9	164
9.1	165	Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
	166
20.2	167	[[image:image-20220524164319-11.png]]
9.1	168
108.9	169
9.1	170	User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
	171
	172	(% class="box" %)
	173	(((
	174	Service Provider ~-~-> Choose the ChirpStack/Senet ~-~- Basic Station
	175
	176	LNS URI ~-~-> Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
	177
	178	LNS TLS trust ~-~-> Upload the TLS Certificate
	179	)))
	180
	181	(% class="wikigeneratedid" %)
20.2	182	[[image:image-20220524164341-12.png]]
9.1	183
86.9	184
108.9	185	== 3.4 Start Station ==
9.1	186
108.9	187
9.1	188	When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack
	189
86.10	190
108.9	191	== 3.5 Successful Connection ==
9.1	192
108.9	193
9.1	194	If user completes the above steps, which will see live date in the ChirpStack.
	195
23.2	196	[[image:image-20220524164448-13.png]]
9.1	197
86.11	198
9.1	199
108.9	200	== 3.6 Trouble Shooting ==
	201
	202
9.1	203	User can check the station log in the logread/system log page.
	204
95.2	205	[[image:image-20220531172837-8.png]]
9.1	206
86.13	207
9.1	208	and recode the station log in the system/Recode log page.
	209
95.2	210	[[image:image-20220531172857-9.png]]
9.1	211
86.12	212
108.9	213
1.2	214	= 4. Downlink =
	215
	216	== 4.1 Chirpstack Downlink Note ==
	217
108.9	218
108.2	219	[[image:image-20220601102543-2.png]]
1.2	220
	221	Convert the data to Base64
	222
86.14	223
96.2	224	[[image:image-20220531173236-10.png]]
1.2	225
	226	Check ChripStack downlink DataRate
	227
86.15	228
65.2	229	[[image:image-20220525101326-11.png]]
1.2	230
	231	Make sure the RX2DR is the same in the end node
	232
86.16	233
1.2	234
108.9	235	== 4.2 Loraserver Downlink Note ==
	236
	237
1.2	238	User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
	239
1.5	240	(((
108.9	241	Below is examples:
1.5	242	)))
1.2	243
1.4	244	(% class="box" %)
	245	(((
	246	Connect to your server via MQTT：
	247	MQTT Client ID: Any
	248	Protocol：mqtt/tcp Server IP：loraserver_ip:1883
1.2	249	User name: User name Password: password
1.4	250	)))
1.2	251
97.2	252	[[image:image-20220531173419-11.png]]
1.2	253
1.5	254	(((
1.2	255	MQTT Connect to ChirpStack
86.17	256
108.9	257
86.17	258
1.5	259	)))
1.2	260
1.5	261	(((
108.9	262	After connect
1.5	263	)))
1.2	264
1.4	265	(% class="box" %)
	266	(((
	267	Subscribe : Format：application/ID/device/ Device EUI/rx
1.2	268	Example: application/7/device/00aedb3da649cb23/rx
1.4	269	)))
1.2	270
1.4	271	(% class="box" %)
	272	(((
	273	Publish:
1.2	274	Format: Top: application/ID/device/ Device EUI/tx
	275	Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
	276	Example: Top: application/7/device/00aedb3da649cb23/tx
	277	Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
1.4	278	)))
1.2	279
98.2	280	[[image:image-20220531173519-12.png]]
1.2	281
	282	MQTT Connect to ChirpStack
	283
86.18	284
1.4	285	(((
108.9	286	(% style="color:red" %)Note: Chirpstack use base64 to downlink, so need to convert the downlink payload from HEX to base64 [[https:~~/~~/base64.us/>>url:https://base64.us/]]
1.4	287	)))
1.2	288
99.2	289	[[image:image-20220531173601-13.png]]
1.2	290
	291	Choose to Use Hex for Encode
	292
86.19	293
108.9	294
1.2	295	If we want send downstream hex 030101 to end node, the BASE64 payload is AwEB
	296
100.2	297	[[image:image-20220531173658-14.png]]
1.2	298
108.9	299
1.5	300	(((
1.2	301	Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
1.5	302	)))
1.2	303
1.4	304	(% class="box" %)
	305	(((
	306	function sha1_to_base64(sha1)
1.2	307	{
	308	var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
	309	var base64_rep = "";
	310	var cnt = 0;
	311	var bit_arr = 0;
	312	var bit_num = 0;
1.5	313	\\ for(var n = 0; n < sha1.length; ++n)
1.2	314	{
	315	if(sha1[n] >= 'A' && sha1[n] <= 'Z')
	316	{
	317	ascv = sha1.charCodeAt(n) - 55;
	318	}
	319	else if(sha1[n] >= 'a' && sha1[n] <= 'z')
	320	{
	321	ascv = sha1.charCodeAt(n) - 87;
	322	}
	323	else
	324	{
	325	ascv = sha1.charCodeAt(n) - 48;
	326	}
1.5	327	\\ bit_arr = (bit_arr << 4) \| ascv;
1.2	328	bit_num += 4;
	329	if(bit_num >= 6)
	330	{
1.4	331	bit_num -= 6;
1.2	332	base64_rep += digits[bit_arr >>> bit_num];
1.4	333	bit_arr &= ~~(-1 << bit_num);
1.2	334	}
	335	}
1.5	336	\\ if(bit_num > 0)
1.2	337	{
	338	bit_arr <<= 6 - bit_num;
	339	base64_rep += digits[bit_arr];
	340	}
1.5	341	\\ var padding = base64_rep.length % 4;
	342	\\ if(padding > 0)
1.2	343	{
	344	for(var n = 0; n < 4 - padding; ++n)
	345	{
	346	base64_rep += "=";
	347	}
	348	}
	349	return base64_rep;
	350	}
1.5	351	\\console.log(sha1_to_base64("data"));
	352	\\data is downlink payload required by end node.
1.4	353	e.g console.log(sha1_to_base64("030101"));
	354	result: AwEB
1.2	355	AwEB is the 0x030101's base 64 Encode.
1.5	356	\\e.g console.log(sha1_to_base64("030000"));
1.4	357	result: AwAA
	358	AwAA is 0x030000's base 64 Encode.
	359	)))
1.2	360
86.21	361
1.2	362
108.9	363	== 4.3 Add the decode function in Chirpstack for the payload ==
	364
	365
1.2	366	User enters the payload code according to the steps.
	367
101.2	368	[[image:image-20220531173754-15.png]]
1.2	369
	370
102.2	371	[[image:image-20220531173856-16.png]]
1.2	372
102.2	373
106.2	374	[[image:image-20220531174120-20.png]]
84.2	375
105.2	376	[[image:image-20220531174046-19.png]]
1.2	377
86.22	378
1.2	379
108.9	380	= 5. Multiply Uplink in ChirpStack =
	381
	382
1.4	383	(((
1.2	384	nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
1.4	385	)))
1.2	386
1.4	387	(((
1.2	388	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	389
	390
1.4	391	)))
1.2	392
86.2	393	[[image:image-20220526091912-7.png]]
1.2	394
108.9	395
1.5	396	(((
1.2	397	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	398
	399
1.5	400	)))
1.2	401
76.2	402	[[image:image-20220525104359-21.png]]
1.2	403
1.4	404	(((
1.2	405	Above behaviour will cause the platform shows below two cases of error:
108.9	406
	407
1.4	408	)))
1.2	409
1.4	410	(((
1.2	411	Error of duplicate Frame Counter
1.4	412	)))
1.2	413
76.2	414	[[image:image-20220525104437-22.png]]
1.2	415
86.23	416
108.9	417
1.2	418	Duplicate transmission in short time
	419
107.2	420	[[image:image-20220601102430-1.png]]
1.2	421
86.24	422
1.2	423
108.9	424	== 5.1 Solution ==
	425
	426
1.2	427	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]]
	428
108.9	429
1.5	430	(((
108.9	431	(% 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.
	432
	433
1.5	434	)))
1.2	435
79.2	436	[[image:image-20220525104532-24.png]]
1.2	437
86.25	438
108.9	439	installation path:
1.2	440
79.2	441	[[image:image-20220525104554-25.png]]
1.2	442
86.25	443
108.9	444
1.5	445	(((
108.9	446	(% style="color:blue" %)2. Environment variable settings:
1.5	447	)))
1.2	448
1.5	449	(((
1.2	450	1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
1.5	451	)))
1.2	452
1.5	453	(((
108.9	454	2) Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
1.5	455	)))
1.2	456
43.2	457	[[image:image-20220524165433-33.png]]
1.2	458
86.26	459
108.9	460	3) Modify the system variable Path and add C:\Go\bin\:
1.2	461
43.2	462	[[image:image-20220524165452-34.png]]
1.2	463
106.3	464
1.2	465	User variable setting file generation directory: D:\go:
	466
43.2	467	[[image:image-20220524165517-35.png]]
1.2	468
86.27	469
1.2	470
108.9	471	(% 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.
	472
1.2	473	The name of the plugin: Example ADR plugin:
	474
48.2	475	[[image:image-20220524165540-36.png]]
1.2	476
	477	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.
	478
48.2	479	[[image:image-20220524165557-37.png]]
1.2	480
86.28	481
1.2	482
108.9	483	(% style="color:blue" %)4. Compile the ADR configuration file and generate the exe file.
	484
1.2	485	1) Create a folder named adr-setting
	486
	487	2) Open the adr-setting folder
	488
	489	3) Put adr.setting.go in this folder.
	490
	491	4) Open the computer cmd and run the following commands in sequencecd adr-setting
	492
	493	go mod init adr-setting
	494
	495	go get github.com/brocaar/chirpstack-network-server/v3/adr
	496
	497	go get github.com/hashicorp/go-plugin
	498
	499	go get adr-setting
	500
	501	go build
	502
	503	5) Finally generate this file：
	504
48.2	505	[[image:image-20220524165623-38.png]]
1.2	506
86.29	507
1.2	508
108.9	509	(% style="color:blue" %)5. Add the plugin and run the plugin.
	510
1.5	511	(((
1.2	512	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	513	)))
1.2	514
48.2	515	[[image:image-20220524165641-39.png]]
1.2	516
1.4	517	(((
1.5	518	(((
1.2	519	For example: adr_plugins=[“adr-setting”]
1.4	520	)))
1.5	521	)))
1.2	522
1.4	523	* (((
1.5	524	(((
1.4	525	Adding a single plugin format is adr_plugins=["filename"]
	526	)))
1.5	527	)))
1.2	528
1.4	529	* (((
1.5	530	(((
1.4	531	Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
	532	)))
1.5	533	)))
1.2	534
1.4	535	(((
1.5	536	(((
1.2	537	Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
1.4	538	)))
1.5	539	)))
1.2	540
79.2	541	[[image:image-20220525104647-26.png]]
1.2	542
	543	Finish.
	544
86.30	545
108.9	546
1.2	547	= 6. Trouble Shooting =
	548
	549	== 6.1 MIC Mismatch or MIC Failed ==
	550
108.9	551
1.4	552	(((
1.2	553	When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
1.4	554	)))
1.2	555
1.4	556	(((
1.2	557	Under normal circumstances, users need to change the APPKEY to solve this problem.
1.4	558	)))

Wiki source code of Notes for ChirpStack

Applications

Navigation