Wiki source code of Through MQTT to upload data

Version 43.3 by Xiaoling on 2022/05/31 14:29

version	line-number	content
1.4	1	{{toc/}}
1.1	2
1.4	3
	4
	5
1.2	6	= 1. What is MQTT API? =
1.1	7
1.5	8	{{{MQTT is a publish/subscribe model that runs over TCP/IP sockets or WebSockets. MQTT over WebSockets can be secured with SSL.}}}
1.1	9
	10
1.2	11	= 2. MQTT Features =
1.1	12
1.2	13	The MQTT protocol runs on TCP / IP or other network protocols and provides an ordered, lossless, bidirectional connection. Features include:
1.1	14
1.2	15	* The publish / subscribe messaging pattern used, which provides one-to-many messaging for decoupling from the application.
	16	* Message-masking mechanism for payload content.
	17	* There are three Quality of Service (QoS) for transmitting messages:
	18	* At most, messages of this level may be lost or duplicated, and message postings depend on the underlying TCP / IP network. That is: <= 1
	19	* At one time, this level will ensure that the message arrives, but the message may be repeated. That is:> = 1
	20	* 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
	21	* Notification mechanism, notify the transmission of both sides when an exception occurs
1.1	22
	23
1.2	24	= 3. What does this example shows? How it works? =
1.1	25
43.3	26	(((
1.2	27	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.
43.3	28	)))
1.1	29
3.2	30	[[image:image-20220531135402-1.png]]
1.1	31
1.2	32	Message Queuing Telemetry Transport
1.1	33
	34
3.2	35	[[image:image-20220531135449-2.png]]
	36
1.2	37	working principle
1.1	38
3.2	39
4.2	40	[[image:image-20220531135521-3.png]]
1.2	41
43.3	42	(((
1.2	43	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.
43.3	44	)))
1.2	45
4.2	46
	47
5.2	48	[[image:image-20220531135607-4.png]]
1.2	49
43.3	50	(((
1.2	51	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.
43.3	52	)))
1.2	53
43.3	54	(((
1.2	55	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.
43.3	56	)))
1.2	57
43.3	58	(((
1.2	59	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/]] .
43.3	60	)))
1.2	61
	62
	63	= 4. Preparation =
	64
	65	== 4.1 Hardware ==
	66
