Summary

• Page properties (1 modified, 0 added, 0 removed)
• Attachments (0 modified, 7 added, 0 removed)
  • image-20220613190254-1.png
  • image-20220613190635-2.png
  • image-20220613191154-3.png
  • image-20220613191345-4.png
  • image-20220613191426-5.png
  • image-20220613192816-6.png
  • image-20220714155901-1.png

Details

Page properties

Content

...	...	@@ -1,15 +1,17 @@
1		-**~ Contents：**
	1	+**~ Table of Contents：**
2	2
3	3	{{toc/}}
4	4
5	5
6		-= 1. Introduction =
	6	+= 1.  Introduction =
7	7
	8	+
8	8	Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
9	9
10	10
11		-== 1.1 Support Devices ==
	12	+== 1.1  Support Devices ==
12	12
	14	+
13	13	This MQTT forward instruction is for below devices:
14	14
15	15	* Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
...	...	@@ -22,8 +22,9 @@
22	22
23	23
24	24
25		-= 2. Firmware Change Log for MQTT feature =
	27	+= 2.  Firmware Change Log for MQTT feature =
26	26
	29	+
27	27	(((
28	28	This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
29	29	)))
...	...	@@ -31,31 +31,41 @@
31	31	* LG02_LG08-5.3.1580178039
32	32	** Initiate version
33	33
34		-= 3. MQTT forward operating principle =
35	35
36		-== 3.1 Network Structure ==
37	37
	39	+= 3.  MQTT forward operating principle =
	40	+
	41	+
	42	+== 3.1  Network Structure ==
	43	+
	44	+
38	38	Below shows the network structure for MQTT forwarding.
39	39
40		-* For Uplink: The sensor sends data to LoRa Gateway via LoRa wireless, The gateway will process these data and forward to remote MQTT Broker via Internet.
41		-* For Downlink: The gateway subscribe a topic in the MQTT broker, when there is update on the topic, the gateway will know and broadcast the data to Local LoRa network,
	47	+* **For Uplink:**  The sensor sends data to LoRa Gateway via LoRa wireless, The gateway will process these data and forward to remote MQTT Broker via Internet.
	48	+* **For Downlink:** The gateway subscribe a topic in the MQTT broker, when there is update on the topic, the gateway will know and broadcast the data to Local LoRa network.
42	42
	50	+
43	43	[[image:image-20220527133547-1.png]]
44	44
45	45	General MQTT structure
46	46
47	47
48		-== 3.2 How sensor data is forwarded ==
49	49
	57	+== 3.2  How sensor data is forwarded ==
	58	+
	59	+
50	50	In this MQTT forward feature, the key point is how the gateway process the sensor data.
51	51
52	52
53		-=== 3.2.1 Upstream ===
	63	+=== 3.2.1  Upstream ===
54	54
	65	+
55	55	Assume there are two sensor nodes, their ID are Node1 ID: 6734 , Node2 ID: 7456. In the remote MQTT broker there are two topics: Topic1: /channel/765800, Topic2: /channel/367860. We can set up in the gateway to map Node1 to Topic1 and Node2 to Topic2. So when there is a sensor data from Node1, the gateway will forward the data to Topic1, when there is sensor data from Node2, the gateway will forward to Topic2.
56	56
57	57	(((
58	58	The data flow works as below diagram.
	70	+
	71	+
59	59	)))
60	60
61	61	[[image:image-20220527134000-2.png]]
...	...	@@ -62,10 +62,12 @@
62	62
63	63	(((
64	64	Upstream path
	78	+
	79	+
65	65	)))
66	66
67	67	(((
68		-Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
	83	+(% style="color:red" %)**Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>**
69	69	)))
70	70
71	71	(((
...	...	@@ -72,8 +72,9 @@
72	72
73	73	)))
74	74
75		-=== 3.2.2 Downstream ===
	90	+=== 3.2.2  Downstream ===
76	76
	92	+
