Wiki source code of Notes for ChirpStack

Version 86.4 by Xiaoling on 2022/05/30 15:25

version	line-number	content
1.7	1	~ Contents:
1.2	2
1.1	3	{{toc/}}
	4
86.4	5
	6
	7
1.2	8	= 1. Introduction =
1.1	9
53.1	10	(% 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	11
1.5	12	(((
51.1	13	(% style="color:black" %)The dragino gateway can connect the ChirpStack server via Semtech UDP or Semtech Basic Station.
1.5	14	)))
1.1	15
1.2	16	Prerequisite
1.1	17
1.2	18	1) Have a Chirstack Server.
1.1	19
54.2	20	[[image:image-20220525100058-1.png]]
1.1	21
1.2	22	ChirpStack home page
1.1	23
54.2	24
1.2	25	2) Gateway model support
1.1	26
1.2	27	(% class="box" %)
	28	(((
1.5	29	(((
1.2	30	Semtech UDP : All Model
	31	Basic Station : , ,
	32	Note : the firmware needs > if use the Bais station
	33	)))
1.5	34	)))
1.1	35
1.2	36	= 2. Semtech UDP =
1.1	37
1.2	38	== 2.1 Step 1. Add the Network-servers ==
1.1	39
1.2	40	The network-Servers address varies depending on the ChirpStack server setup environment
1.1	41
1.3	42	(% class="box" %)
	43	(((
	44	Windows ~-~->Network-server server * : localhost:8000
	45	Linux ~-~->Network-server server * : chirpstack-network-server:8000
	46	)))
1.1	47
1.2	48	If the user cannot add network-Servers, re-check the ChirpStack code or the server building process.
1.1	49
55.2	50	[[image:image-20220525100158-2.png]]
1.2	51
	52	Add the Network-servers
	53
84.2	54
1.2	55	== 2.2 Step 2. Create Gateway-profiles ==
	56
59.2	57	[[image:image-20220525100255-3.png]]
1.2	58
	59	Create Gateway-profiles
	60
84.2	61
1.2	62	== 2.3 Step 3. Create Service-profiles ==
	63
59.2	64	[[image:image-20220525100322-4.png]]
1.2	65
	66	Create Service-profiles
	67
	68	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.
	69
1.4	70	(% style="color:red" %)Note : Before add the gateway, the user needs to complete the preceding three steps.
1.2	71
84.2	72	If the user has completed the preceding steps, proceed to the next step.(% style="display:none" %)
1.2	73
84.2	74
1.2	75	== 2.4 Step 4. Add the gateway ==
	76
	77	The example gateway id is: a840411e96744150
	78
1.5	79	(((
1.4	80	(% style="color:red" %)Note : The Gateway EUI and server addresses must match the ChirpStack configuration.
1.5	81	)))
1.2	82
84.2	83	[[image:image-20220525100350-5.png]](% style="display:none" %)
1.2	84
84.2	85
1.2	86	Add the gateway
	87
59.2	88	[[image:image-20220525100417-6.png]]
1.2	89
	90	Configure the gateway
	91
84.2	92
1.2	93	== 2.5 Step 5. Checking gateway Status ==
	94
84.2	95	[[image:image-20220525100448-7.png]](% style="display:none" %)
1.2	96
84.2	97
1.2	98	gateway Status
	99
84.2	100	[[image:image-20220526090446-3.png\|\|height="653" width="1218"]]
1.2	101
	102	gateway Status
	103
9.1	104	= 3. Gateway Registration for Basics Station =
1.2	105
9.1	106	== Introduction ==
	107
	108	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.
	109
	110	ChirpStack Open-Source LoRaWAN® Network Server needs to set up a configuration that can use Semtech BasicStation.
	111
	112	Below list the support products and Requirements:
	113
	114	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]]
	115	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/]]
	116
	117	How to set up chirpStack Basic Station
	118
	119	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]]
	120
	121	What do you need to prepare
	122
	123	A gateway that can access the internet normally
	124
	125	== 3.1 Add Gateway ==
	126
