Wiki source code of Notes for ChirpStack

Version 85.1 by Xiaoling on 2022/05/26 09:18

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

Wiki source code of Notes for ChirpStack

Applications

Navigation