6.2	67	1. [[image:image-20220531135650-5.png]](((
1.2	68	Listening on the LoRa wireless channel, while there is new LoRa packet arrives, parse it and send out to IoT Server.
6.2	69
	70
	71
1.2	72	)))
7.2	73	1. [[image:image-20220531135750-6.png]](((
1.2	74	The LoRa End node keeps getting temperature and humidity from the sensor and sends out via LoRa periodically.
	75	)))
	76
	77
	78	== 4.2 Software ==
	79
	80	1. [[4.3.4 version>>url:http://www.dragino.com/downloads/index.php?dir=motherboards/ms14/Firmware/IoT/]]
	81	1. [[MQTT_Client>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/IoTServer/ThingSpeak/MQTT_Client]]
	82	1. [[MQTT_Simple_Server MQTT_Simeple_Server>>url:https://github.com/dragino/Arduino-Profile-Examples/tree/master/libraries/Dragino/examples/LoRa/MQTT_Simple_Server]]
	83	1. [[DHTlib>>url:https://github.com/goodcheney/Lora/blob/patch-1/Lora%20Shield/Examples/DHTlib.zip]]
	84
	85
	86	== 4.3 Server(For example) ==
	87
	88	* [[ThingSpeak>>url:https://thingspeak.com/]]
	89
	90
1.3	91	== 4.4 Configure IoT Server ==
1.2	92
	93	* Need this keys:
	94
9.2	95	1. [[image:image-20220531140054-8.png]](((
1.2	96	Channel ID,Write API Key
8.3	97
	98
	99
1.2	100	)))
14.2	101	1. [[image:image-20220531140326-13.png]](((
1.2	102	Account->My Profile,MQTT API Key
10.2	103
	104
	105
1.2	106	)))
	107	1. (((
14.2	108	[[image:image-20220531140304-12.png]]
1.2	109	)))
	110
	111
1.3	112	== 4.5 Configure LG01 settings ==
1.2	113
	114	Tips:Please confirm that your LG01 version is 4.3.3.
	115
14.2	116	[[image:image-20220531140248-11.png]]
1.2	117
19.3	118	Overview
1.2	119
14.3	120
	121
15.2	122	[[image:image-20220531140425-14.png]]
1.2	123
19.3	124	Senosor->IOT Server
1.2	125
15.2	126
16.2	127	[[image:image-20220531140458-15.png]]
1.2	128
19.3	129	MQTT->Configure MQTT Server
1.2	130
16.2	131
	132
17.2	133	[[image:image-20220531140538-16.png]]
1.2	134
19.3	135	MQTT->MQTT Channel
1.2	136
17.2	137
	138
18.2	139	[[image:image-20220531140611-17.png]]
1.2	140
19.3	141	Sensor->LoRa/LoraWAN
1.2	142
18.2	143
	144
19.2	145	[[image:image-20220531140651-18.png]]
1.2	146
19.3	147	Configure network access.Network->Internet Access
1.2	148
	149
1.3	150	== 4.6 Try MQTT API call with LG01 Linux command ==
1.2	151
1.3	152	=== 4.6.1 Input the command at the console ===
1.2	153
21.2	154	1. [[image:image-20220531140811-19.png]](((
1.2	155	Open this Application.
21.2	156
	157
1.2	158	)))
21.2	159	1. [[image:image-20220531140842-20.png]](((
1.2	160	Input passward(dragino).After into the console.
21.2	161
	162
1.2	163	)))
22.2	164	1. [[image:image-20220531140915-21.png]](((
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
22.3	166
	167
1.2	168	)))
23.2	169	1. [[image:image-20220531140955-22.png]](((
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.
23.2	171
	172
	173
1.2	174	)))
24.2	175	1. [[image:image-20220531141026-23.png]](((
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
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	)))
1.2	185
	186	* Need replace:
	187
24.3	188	(% class="box infomessage" %)
	189	(((
	190	**UZ4NGHKJMKS9WR5E ~/~/MQTT API
	191	399171 ~/~/Channel ID
	192	A4NNF6G8G63JOIUV ~/~/Write API Key**
	193	)))
1.2	194
	195
1.3	196	=== 4.6.2 Input the command at the console(LG01 new version:4.3.4) ===
1.2	197
25.2	198	1. [[image:image-20220531141150-24.png]](((
1.2	199	Open this Application.
25.2	200
	201
	202
1.2	203	)))
27.2	204	1. (((
	205	[[image:image-20220531141400-27.png]]
	206
1.2	207	Check the settings.
27.2	208
	209
	210
1.2	211	)))
28.2	212	1. (((
29.2	213	[[image:image-20220531141601-30.png]]
	214
1.2	215	input this command.
27.2	216
	217
	218
1.2	219	)))
28.2	220	1. [[image:image-20220531141515-29.png]](((
1.2	221	Check the result.
28.2	222
	223
	224
1.2	225	)))
	226
1.3	227	== 4.7 Updata data to Server(Through MQTT) ==
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
	236
30.2	237	1. [[image:image-20220531141656-31.png]](((
1.2	238	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.
30.2	239
	240
	241
1.2	242	)))
31.2	243	1. [[image:image-20220531141800-32.png]](((
1.2	244	Open Serial monitor.
31.2	245
	246
	247
1.2	248	)))
32.2	249	1. [[image:image-20220531141842-33.png]](((
1.2	250	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.
32.2	251
	252
	253
1.2	254	)))
33.2	255	1. [[image:image-20220531141927-34.png]](((
1.2	256	Open Serial monitor.
33.2	257
	258
	259
1.2	260	)))
	261	1. Go to IoT Server to check the result.
	262	1. (((
34.2	263	[[image:image-20220531142023-35.png]]
	264
35.2	265
34.2	266
1.2	267	)))
	268	1. (((
35.2	269	[[image:image-20220531142155-36.png]]
35.3	270
	271
	272
1.2	273	)))
	274
1.3	275	= 5. FAQ =
1.2	276
1.3	277	== 5.1 Configure to support general mqtt server ==
1.2	278
	279	First, try to run mosquitto_pub in Linux console to send a data to MQTT server.
	280
	281	For example: for ThingSpeak, a MQTT publish command is:
	282
36.2	283	(% class="box infomessage" %)
	284	(((
	285	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"
	286	)))
1.2	287
	288	What now we need to put in the LG01 is how to combine this command.
	289
	290	1. LG01 web console -> Sensor -> MQTT
	291	1. Choose general Server
36.2	292	1. [[image:image-20220531142342-37.png]](((
1.2	293	Refer to your server to fill in.
36.2	294
	295
	296
1.2	297	)))
37.2	298	1. [[image:image-20220531142447-38.png]](((
1.2	299	Ex:ThingSpeak Server
37.2	300
	301
1.2	302	)))
	303
	304	According to MQTT commands: mosquitto_pub, we need to put
	305
	306	* server[-h] : mqtt.thingspeak.com
	307	* port[-p] : 1883
	308	* User Name[-u]: dragino
	309	* Password[-P]:QZXTAKE88V3S7O2J
	310	* Client ID[-i]: dragino_Client
	311	* topic_format[-t]: channels/CHANNEL/publish/WRITE_API
	312	* data_format[-m]: DATA&status=MQTTPUBLISH
	313
	314	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.
	315
	316	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.
	317
	318	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:
	319
38.2	320	[[image:image-20220531142525-39.png]]
1.2	321
	322	MQTT Logread example
	323
	324
1.3	325	== 5.2 What is Watchdog feature? ==
1.2	326
	327	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.
	328
39.2	329	* [[image:image-20220531142558-40.png]](((
1.2	330	Enable Sensor->Micro-Controller settings
39.3	331
	332
	333
1.2	334	)))
40.2	335	* [[image:image-20220531142629-41.png]](((
1.2	336	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.
40.2	337
	338
	339
1.2	340	)))
41.2	341	* [[image:image-20220531142659-42.png]](((
1.2	342	Each time the function loops, it uses the watchdog function once.
41.2	343
	344
	345
1.2	346	)))
42.2	347	* [[image:image-20220531142720-43.png]](((
1.2	348	Open SSH and check watchdog result.If the result change constantly,the feature enable successfully.
42.2	349
	350
	351
1.2	352	)))
43.2	353	* [[image:image-20220531142748-44.png]](((
1.2	354	If the time doesnt's change,you can refer it to calculate for checking status.
	355	)))
	356
	357	== ==

Wiki source code of Through MQTT to upload data

Applications

Navigation