20.2	127	[[image:image-20220524164205-10.png]]
9.1	128
	129	== 3.2 Access the gateway GUI ==
	130
	131	Access the gateway GUI interface of LoRaWAN~-~->LoRaWAN ~-~- Basic Station
	132
20.2	133	[[image:image-20220524164319-11.png]]
9.1	134
	135	User need to Choose the ChirpStack/Senet ~-~- Basic Station , input Server URI and Upload the TLS Certificate
	136
	137	(% class="box" %)
	138	(((
	139	Service Provider ~-~-> Choose the ChirpStack/Senet ~-~- Basic Station
	140
	141	LNS URI ~-~-> Enter the LNS URI address, For example : wss:~/~/xxxx.chirpstack.com:433 or ws:~/~/xxxx.chirpstack.com:3001
	142
	143	LNS TLS trust ~-~-> Upload the TLS Certificate
	144	)))
	145
	146	(% class="wikigeneratedid" %)
20.2	147	[[image:image-20220524164341-12.png]]
9.1	148
	149	== 3.3 Start Station ==
	150
	151	When the user has finished the configuration, Please click Sace&Apply to start station to connect ChirpStack
	152
	153	== 3.4 Successful Connection ==
	154
	155	If user completes the above steps, which will see live date in the ChirpStack.
	156
23.2	157	[[image:image-20220524164448-13.png]]
9.1	158
10.2	159	== 3.5 Trouble Shooting ==
9.1	160
	161	User can check the station log in the logread/system log page.
	162
23.2	163	[[image:image-20220524164514-14.png]]
9.1	164
	165	and recode the station log in the system/Recode log page.
	166
23.2	167	[[image:image-20220524164541-15.png]]
9.1	168
1.2	169	= 4. Downlink =
	170
	171	== 4.1 Chirpstack Downlink Note ==
	172
63.2	173	[[image:image-20220525101223-9.png]]
1.2	174
	175	Convert the data to Base64
	176
84.2	177	[[image:image-20220526090748-4.png]]
1.2	178
	179	Check ChripStack downlink DataRate
	180
65.2	181	[[image:image-20220525101326-11.png]]
1.2	182
	183	Make sure the RX2DR is the same in the end node
	184
	185	== 4.2 Loraserver Downlink Note ==
	186
	187	User can use MQTT to send downlink payload to ChirpStack to perform downstream to LoRaWAN End
	188
1.5	189	(((
1.2	190	Below is examples:
1.5	191	)))
1.2	192
1.4	193	(% class="box" %)
	194	(((
	195	Connect to your server via MQTT：
	196	MQTT Client ID: Any
	197	Protocol：mqtt/tcp Server IP：loraserver_ip:1883
1.2	198	User name: User name Password: password
1.4	199	)))
1.2	200
65.2	201	[[image:image-20220525101401-12.png]]
1.2	202
1.5	203	(((
1.2	204	MQTT Connect to ChirpStack
1.5	205	)))
1.2	206
1.5	207	(((
1.2	208	After connect
1.5	209	)))
1.2	210
1.4	211	(% class="box" %)
	212	(((
	213	Subscribe : Format：application/ID/device/ Device EUI/rx
1.2	214	Example: application/7/device/00aedb3da649cb23/rx
1.4	215	)))
1.2	216
1.4	217	(% class="box" %)
	218	(((
	219	Publish:
1.2	220	Format: Top: application/ID/device/ Device EUI/tx
	221	Payload: {"confirmed":true or false,"fPort":XX,"data":"xxxx"}
	222	Example: Top: application/7/device/00aedb3da649cb23/tx
	223	Payload: {"confirmed":true,"fPort":2,"data":"AwEB"}
1.4	224	)))
1.2	225
66.2	226	[[image:image-20220525101436-13.png]]
1.2	227
	228	MQTT Connect to ChirpStack
	229
