Wiki source code of Notes for ChirpStack

Version 113.1 by Xiaoye on 2022/10/12 17:42

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

Wiki source code of Notes for ChirpStack

Applications

Navigation