Changes for page MQTT Forward Instruction

Last modified by Kilight Cao on 2024/08/31 16:26

From version < 1.10 >

edited by Xiaoling
on 2022/05/12 16:08

To version < 5.3 >

edited by Xiaoling
on 2022/05/27 13:42

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (1 modified, 0 added, 0 removed)
Attachments (0 modified, 3 added, 0 removed)

Details

Page properties

Content

@@ -7,12 +7,13 @@
  Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse.
++
  == 1.1 Support Devices ==
  This MQTT forward instruction is for below devices:
  * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]]
--* LG01N, OLG01N ((% class="mark" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>url:https://wiki.dragino.com/index.php/Through_MQTT_to_upload_data]])
++* LG01N, OLG01N ((% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>url:https://wiki.dragino.com/index.php/Through_MQTT_to_upload_data]])
  * LG02, OLG02
  * LG308, DLOS8
  * LPS8
@@ -19,7 +19,6 @@
  * LIG16
  * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support)
--
  = 2. Firmware Change Log for MQTT feature =
  (((
@@ -29,7 +29,6 @@
  * LG02_LG08-5.3.1580178039
  ** Initiate version
--
  = 3. MQTT forward operating principle =
  == 3.1 Network Structure ==
@@ -39,7 +39,7 @@
  * 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.
  * 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,
--[[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png||height="348" width="600"]]
++[[image:image-20220527133547-1.png]]
  General MQTT structure
@@ -57,7 +57,7 @@
  The data flow works as below diagram.
  )))
--[[~[~[image:https://wiki.dragino.com/images/thumb/2/2a/MQTT_Forward_2.png/600px-MQTT_Forward_2.png~|~|height="355" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_2.png]]
++[[image:image-20220527134000-2.png]]
  (((
  Upstream path
@@ -79,7 +79,7 @@
  Below are the data flow for downstream.
  )))
--[[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png||height="368" width="600"]]
++[[image:image-20220527134038-3.png]]
  Downstream path
@@ -89,7 +89,9 @@
  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
  (((
--Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros.
++Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
++
++
  )))
  === 3.3.1 -t topic macro ===
@@ -139,8 +139,7 @@
  root@dragino-1ec39c:~~# mosquitto_pub ~-~-help
  mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit.
  mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4.
--
--Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
++\\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL}
                       {-f file | -l | -n | -m message}
                       [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]
                       [-A bind_address]
@@ -158,8 +158,7 @@
                       [~-~-property command identifier value]
                       [-D command identifier value]
         mosquitto_pub ~-~-help
--
---A : bind the outgoing socket to this host/ip address. Use to control which interface
++\\-A : bind the outgoing socket to this host/ip address. Use to control which interface
        the client communicates over.
  -d : enable debug messages.
  -D : Define MQTT v5 properties. See the documentation for more details.
@@ -215,48 +215,42 @@
  ~-~-proxy : SOCKS5 proxy URL of the form:
             socks5h:~/~/[username[:password]@]hostname[:port]
             Only "none" and "username" authentication is supported.
--
--See https:~/~/mosquitto.org/ for more information.
++\\See https:~/~/mosquitto.org/ for more information.
  )))
++(((
  and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines:
++)))
  (% class="box" %)
  (((
  # Call MQTT Publish command
--
--# 1. Case with User, Password and Client ID present  (e.g. Azure)
++\\# 1. Case with User, Password and Client ID present  (e.g. Azure)
  if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
  case="1"
  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user -P "$pass" $C $cafile $PUB_FLAG "$mqtt_data"
--
--# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
++\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS)
  elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then
  case="2"
  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic ~-~-cert $cert ~-~-key $key $C $cafile $PUB_FLAG "$mqtt_data"
--
--# 3. Case with no User, Certificate or ClientID present
++\\# 3. Case with no User, Certificate or ClientID present
  elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then
  case="3"
  mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data"
--
--# 4. Case with no User, Certificate, but with ClientID present
++\\# 4. Case with no User, Certificate, but with ClientID present
  elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then
  case="4"
  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data"
--
--# 5. Case with User and ClientID present, but no Password and no Certificate present
++\\# 5. Case with User and ClientID present, but no Password and no Certificate present
  elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then
  case="5"
  mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data"
--
--# 6. Case with User and Password present, but no ClientID and no Certificate present
++\\# 6. Case with User and Password present, but no ClientID and no Certificate present
  elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then
  case="6"
  mosquitto_pub $D -h $server -p $port -q $pub_qos  -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data"
--
--# 0. Else - invalid parameters, just log
++\\# 0. Else - invalid parameters, just log
  else
  case="Invalid parameters"
  logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
@@ -274,7 +274,9 @@
  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.
++(((
  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.
++)))
  [[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png||height="201" width="600"]]
@@ -300,7 +300,7 @@
  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
--For Upstream
++(% class="mark" %)**For Upstream**
  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
@@ -313,7 +313,7 @@
  mosquitto_pub
--For Downstream
++(% class="mark" %)**For Downstream**
  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
@@ -326,13 +326,17 @@
  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
--Go to Dragino Menu ~-~-> MQTT Client
++(((
++Go to (% class="mark" %)**Dragino Menu ~-~-> MQTT Client**
++)))
  [[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]]
  go to mqtt configure menu
--Select Forward to MQTT server. 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.
++(((
++Select **Forward to MQTT server**. (% class="mark" %)**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.
++)))
  [[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png||height="240" width="600"]]
@@ -343,30 +343,41 @@
  Below screenshot is same as the publish command:
--{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
--//where the CLIENTID, CHANNEL & DATA are macro. represent for
--//CLIENTID: dragino-1b7060
--//CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
--//DATA: The data stores in /var/iot/channels/
--}}}
++(% class="box" %)
++(((
++mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
++~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for
++~/~/CLIENTID: dragino-1b7060
++~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456
++~/~/DATA: The data stores in /var/iot/channels/
++)))
  [[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]]
  MQTT Publish configure
++
  [[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png||height="544" width="600"]]
  MQTT Channel settings
++(((
  For example, if we put a data(temp=46) on the file /var/iot/channels/4567, because 4567 match the remote channel 78901. the gateway will run this command:
++)))
--{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
--}}}
++(% class="box" %)
++(((
++mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46
++)))
++(((
  to MQTT broker.
++)))
++(((
  Below is a simulation to put this data to active the MQTT publish.
++)))
  [[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png||height="308" width="600"]]
@@ -377,8 +377,10 @@
  Below screen shot equal to this subscribe command:
--{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
--}}}
++(% class="box" %)
++(((
++mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command.
++)))
  [[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]]