1.4	230	(((
	231	(% 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/]]
	232	)))
1.2	233
67.2	234	[[image:image-20220525101505-14.png]]
1.2	235
	236	Choose to Use Hex for Encode
	237
	238	If we want send downstream hex 030101 to end node, the BASE64 payload is AwEB
	239
68.2	240	[[image:image-20220525104025-15.png]]
1.2	241
1.5	242	(((
1.2	243	Downlink payload encode javescript code: 可以在网站上运行以下Javsscript代码：
1.5	244	)))
1.2	245
1.4	246	(% class="box" %)
	247	(((
	248	function sha1_to_base64(sha1)
1.2	249	{
	250	var digits="ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789+/";
	251	var base64_rep = "";
	252	var cnt = 0;
	253	var bit_arr = 0;
	254	var bit_num = 0;
1.5	255	\\ for(var n = 0; n < sha1.length; ++n)
1.2	256	{
	257	if(sha1[n] >= 'A' && sha1[n] <= 'Z')
	258	{
	259	ascv = sha1.charCodeAt(n) - 55;
	260	}
	261	else if(sha1[n] >= 'a' && sha1[n] <= 'z')
	262	{
	263	ascv = sha1.charCodeAt(n) - 87;
	264	}
	265	else
	266	{
	267	ascv = sha1.charCodeAt(n) - 48;
	268	}
1.5	269	\\ bit_arr = (bit_arr << 4) \| ascv;
1.2	270	bit_num += 4;
	271	if(bit_num >= 6)
	272	{
1.4	273	bit_num -= 6;
1.2	274	base64_rep += digits[bit_arr >>> bit_num];
1.4	275	bit_arr &= ~~(-1 << bit_num);
1.2	276	}
	277	}
1.5	278	\\ if(bit_num > 0)
1.2	279	{
	280	bit_arr <<= 6 - bit_num;
	281	base64_rep += digits[bit_arr];
	282	}
1.5	283	\\ var padding = base64_rep.length % 4;
	284	\\ if(padding > 0)
1.2	285	{
	286	for(var n = 0; n < 4 - padding; ++n)
	287	{
	288	base64_rep += "=";
	289	}
	290	}
	291	return base64_rep;
	292	}
1.5	293	\\console.log(sha1_to_base64("data"));
	294	\\data is downlink payload required by end node.
1.4	295	e.g console.log(sha1_to_base64("030101"));
	296	result: AwEB
1.2	297	AwEB is the 0x030101's base 64 Encode.
1.5	298	\\e.g console.log(sha1_to_base64("030000"));
1.4	299	result: AwAA
	300	AwAA is 0x030000's base 64 Encode.
	301	)))
1.2	302
	303	== 4.3 Add the decode function in Chirpstack for the payload ==
	304
	305	User enters the payload code according to the steps.
	306
69.2	307	[[image:image-20220525104051-16.png]]
1.2	308
70.2	309	[[image:image-20220525104155-17.png]]
1.2	310
	311
84.2	312	[[image:image-20220526091602-5.png]]
	313
86.2	314	[[image:image-20220526091801-6.png]]
1.2	315
	316	= 5. Multiply Uplink in ChirpStack =
	317
1.4	318	(((
1.2	319	nbtrans field is the value to determine the re-transmission time for unconfirmed uplink data.
1.4	320	)))
1.2	321
1.4	322	(((
1.2	323	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]]
1.4	324	)))
1.2	325
86.2	326	[[image:image-20220526091912-7.png]]
1.2	327
1.5	328	(((
1.2	329	nbtrans is a field of ADR message, in unconfirm mode, it tells end node how many time it needs to transmit for every frame.
1.5	330	)))
1.2	331
76.2	332	[[image:image-20220525104359-21.png]]
1.2	333
1.4	334	(((
1.2	335	Above behaviour will cause the platform shows below two cases of error:
1.4	336	)))
1.2	337
1.4	338	(((
1.2	339	Error of duplicate Frame Counter
1.4	340	)))
1.2	341
76.2	342	[[image:image-20220525104437-22.png]]
1.2	343
	344	Duplicate transmission in short time
	345
