Wiki source code of Through MQTT to upload data

Version 44.6 by Xiaoling on 2022/05/31 14:33

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

Wiki source code of Through MQTT to upload data

Applications

Navigation