Wiki source code of Notes for ChirpStack

Version 109.1 by Edwin Chen on 2022/10/10 19:33

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

Wiki source code of Notes for ChirpStack

Applications

Navigation