Skip to Content

Wiki source code of MQTT Forward Instruction

Version 53.1 by Kilight Cao on 2024/08/31 16:00
Show last authors
1 **~ Table of Contents：**
2
3 {{toc/}}
4
5
6 = 1.  Introduction =
7
8
9 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
10
11
12 == 1.1  Support Devices ==
13
14
15 This MQTT forward instruction is for below devices:
16
17 * LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>doc:Main.Through MQTT to upload data.WebHome]])
18 * LG02, OLG02
19 * LG308, DLOS8, LPS8, LIG16
20 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
21 * LG308N, DLOS8N, LPS8N
22 * LPS8V2
23
24
25 The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands.
26
27 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]]**
28
29
30 = 2.  Example to communicate to a simple MQTT server =
31
32 == 2.1  Overview ==
33
34
35 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/]].
36
37
38 == 2.2  Simulate via MQTT.fx utility ==
39
40
41 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.
42
43 (((
44 In this test, the MQTT broker and MQTT.fx are installed in the same PC, so the MQTT server address in MQTT.fx should be localhost. Below shows how to connect to the server.
45 )))
46
47 [[image:image-20220527134929-6.png]]
48
49 Connect to MQTT Broker
50
51
52 After connected, use publish to public some thing to MQTT server. This to simulate upsteam
53
54 [[image:image-20220527135037-7.png]]
55
56 Upstream: Publish message to MQTT Broker
57
58
59 To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below:
60
61 [[image:image-20220527135215-8.png]]
62
63 Downstream: Subscribe a topic to get downstream
64
65
66
67 = 3. Add LoRa support to communicate with remote sensor =
68
69
70 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.
71
72
73
74 == 3.1  Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ==
75
76
77 (((
78 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.
79 )))
80
81 (((
82 The example Sketch for LoRa Shield +Arduino is here: **[[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]**
83 )))
84
85 (((
86 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.
87
88
89 )))
90
91 (((
92 What does the Arduino Sketch do? The Arduino Sketch will:
93 )))
94
95 * Upstream: Keep sending a LoRa Message every minutes with this payload : <4567>tem=xx&hum=yy (Where xx and yy are temperature and humidity value generated randomly).
96 * Downstream: Listening broadcast message from gateway, and print it in console.
97 * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
98
99 [[image:image-20220527140354-18.png]]
100
101 LoRa Parameter should match
102
103
104 Below is the test result after the Arduino Sketch is running.
105
106 [[image:image-20220527140459-19.png]]
107
108 Upstream Data Flow
109
110
111 [[image:image-20220527140542-20.png]]
112
113 Downstream Data Flow
114
115
116 == 3.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8/LG308N/LPS8N/DLOS8N ==
117
118
119 (((
120 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.
121 )))
122
123 (((
124 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.
125
126
127 (% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
128 )))
129
130 (((
131 (% 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.
132 )))
133
134 (((
135 (% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
136 )))
137
138 [[image:image-20220527141235-21.png]]
139
140 Use Same Frequency Band as End Node
141
142
143 (((
144 (((
145 (% 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.
146 )))
147 )))
148
149 [[image:image-20220613191345-4.png]]
150
151
152 (% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
153
154 [[image:image-20220613190635-2.png]]
155
156
157 (% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
158
159 [[image:image-20220527141843-24.png]]
160
161
162 [[image:image-20220527141933-25.png]]
163
164 Choose ASCII Format
165
166
167 [[image:image-20220527142028-26.png]]
168
169 LHT65 Decoder
170
171
172 (% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
173
174 [[image:image-20220613191426-5.png]]
175
176
177 (% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
178
179 [[image:image-20220527142239-28.png]]
180
181
182
183 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
184
185 (% class="box infomessage" %)
186 (((
187 **mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
188 )))
189
190 mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
191
192 (% class="box infomessage" %)
193 (((
194 **mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"**
195 )))
196
197 (% 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"]]**
198
199 Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
200
201 [[image:image-20220613192816-6.png||height="440" width="1056"]]
202
203
204 == 3.3 Use LoRaWAN Protocol for communication ~-~- For LPS8V2 ==
205
206
207
208
209 = 4.  How to ask for Support =
210
211
212 If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
213
214 * Detail of your LoRaWAN end node.
215 * Gateway Model and firmware version
216 * A set of screenshots you configure in the gateway according to our instruction
217 * A full log of "logread -f"