76.2	346	[[image:image-20220525104502-23.png]]
1.2	347
	348	== 5.1 Solution ==
	349
	350	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]]
	351
1.5	352	(((
1.2	353	~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	354	)))
1.2	355
79.2	356	[[image:image-20220525104532-24.png]]
1.2	357
	358	installation path:
	359
79.2	360	[[image:image-20220525104554-25.png]]
1.2	361
1.5	362	(((
1.2	363	2. Environment variable settings:.
1.5	364	)))
1.2	365
1.5	366	(((
1.2	367	1) Open Computer -> Properties -> Advanced System Settings -> Environment Variables and add a "new" system variable:
1.5	368	)))
1.2	369
1.5	370	(((
1.2	371	2)Set the variable name GOROOT and the variable value C:\Go\ (installation directory)
1.5	372	)))
1.2	373
43.2	374	[[image:image-20220524165433-33.png]]
1.2	375
	376	3)Modify the system variable Path and add C:\Go\bin\:
	377
43.2	378	[[image:image-20220524165452-34.png]]
1.2	379
	380	User variable setting file generation directory: D:\go:
	381
43.2	382	[[image:image-20220524165517-35.png]]
1.2	383
	384	3. Modify the ADR configuration file according to your own needs, adr.setting.go is an example of the ADR configuration file.
	385
	386	The name of the plugin: Example ADR plugin:
	387
48.2	388	[[image:image-20220524165540-36.png]]
1.2	389
	390	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.
	391
48.2	392	[[image:image-20220524165557-37.png]]
1.2	393
	394	4. Compile the ADR configuration file and generate the exe file.
	395
	396	1) Create a folder named adr-setting
	397
	398	2) Open the adr-setting folder
	399
	400	3) Put adr.setting.go in this folder.
	401
	402	4) Open the computer cmd and run the following commands in sequencecd adr-setting
	403
	404	go mod init adr-setting
	405
	406	go get github.com/brocaar/chirpstack-network-server/v3/adr
	407
	408	go get github.com/hashicorp/go-plugin
	409
	410	go get adr-setting
	411
	412	go build
	413
	414	5) Finally generate this file：
	415
48.2	416	[[image:image-20220524165623-38.png]]
1.2	417
	418	5. Add the plugin and run the plugin.
	419
1.5	420	(((
1.2	421	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	422	)))
1.2	423
48.2	424	[[image:image-20220524165641-39.png]]
1.2	425
1.4	426	(((
1.5	427	(((
1.2	428	For example: adr_plugins=[“adr-setting”]
1.4	429	)))
1.5	430	)))
1.2	431
1.4	432	* (((
1.5	433	(((
1.4	434	Adding a single plugin format is adr_plugins=["filename"]
	435	)))
1.5	436	)))
1.2	437
1.4	438	* (((
1.5	439	(((
1.4	440	Adding multiple plugins The format is adr_plugins=["file name 1", "file name 2",...]
	441	)))
1.5	442	)))
1.2	443
1.4	444	(((
1.5	445	(((
1.2	446	Finally, re-run chirpstack-network-server.exe, and then select the plugin you just compiled in Device-profiles,
1.4	447	)))
1.5	448	)))
1.2	449
79.2	450	[[image:image-20220525104647-26.png]]
1.2	451
	452	Finish.
	453
	454	= 6. Trouble Shooting =
	455
	456	== 6.1 MIC Mismatch or MIC Failed ==
	457
1.4	458	(((
1.2	459	When the device is registered or the device is working normally, the problem of MIC mismatch and MIC failed occurs.
1.4	460	)))
1.2	461
1.4	462	(((
1.2	463	Under normal circumstances, users need to change the APPKEY to solve this problem.
1.4	464	)))

Wiki source code of Notes for ChirpStack

Applications

Navigation