@@ -385,7 +385,9 @@
  MQTT Subscribe
++(((
  When MQTT broker receive a update on this topic, the gateway will get the update and use LoRa radio to broadcast this message. The LoRa parameters used for update is:
++)))
  [[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png||height="300" width="600"]]
@@ -405,13 +405,21 @@
  === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
++(((
  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.
++)))
++(((
  The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]]
++)))
++(((
  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.
++)))
++(((
  What does the Arduino Sketch do? The Arduino Sketch will:
++)))
  * 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).
  * Downstream: Listening broadcast message from gateway, and print it in console.
@@ -435,25 +435,33 @@
  === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
--Since firmware LG02_LG08~-~-build-v5.3.1585192026-20200326-1109, Dragino LoRaWAN gateways support the communication to LoRaWAN 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.
++(((
++Since firmware (% class="mark" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% class="mark" %)**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.
++)))
--When use test this feature, please use the version higher then : LG02_LG08~-~-build-v5.4.1593400722-20200629-1120, in this version, the upload format is changed and readable, which is easier for integration.
++(((
++When use test this feature, please use the version higher then : (% class="mark" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration.
++(% class="mark" %)**Video Instruction**(%%):[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
++)))
++(((
++**Step 1**: Refer [[Communicate with ABP End Node>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node]] to know how to set up LG308 to work with LoRaWAN End node.
++)))
++(((
++**Step 2**: Make sure your Radio settings match the End Node settings.
++)))
--Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
--
--
--Step 1: Refer [[Communicate with ABP End Node>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node]] to know how to set up LG308 to work with LoRaWAN End node.
--
--Step 2: Make sure your Radio settings match the End Node settings.
--
  [[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]]
  Use Same Frequency Band as End Node
--Step 3: Set up publish format and MQTT channel. The LG308 will store the Data from End node in HEX format in the file. And we need to config the format to META
++(((
++(((
++**Step 3**: Set up publish format and MQTT channel. The LG308 will store the Data from End node in HEX format in the file. And we need to config the format to META
++)))
++)))
  [[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]]
@@ -460,7 +460,7 @@
  Publish mush use META as data format for LG308
--Step 4: Map the Device Address to Remote ID in MQTT server.
++**Step 4**: Map the Device Address to Remote ID in MQTT server.
  [[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]]
@@ -467,7 +467,7 @@
  Map Dev Addr to remote ID
--Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
++**Step 5: Upstream**: Save the change, we can see the log info via "sytem log", End Node and MQTT Server
  [[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]]
@@ -481,45 +481,45 @@
  LHT65 Decoder
--Step 6: Set up subscribe: Subscribe a topci for downstream.
++**Step 6: Set up subscribe:** Subscribe a topci for downstream.
++
  [[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]]
  Subscribe to a topic
--Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
++**Step 7**: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
  [[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]]
  Downstream Flow
--Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node#Downstream]]
++(% class="mark" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node#Downstream]]**
  = 5. Example For Different MQTT Servers =
--(% style="width:715.222px" %)
--|=(% style="width: 238px;" %)(((
--[[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png||alt="ThingSpeak1.png" height="98" width="200"]]
++(% style="width:731.222px" %)
++|=(% style="width: 270px;" %)(((
++[[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png||alt="ThingSpeak1.png" height="114" width="233"]]
--=== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] ===
++== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] ==
  [[Examples>>url:https://wiki.dragino.com/index.php/ThingSpeak_Examples]]
--)))|=(% style="width: 235px;" %)(((
--[[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height="58" width="200"]]
++)))|=(% style="width: 242px;" %)(((
++[[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height="65" width="223"]]
--=== [[乐联网平台>>url:https://www.lewei50.com/]] ===
++== [[乐联网平台>>url:https://www.lewei50.com/]] ==
--
  [[lewei Example>>url:https://wiki.dragino.com/index.php/Lewei_Example_mqtt]]
--)))|=(% style="width: 239px;" %)(((
--[[image:https://wiki.dragino.com/images/thumb/a/aa/AWS-IOT.png/200px-AWS-IOT.png||alt="AWS-IOT.png" height="122" width="200"]]
++)))|=(% style="width: 214px;" %)(((
++[[image:https://wiki.dragino.com/images/thumb/a/aa/AWS-IOT.png/200px-AWS-IOT.png||alt="AWS-IOT.png" height="112" width="183"]]
--=== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] ===
++== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] ==
  [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]]

image-20220527133547-1.png

Author

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

Size

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

Content

image-20220527134000-2.png

Author

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

Size

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

Content

image-20220527134038-3.png

Author

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

Size

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

Content

Changes for page MQTT Forward Instruction

Summary

Details

Applications

Navigation