Skip to Content

Wiki source code of Through MQTT to upload data

Version 44.3 by Xiaoling on 2022/05/31 14:33
Hide last authors
Xiaoling 44.2 1 **Contents: **
2
Xiaoling 1.4 3 {{toc/}}
Xiaoling 1.1 4
Xiaoling 1.4 5
6
7
Xiaoling 1.2 8 = 1. What is MQTT API? =
Xiaoling 1.1 9
Xiaoling 1.5 10 {{{MQTT is a publish/subscribe model that runs over TCP/IP sockets or WebSockets. MQTT over WebSockets can be secured with SSL.}}}
Xiaoling 1.1 11
12
Xiaoling 1.2 13 = 2. MQTT Features =
Xiaoling 1.1 14
Xiaoling 1.2 15 The MQTT protocol runs on TCP / IP or other network protocols and provides an ordered, lossless, bidirectional connection. Features include:
Xiaoling 1.1 16
Xiaoling 1.2 17 * The publish / subscribe messaging pattern used, which provides one-to-many messaging for decoupling from the application.
18 * Message-masking mechanism for payload content.
19 * There are three Quality of Service (QoS) for transmitting messages:
20 * At most, messages of this level may be lost or duplicated, and message postings depend on the underlying TCP / IP network. That is: <= 1
21 * At one time, this level will ensure that the message arrives, but the message may be repeated. That is:> = 1
22 * Only once, make sure the message arrives only once. That is: = 1. In some demanding billing systems, you can use this level Data transfer and protocol exchange is minimized (protocol header only 2 bytes) to reduce network traffic
23 * Notification mechanism, notify the transmission of both sides when an exception occurs
Xiaoling 1.1 24
25
Xiaoling 44.2 26
Xiaoling 1.2 27 = 3. What does this example shows? How it works? =
Xiaoling 1.1 28
Xiaoling 43.3 29 (((
Xiaoling 1.2 30 The server we use here is ThingSpeak which has an intuitive chart to show the test result for our test.The ThingSpeak IoT service now supports MQTT subscriptions to receive instant updates when [[ThingSpeak>>url:https://thingspeak.com/]] channel gets updated. The method here is general and can be used with other IoT servers for MQTT connection as well.
Xiaoling 43.3 31 )))
Xiaoling 1.1 32
Xiaoling 3.2 33 [[image:image-20220531135402-1.png]]
Xiaoling 1.1 34
Xiaoling 1.2 35 Message Queuing Telemetry Transport
Xiaoling 1.1 36
37
Xiaoling 3.2 38 [[image:image-20220531135449-2.png]]
39
Xiaoling 1.2 40 working principle
Xiaoling 1.1 41
Xiaoling 3.2 42
Xiaoling 4.2 43 [[image:image-20220531135521-3.png]]
Xiaoling 1.2 44
Xiaoling 43.3 45 (((
Xiaoling 1.2 46 Schematic diagram: uplink.In this section, we will try to program LG01 to uplink data to ThingSpeak. The data flow in this example.We have already tried ① and ② in the above simple LoRa example. Now we will try the step ③ first, after it work as expect, we will integrate these three steps together for a complete uplink example.
Xiaoling 43.3 47 )))
Xiaoling 1.2 48
Xiaoling 4.2 49
50
Xiaoling 5.2 51 [[image:image-20220531135607-4.png]]
Xiaoling 1.2 52
Xiaoling 43.3 53 (((
Xiaoling 1.2 54 Schematic diagram:downlink.In this section, we will try to program LG01 to fetch download data from ThingSpeak, then broadcast this data to local LoRa network. The end node will get this message and check if they need to do something. Similar with Uplink Example, we will first try to do it in PC, then do it in Linux side, and finally integrate it with LoRa.
Xiaoling 43.3 55 )))
Xiaoling 1.2 56
Xiaoling 43.3 57 (((
Xiaoling 1.2 58 MQTT agreement to achieve the need: client and server There are three identities in the MQTT protocol: Publish, Broker (server), Subscribe. Among them, the publisher and the subscriber of the message are all clients, the broker is the server, and the publisher can be both the subscriber and the subscriber. MQTT transmission of information is divided into: Topic and payload in two parts Topic, can be understood as the type of message subscribers Subscribe, you will receive the theme of the message content (payload) The payload, which can be understood as the content of the message, refers to the specific content to be used by the subscribers.
Xiaoling 43.3 59 )))
Xiaoling 1.2 60
Xiaoling 43.3 61 (((
Xiaoling 1.2 62 To use the server, we need to register an account on [[ThingSpeak>>url:https://thingspeak.com/]] . Then create a channel and type the channel info. As shown below, the Channel ID is the unique ID to store our data in [[ThingSpeak>>url:https://thingspeak.com/]] .
Xiaoling 43.3 63 )))
Xiaoling 1.2 64
65
Xiaoling 44.3 66
Xiaoling 1.2 67 = 4. Preparation =
68
69 == 4.1 Hardware ==
70
Xiaoling 6.2 71 1. [[image:image-20220531135650-5.png]](((
Xiaoling 1.2 72 Listening on the LoRa wireless channel, while there is new LoRa packet arrives, parse it and send out to IoT Server.
Xiaoling 6.2 73
74
75
Xiaoling 1.2 76 )))
Xiaoling 7.2 77 1. [[image:image-20220531135750-6.png]](((
Xiaoling 1.2 78 The LoRa End node keeps getting temperature and humidity from the sensor and sends out via LoRa periodically.
79 )))
80
81 == 4.2 Software ==
82
83 1. [[4.3.4 version>>url:http://www.dragino.com/downloads/index.php?dir=motherboards/ms14/Firmware/IoT/]]
84 1. [[MQTT_Client>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/IoTServer/ThingSpeak/MQTT_Client]]
85 1. [[MQTT_Simple_Server MQTT_Simeple_Server>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/LoRa/MQTT_Simple_Server]]
86 1. [[DHTlib>>url:https://github.com/goodcheney/Lora/blob/patch-1/Lora%20Shield/Examples/DHTlib.zip]]
87
88 == 4.3 Server(For example) ==
89
90 * [[ThingSpeak>>url:https://thingspeak.com/]]
91
Xiaoling 1.3 92 == 4.4 Configure IoT Server ==
Xiaoling 1.2 93
94 * Need this keys:
95
Xiaoling 9.2 96 1. [[image:image-20220531140054-8.png]](((
Xiaoling 1.2 97 Channel ID,Write API Key
Xiaoling 8.3 98
99
100
Xiaoling 1.2 101 )))
Xiaoling 14.2 102 1. [[image:image-20220531140326-13.png]](((
Xiaoling 1.2 103 Account->My Profile,MQTT API Key
Xiaoling 10.2 104
105
106
Xiaoling 1.2 107 )))
108 1. (((
Xiaoling 14.2 109 [[image:image-20220531140304-12.png]]
Xiaoling 1.2 110 )))
111
Xiaoling 1.3 112 == 4.5 Configure LG01 settings ==
Xiaoling 1.2 113
114 Tips:Please confirm that your LG01 version is 4.3.3.
115
Xiaoling 14.2 116 [[image:image-20220531140248-11.png]]
Xiaoling 1.2 117
Xiaoling 19.3 118 **Overview**
Xiaoling 1.2 119
Xiaoling 14.3 120
121
Xiaoling 15.2 122 [[image:image-20220531140425-14.png]]
Xiaoling 1.2 123
Xiaoling 19.3 124 **Senosor->IOT Server**
Xiaoling 1.2 125
Xiaoling 15.2 126
Xiaoling 16.2 127 [[image:image-20220531140458-15.png]]
Xiaoling 1.2 128
Xiaoling 19.3 129 **MQTT->Configure MQTT Server**
Xiaoling 1.2 130
Xiaoling 16.2 131
132
Xiaoling 17.2 133 [[image:image-20220531140538-16.png]]
Xiaoling 1.2 134
Xiaoling 19.3 135 **MQTT->MQTT Channel**
Xiaoling 1.2 136
Xiaoling 17.2 137
138
Xiaoling 18.2 139 [[image:image-20220531140611-17.png]]
Xiaoling 1.2 140
Xiaoling 19.3 141 **Sensor->LoRa/LoraWAN**
Xiaoling 1.2 142
Xiaoling 18.2 143
144
Xiaoling 19.2 145 [[image:image-20220531140651-18.png]]
Xiaoling 1.2 146
Xiaoling 19.3 147 Configure network access.**Network->Internet Access**
Xiaoling 1.2 148
149
Xiaoling 1.3 150 == 4.6 Try MQTT API call with LG01 Linux command ==
Xiaoling 1.2 151
Xiaoling 1.3 152 === 4.6.1 Input the command at the console ===
Xiaoling 1.2 153
Xiaoling 21.2 154 1. [[image:image-20220531140811-19.png]](((
Xiaoling 1.2 155 Open this Application.
Xiaoling 21.2 156
157
Xiaoling 1.2 158 )))
Xiaoling 21.2 159 1. [[image:image-20220531140842-20.png]](((
Xiaoling 1.2 160 Input passward(dragino).After into the console.
Xiaoling 21.2 161
162
Xiaoling 1.2 163 )))
Xiaoling 22.2 164 1. [[image:image-20220531140915-21.png]](((
Xiaoling 1.2 165 First, we need to make sure the LG01 has internet access. We can log in the SSH and ping an Internet address and see if it get through. As below
Xiaoling 22.3 166
167
Xiaoling 1.2 168 )))
Xiaoling 23.2 169 1. [[image:image-20220531140955-22.png]](((
Xiaoling 1.2 170 LG01 has built-in Linux tool mosquitto. It is a very powerful tool for http communication. We can use this tool to handle MQTT API call in LG01. Input this command and replace your keys.
Xiaoling 23.2 171
172
173
Xiaoling 1.2 174 )))
Xiaoling 24.2 175 1. [[image:image-20220531141026-23.png]](((
Xiaoling 1.2 176 Go to Server check out result.We success to use LG01 to uplink data to ThingSpeak,the mosquitto_pub command is executed in the Linux side, finally, we will have to call mosquitto_pub command with sensor data variable in Arduino side. This is through the process class in Arduino and we will show it in the final sketch.
177 )))
178
179 * This command:
180
Xiaoling 24.3 181 (% class="box infomessage" %)
182 (((
183 **mosquitto_pub -h mqtt.thingspeak.com -p 1883 -u dragino -P UZ4NGHKJMKS9WR5E  -i dragino_Client -t channels/399171/publish/A4NNF6G8G63JOIUV -m "field1=23.5&field2=57.5&status=MQTTPUBLISH"**
184 )))
Xiaoling 1.2 185
186 * Need replace:
187
Xiaoling 24.3 188 (% class="box infomessage" %)
189 (((
190 **UZ4NGHKJMKS9WR5E  ~/~/MQTT API
191 399171            ~/~/Channel ID
192 A4NNF6G8G63JOIUV  ~/~/Write API Key**
193 )))
Xiaoling 1.2 194
195
Xiaoling 1.3 196 === 4.6.2 Input the command at the console(LG01 new version:4.3.4) ===
Xiaoling 1.2 197
Xiaoling 25.2 198 1. [[image:image-20220531141150-24.png]](((
Xiaoling 1.2 199 Open this Application.
Xiaoling 25.2 200
201
202
Xiaoling 1.2 203 )))
Xiaoling 27.2 204 1. (((
205 [[image:image-20220531141400-27.png]]
206
Xiaoling 1.2 207 Check the settings.
Xiaoling 27.2 208
209
210
Xiaoling 1.2 211 )))
Xiaoling 28.2 212 1. (((
Xiaoling 29.2 213 [[image:image-20220531141601-30.png]]
214
Xiaoling 1.2 215 input this command.
Xiaoling 27.2 216
217
218
Xiaoling 1.2 219 )))
Xiaoling 28.2 220 1. [[image:image-20220531141515-29.png]](((
Xiaoling 1.2 221 Check the result.
Xiaoling 28.2 222
223
224
Xiaoling 1.2 225 )))
226
Xiaoling 1.3 227 == 4.7 Updata data to Server(Through MQTT) ==
Xiaoling 1.2 228
229 * This version of Sketch implements these features:
230
231 1. Read the LG01 configuration information from Linux.
232 1. Receive the LoRa node data and store the data in the /tmp/iot/channels
233 1. Send reply after then receive LoRa node data.
234 1. Sketch will write active content to /tmp/iot/status periodically (every 5 minutes).(Watchdog feature)
235
Xiaoling 30.2 236 1. [[image:image-20220531141656-31.png]](((
Xiaoling 1.2 237 Open the sketch [[MQTT_Simple_Server>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/LoRa/MQTT_Simple_Server]].(Board:Dragino Yun + UNO or LG01/OLG01,Port:Network ports.)and upload.
Xiaoling 30.2 238
239
240
Xiaoling 1.2 241 )))
Xiaoling 31.2 242 1. [[image:image-20220531141800-32.png]](((
Xiaoling 1.2 243 Open Serial monitor.
Xiaoling 31.2 244
245
246
Xiaoling 1.2 247 )))
Xiaoling 32.2 248 1. [[image:image-20220531141842-33.png]](((
Xiaoling 1.2 249 Open the Sketch [[MQTT_Client>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/IoTServer/ThingSpeak/MQTT_Client]]. (Board:Arduino/Genuino Uno.Port:Serial ports.)and upload.
Xiaoling 32.2 250
251
252
Xiaoling 1.2 253 )))
Xiaoling 33.2 254 1. [[image:image-20220531141927-34.png]](((
Xiaoling 1.2 255 Open Serial monitor.
Xiaoling 33.2 256
257
258
Xiaoling 1.2 259 )))
260 1. Go to IoT Server to check the result.
261 1. (((
Xiaoling 34.2 262 [[image:image-20220531142023-35.png]]
263
Xiaoling 35.2 264
Xiaoling 34.2 265
Xiaoling 1.2 266 )))
267 1. (((
Xiaoling 35.2 268 [[image:image-20220531142155-36.png]]
Xiaoling 35.3 269
270
271
Xiaoling 1.2 272 )))
273
Xiaoling 1.3 274 = 5. FAQ =
Xiaoling 1.2 275
Xiaoling 1.3 276 == 5.1 Configure to support general mqtt server ==
Xiaoling 1.2 277
278 First, try to run **mosquitto_pub** in Linux console to send a data to MQTT server.
279
280 For example: for ThingSpeak, a MQTT publish command is:
281
Xiaoling 36.2 282 (% class="box infomessage" %)
283 (((
284 **mosquitto_pub -h mqtt.thingspeak.com -p 1883 -u dragino -P QZXTAKE88V3S7O2J  -i dragino_Client -t channels/200893/publish/B9Z0R25QNVEBKIFY -m "field1=34&field2=89&status=MQTTPUBLISH"**
285 )))
Xiaoling 1.2 286
287 What now we need to put in the LG01 is how to combine this command.
288
289 1. LG01 web console -> Sensor -> MQTT
290 1. Choose general Server
Xiaoling 36.2 291 1. [[image:image-20220531142342-37.png]](((
Xiaoling 1.2 292 Refer to your server to fill in.
Xiaoling 36.2 293
294
295
Xiaoling 1.2 296 )))
Xiaoling 37.2 297 1. [[image:image-20220531142447-38.png]](((
Xiaoling 1.2 298 Ex:ThingSpeak Server
Xiaoling 37.2 299
300
Xiaoling 1.2 301 )))
302
303 According to MQTT commands: mosquitto_pub, we need to put
304
305 * server[-h] : mqtt.thingspeak.com
306 * port[-p] : 1883
307 * User Name[-u]: dragino
308 * Password[-P]:QZXTAKE88V3S7O2J
309 * Client ID[-i]: dragino_Client
310 * topic_format[-t]: channels/CHANNEL/publish/WRITE_API
311 * data_format[-m]: DATA&status=MQTTPUBLISH
312
313 In the mqtt script, the upper **CHANNEL** will be replaced by the parameter (remote channel in IoT server). and the **WRITE_API** will be replaced by the settings in write api key. the **DATA** will be replaced by the value stored in the /var/iot/channels/LOCAL_CHANNEL file.
314
315 MQTT script will keep checking the files in /var/iot/channels/ . If it find a match Local channel, then the MQTT script will send out the data of this local channel to a remote channel according to the setting above.
316
317 User can also enable MQTT debug in the LG01 ~-~-> IoT Server settings and run logread in Linux console to see how the mqtt command is compose. below is an example:
318
Xiaoling 38.2 319 [[image:image-20220531142525-39.png]]
Xiaoling 1.2 320
321 MQTT Logread example
322
323
Xiaoling 1.3 324 == 5.2 What is Watchdog feature? ==
Xiaoling 1.2 325
326 LG01 for 4.3.3 version,we have added watchdog feature. In order to avoid the gateway running process will get stuck. So add writing action on every times.
327
Xiaoling 39.2 328 * [[image:image-20220531142558-40.png]](((
Xiaoling 1.2 329 Enable Sensor->Micro-Controller settings
Xiaoling 39.3 330
331
332
Xiaoling 1.2 333 )))
Xiaoling 40.2 334 * [[image:image-20220531142629-41.png]](((
Xiaoling 1.2 335 Open the sketch [[MQTT_Simple_Server>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/LoRa/MQTT_Simple_Server]].(Board:Dragino Yun + UNO or LG01/OLG01,Port:Network ports.)and upload.
Xiaoling 40.2 336
337
338
Xiaoling 1.2 339 )))
Xiaoling 41.2 340 * [[image:image-20220531142659-42.png]](((
Xiaoling 1.2 341 Each time the function loops, it uses the watchdog function once.
Xiaoling 41.2 342
343
344
Xiaoling 1.2 345 )))
Xiaoling 42.2 346 * [[image:image-20220531142720-43.png]](((
Xiaoling 1.2 347 Open SSH and check watchdog result.If the result change constantly,the feature enable successfully.
Xiaoling 42.2 348
349
350
Xiaoling 1.2 351 )))
Xiaoling 43.2 352 * [[image:image-20220531142748-44.png]](((
Xiaoling 1.2 353 If the time doesnt's change,you can refer it to calculate for checking status.
354 )))
355
Xiaoling 44.1 356 (% class="wikigeneratedid" id="H" %)
357