Wiki source code of Notes for ChirpStack

Version 86.6 by Xiaoling on 2022/05/30 15:26

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

Wiki source code of Notes for ChirpStack

Applications

Navigation