77	77	The gateway subscribes to a topic of the remote MQTT broker topic. When there is some one publish a value on this topic. The gateway will get it and broadcast to local LoRa Network.
78	78
79	79	(((
...	...	@@ -85,18 +85,22 @@
85	85	Downstream path
86	86
87	87
88		-== 3.3 Macro Definition ==
89	89
	105	+== 3.3  Macro Definition ==
	106	+
	107	+
90	90	The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
91	91
92	92	(((
93	93	Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
94	94
	113	+
95	95
96	96	)))
97	97
98		-=== 3.3.1 -t topic macro ===
	117	+=== 3.3.1  -t topic macro ===
99	99
	119	+
100	100	* CHANNEL: Remote Channel ID
101	101	* CLIENTID: Client ID , Same as -i
102	102	* WRITE_API: Remote Channel Write API
...	...	@@ -103,8 +103,11 @@
103	103	* USERNAME: User ID (-u)
104	104	* HOSTNAME: Device Hostname
105	105
106		-=== 3.3.2 -m message macro ===
107	107
	127	+
	128	+=== 3.3.2  -m message macro ===
	129	+
	130	+
108	108	* HOSTNAME: Device Hostname
109	109	* CHANNEL: Remote Channel ID
110	110	* DATA: Sensor Data without time stamp and rssi
...	...	@@ -111,14 +111,18 @@
111	111	* META: Completely sensor data with time stamp and rssi
112	112	* JSON: Convert META to json format.
113	113
114		-=== 3.3.3 Example for Macro ===
115	115
	138	+
	139	+=== 3.3.3  Example for Macro ===
	140	+
	141	+
116	116	[[image:image-20220527134251-4.png]]
117	117
118	118	MQTT Publish configure
119	119
120		-Above screen shots shows below format:
121	121
	147	+**Above screen shots shows below format:**
	148	+
122	122	* -t: CLIENTID/CHANNEL/data
123	123	* -m: DATA
124	124
...	...	@@ -128,13 +128,16 @@
128	128
129	129	Sensor Data
130	130
	158	+
131	131	(((
132	132	According to above macro. Gateway will publish (% style="color:#4f81bd" %)**field1=22.0&field2=49.0**(%%) to topic: (% style="color:#4f81bd" %)**dragino-1b7060/78901/data**(%%), where 78901 is the remote channel for this node ID.
133	133	)))
134	134
135	135
136		-== 3.4 Modify the MQTT to support more options ==
137	137
	165	+== 3.4  Modify the MQTT to support more options ==
	166	+
	167	+
138	138	The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands. User can check the valid options by command mosquitto_pub ~-~-help. as below:
139	139
140	140	(% class="box" %)
...	...	@@ -152,9 +152,9 @@
152	152	[-u username [-P password]]
153	153	[~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
154	154	[{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
155		- [~-~-ciphers ciphers] [~-~-insecure]
156		- [~-~-tls-alpn protocol]
157		- [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
	185	+ [~-~-ciphers ciphers] [~-~-insecure]
	186	+ [~-~-tls-alpn protocol]
	187	+ [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
158	158	[~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
159	159	[~-~-proxy socks-url]
160	160	[~-~-property command identifier value]
...	...	@@ -259,15 +259,19 @@
259	259	)))
260	260
261	261
262		-= 4. Example to communicate to a simple MQTT server =
263	263
264		-== 4.1 Overview ==
	293	+= 4.  Example to communicate to a simple MQTT server =
265	265
	295	+
	296	+== 4.1  Overview ==
	297	+
	298	+
266	266	This section is an example to show how to set up LG01-N to communicate with a MQTT server. The MQTT server is a simple utility set up in a local PC. Note: User can set up same server via [[this instruction>>url:http://www.steves-internet-guide.com/install-mosquitto-broker/]].
267	267
268	268
269		-== 4.2 Simulate via MQTT.fx utility ==
	302	+== 4.2  Simulate via MQTT.fx utility ==
270	270
	304	+
271	271	The [[MQTT.fx>>url:http://mqttfx.jensd.de/index.php/download]] is a MQTT client tool. We can use this to simulate a MQTT connection to our MQTT broker first to make sure the MQTT broker works. This will also help us understand how it works.
272	272
273	273	(((
...	...	@@ -293,14 +293,16 @@
293	293	Downstream: Subscribe a topic to get downstream
294	294
295	295
296		-== 4.3 Simulate via Dragino Command Line ==
297	297
	331	+== 4.3  Simulate via Dragino Command Line ==
	332	+
	333	+
298	298	For first try of MQTT connection, simulate via command line is recommend, there are many servers / connection type for MQTT. They are using different connection parameters. Simulating the connection via command line will help us rapidly connect to server and debug.
299	299
300	300	In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
301	301
302	302
303		-(% style="color:#4f81bd" %)**For Upstream**
	339	+(% style="color:blue" %)**For Upstream**
304	304
305	305	command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
306	306
...	...	@@ -313,8 +313,9 @@
313	313	mosquitto_pub
314	314
315	315
316		-(% style="color:#4f81bd" %)**For Downstream**
317	317
	353	+(% style="color:blue" %)**For Downstream**
	354	+
318	318	Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
319	319
320	320	[[image:image-20220527135440-10.png]]
...	...	@@ -322,8 +322,10 @@
322	322	mosquitto_sub
323	323
324	324
325		-== 4.4 Configure Dragino UI for MQTT connection ==
326	326
	363	+== 4.4  Configure Dragino UI for MQTT connection ==
	364	+
	365	+
327	327	This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
328	328
329	329	(((
...	...	@@ -330,10 +330,11 @@
330	330	Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
331	331	)))
332	332
333		-[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
	372	+[[image:image-20220714155901-1.png]]
334	334
335	335	go to mqtt configure menu
336	336
	376	+
337	337	(((
338	338	Select (% style="color:#4f81bd" %)**Forward to MQTT server**. (% style="color:red" %)**Notice**(%%): This option is removed from the latest firmware, in the latest firmware, if user submit "SAVE & APPLY" in MQTT page, the gateway will use MQTT service.
339	339	)))
...	...	@@ -343,24 +343,28 @@
343	343	forward to MQTT
344	344
345	345
346		-=== 4.4.1 Configure the MQTT Client for Upstream ===
347	347
348		-Below screenshot is same as the publish command:
	387	+=== 4.4.1  Configure the MQTT Client for Upstream ===
349	349
	389	+
	390	+**Below screenshot is same as the publish command:**
	391	+
350	350	(% class="box" %)
351	351	(((
352		-mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
	394	+**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
353	353	~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
354	354	~/~/CLIENTID: dragino-1b7060
355	355	~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
356		-~/~/DATA: The data stores in /var/iot/channels/
	398	+~/~/DATA: The data stores in /var/iot/channels/**
357	357	)))
358	358
	401	+
359	359	[[image:image-20220527135828-12.png]]
360	360
361	361	MQTT Publish configure
362	362
363	363
	407	+
364	364	[[image:image-20220527135929-13.png]]
365	365
366	366	MQTT Channel settings
...	...	@@ -389,8 +389,10 @@
389	389	MQTT Publish
390	390
391	391
392		-=== 4.4.2 Configure the MQTT Client for Downstream ===
393	393
	437	+=== 4.4.2  Configure the MQTT Client for Downstream ===
	438	+
	439	+
394	394	Below screen shot equal to this subscribe command:
395	395
396	396	(% class="box" %)
...	...	@@ -419,13 +419,15 @@
419	419	downstream simulation
420	420
421	421
422		-== 4.5 Add LoRa support to communicate with remote sensor ==
	468	+== 4.5  Add LoRa support to communicate with remote sensor ==
423	423
	470	+
424	424	In above section, we have configured the UI to support MQTT upstream and downstream. We can simulate via Linux command. In this section, we will guide how to communicate with remote LoRa End Node for upstream and downstream.
425	425
426	426
427		-=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
	474	+=== 4.5.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
428	428
	476	+
429	429	(((
430	430	We can use [[LoRa Shield>>url:http://www.dragino.com/products/lora/item/102-lora-shield.html]] to send LoRa Raw data to Gateway and receive data from gateway.
431	431	)))
...	...	@@ -436,6 +436,8 @@
436	436
437	437	(((
438	438	And this link is the required library: [[arduino-LoRa-master>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]. Unzip this library and put in Arduino library location.
	487	+
	488	+
439	439	)))
440	440
441	441	(((
...	...	@@ -451,6 +451,7 @@
451	451	LoRa Parameter should match
452	452
453	453
	504	+
454	454	Below is the test result after the Arduino Sketch is running.
455	455
456	456	[[image:image-20220527140459-19.png]]
...	...	@@ -458,13 +458,16 @@
458	458	Upstream Data Flow
459	459
460	460
	512	+
461	461	[[image:image-20220527140542-20.png]]
462	462
463	463	Downstream Data Flow
464	464
465	465
466		-=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
467	467
	519	+=== 4.5.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
	520	+
	521	+
468	468	(((
469	469	Since firmware (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% style="color:#4f81bd" %)**ABP end node**(%%) locally without the need of LoRaWAN server. This feature allow us to integrate MQTT in the gateway to support LoRaWAN to MQTT forwarding or visa verse.
470	470	)))
...	...	@@ -471,15 +471,17 @@
471	471
472	472	(((
473	473	When use test this feature, please use the version higher then : (% style="color:#4f81bd" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.
474		-(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
	528	+
	529	+
	530	+(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
475	475	)))
476	476
477	477	(((
478		-(% style="color:#4f81bd" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.
	534	+(% style="color:blue" %)**Step 1**(%%): Refer [[Communicate with ABP End Node>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308]] to know how to set up LG308 to work with LoRaWAN End node.
479	479	)))
480	480
481	481	(((
482		-(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
	538	+(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
483	483	)))
484	484
485	485	[[image:image-20220527141235-21.png]]
...	...	@@ -489,62 +489,89 @@
489	489
490	490	(((
491	491	(((
492		-(% style="color:#4f81bd" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file. And we need to config the format to (% style="color:#4f81bd" %)**META**
	548	+(% style="color:blue" %)**Step 3**(%%): Set up publish format and MQTT channel. The LG308 will store the Data from End node in (% style="color:#4f81bd" %)**HEX format**(%%) in the file.
493	493	)))
494	494	)))
495	495
496		-[[image:image-20220527141450-22.png]]
	552	+[[image:image-20220613191345-4.png]]
497	497
498		-Publish mush use META as data format for LG308
499	499
500	500
501		-(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
	556	+(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
502	502
503		-[[image:image-20220527141727-23.png]]
	558	+[[image:image-20220613190635-2.png]]
504	504
505		-Map Dev Addr to remote ID
506	506
507	507
508		-(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
	562	+(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
509	509
510	510	[[image:image-20220527141843-24.png]]
511	511
512		-Upstream Process
513	513
514	514
	568	+
515	515	[[image:image-20220527141933-25.png]]
516	516
517	517	Choose ASCII Format
518	518
519	519
	574	+
520	520	[[image:image-20220527142028-26.png]]
521	521
522	522	LHT65 Decoder
523	523
524	524
525		-(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
526	526
527		-[[image:image-20220527142115-27.png]]
	581	+(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
528	528
529		-Subscribe to a topic
	583	+[[image:image-20220613191426-5.png]]
530	530
531	531
532		-(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
533	533
	587	+(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
	588	+
534	534	[[image:image-20220527142239-28.png]]
535	535
536		-Downstream Flow
537	537
	592	+
	593	+=== 4.5.3 MQTT Downstream format ===
	594	+
	595	+
	596	+mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
	597	+
	598	+(% class="box infomessage" %)
	599	+(((
	600	+**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
	601	+)))
	602	+
	603	+mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
	604	+
	605	+(% class="box infomessage" %)
	606	+(((
	607	+**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2 > /var/iot/push/test"**
	608	+)))
	609	+
	610	+Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
	611	+
	612	+[[image:image-20220613192816-6.png||height="440" width="1056"]]
	613	+
	614	+
538	538	(% style="color:red" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>Communicate with ABP End Node without LoRaWAN Network Server --- LG308||anchor="H2.2Downstream"]]**
539	539
540	540
541		-= 5. How to Debug =
	618	+Check out this link for more mosquito-related directives [[https:~~/~~/mosquitto.org/man/mosquitto_pub-1.html>>https://mosquitto.org/man/mosquitto_pub-1.html]]
542	542
	620	+
	621	+
	622	+= 5.  How to Debug =
	623	+
	624	+
543	543	User can login the gateway's console and run (% style="color:#4f81bd" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.
544	544
545	545
546		-= 6. How to ask for Support =
	628	+= 6.  How to ask for Support =
547	547
	630	+
548	548	If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
549	549
550	550	* Detail of your LoRaWAN end node.

image-20220613190254-1.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Kilight

Size

...	...	@@ -1,0 +1,1 @@
	1	+55.7 KB

Content

image-20220613190635-2.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Kilight

Size

...	...	@@ -1,0 +1,1 @@
	1	+44.1 KB

Content

image-20220613191154-3.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Kilight

Size

...	...	@@ -1,0 +1,1 @@
	1	+56.1 KB

Content

image-20220613191345-4.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Kilight

Size

...	...	@@ -1,0 +1,1 @@
	1	+55.4 KB

Content

image-20220613191426-5.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Kilight

Size

...	...	@@ -1,0 +1,1 @@
	1	+55.8 KB

Content

image-20220613192816-6.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Kilight

Size

...	...	@@ -1,0 +1,1 @@
	1	+22.1 KB

Content

image-20220714155901-1.png

Author

...	...	@@ -1,0 +1,1 @@
	1	+XWiki.Xiaoling

Size

...	...	@@ -1,0 +1,1 @@
	1	+75.2 KB

Content