Changes for page MQTT Forward Instruction

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

From version < 49.2 >

edited by Xiaoling
on 2022/08/09 16:18

To version < 44.1 >

edited by Kilight Cao
on 2022/06/13 19:35

Change comment: There is no comment for this version

Raw
Rendered

Summary

Page properties (2 modified, 0 added, 0 removed)
Attachments (0 modified, 0 added, 1 removed)
- image-20220714155901-1.png

Details

Page properties

Author

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

Content

@@ -1,18 +1,15 @@
--**~     Table of Contents：**
++**~     Contents：**
  {{toc/}}
--= 1.  Introduction =
++= 1. Introduction =
--
  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 ==
--== 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/]]
@@ -24,11 +24,8 @@
  * 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 =
--
--= 2.  Firmware Change Log for MQTT feature =
--
--
  (((
  This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware.
  )))
@@ -37,43 +37,31 @@
  ** Initiate version
++= 3. MQTT forward operating principle =
++== 3.1 Network Structure ==
--= 3.  MQTT forward operating principle =
--
--
--== 3.1  Network Structure ==
--
--
  Below shows the network structure for MQTT forwarding.
--* **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.
++* 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:image-20220527133547-1.png]]
  General MQTT structure
++== 3.2 How sensor data is forwarded ==
--== 3.2  How sensor data is forwarded ==
--
--
  In this MQTT forward feature, the key point is how the gateway process the sensor data.
++=== 3.2.1 Upstream ===
--=== 3.2.1  Upstream ===
--
--
  Assume there are two sensor nodes, their ID are Node1 ID: 6734 , Node2 ID: 7456. In the remote MQTT broker there are two topics: Topic1: /channel/765800, Topic2: /channel/367860. We can set up in the gateway to map Node1 to Topic1 and Node2 to Topic2. So when there is a sensor data from Node1, the gateway will forward the data to Topic1, when there is sensor data from Node2, the gateway will forward to Topic2.
  (((
  The data flow works as below diagram.
--
--
  )))
  [[image:image-20220527134000-2.png]]
@@ -80,29 +80,22 @@
  (((
  Upstream path
--
--
  )))
  (((
--(% style="color:red" %)**Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>**
++Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
  )))
  (((
--
--
  )))
--=== 3.2.2  Downstream ===
++=== 3.2.2 Downstream ===
--
  The gateway subscribes to a topic of the remote MQTT broker topic. When there is some one publish a value on this topic. The gateway will get it and broadcast to local LoRa Network.
  (((
  Below are the data flow for downstream.
--
--
  )))
  [[image:image-20220527134038-3.png]]
@@ -110,22 +110,18 @@
  Downstream path
++== 3.3 Macro Definition ==
--== 3.3  Macro Definition ==
--
--
  The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish.
  (((
  Currently the (% style="color:#4f81bd" %)**-t (topic)**(%%) and (% style="color:#4f81bd" %)**-m (message)**(%%) support Macros.
--
  )))
--=== 3.3.1  -t topic macro ===
++=== 3.3.1 -t topic macro ===
--
  * CHANNEL: Remote Channel ID
  * CLIENTID: Client ID , Same as -i
  * WRITE_API: Remote Channel Write API
@@ -133,11 +133,8 @@
  * HOSTNAME: Device Hostname
++=== 3.3.2 -m message macro ===
--
--=== 3.3.2  -m message macro ===
--
--
  * HOSTNAME: Device Hostname
  * CHANNEL: Remote Channel ID
  * DATA: Sensor Data without time stamp and rssi
@@ -145,17 +145,14 @@
  * JSON: Convert META to json format.
++=== 3.3.3 Example for Macro ===
--
--=== 3.3.3  Example for Macro ===
--
--
  [[image:image-20220527134251-4.png]]
  MQTT Publish configure
--**Above screen shots shows below format:**
++Above screen shots shows below format:
  * -t: CLIENTID/CHANNEL/data
  * -m: DATA
@@ -172,10 +172,8 @@
  )))
++== 3.4 Modify the MQTT to support more options ==
--== 3.4  Modify the MQTT to support more options ==
--
--
  The MQTT Client Utility used in Dragino is **mosquitto_pub** and **mosquitto_sub**. User can add more options to the mqtt commands. User can check the valid options by command mosquitto_pub ~-~-help. as below:
  (% class="box" %)
@@ -193,9 +193,9 @@
                       [-u username [-P password]]
                       [~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]
                       [{~-~-cafile file | ~-~-capath dir} [~-~-cert file] [~-~-key file]
--                     [~-~-ciphers ciphers] [~-~-insecure]
--                     [~-~-tls-alpn protocol]
--                     [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
++                       [~-~-ciphers ciphers] [~-~-insecure]
++                       [~-~-tls-alpn protocol]
++                       [~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]
                       [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
                       [~-~-proxy socks-url]
                       [~-~-property command identifier value]
@@ -300,20 +300,15 @@
  )))
++= 4. Example to communicate to a simple MQTT server =
--= 4.  Example to communicate to a simple MQTT server =
++== 4.1 Overview ==
--
--== 4.1  Overview ==
--
--
  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/]].
++== 4.2 Simulate via MQTT.fx utility ==
--== 4.2  Simulate via MQTT.fx utility ==
--
--
  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.
  (((
@@ -339,16 +339,14 @@
  Downstream: Subscribe a topic to get downstream
++== 4.3 Simulate via Dragino Command Line ==
--== 4.3  Simulate via Dragino Command Line ==
--
--
  For first try of MQTT connection, simulate via command line is recommend, there are many servers / connection type for MQTT. They are using different connection parameters. Simulating the connection via command line will help us rapidly connect to server and debug.
  In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection.
--(% style="color:blue" %)**For Upstream**
++(% style="color:#4f81bd" %)**For Upstream**
  command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]]
@@ -361,9 +361,8 @@
  mosquitto_pub
++(% style="color:#4f81bd" %)**For Downstream**
--(% style="color:blue" %)**For Downstream**
--
  Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic.
  [[image:image-20220527135440-10.png]]
@@ -371,10 +371,8 @@
  mosquitto_sub
++== 4.4 Configure Dragino UI for MQTT connection ==
--== 4.4  Configure Dragino UI for MQTT connection ==
--
--
  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
  (((
@@ -381,7 +381,7 @@
  Go to (% style="color:#4f81bd" %)**Dragino Menu ~-~-> MQTT Client**
  )))
--[[image:image-20220714155901-1.png]]
++[[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
@@ -395,28 +395,24 @@
  forward to MQTT
++=== 4.4.1 Configure the MQTT Client for Upstream ===
--=== 4.4.1  Configure the MQTT Client for Upstream ===
++Below screenshot is same as the publish command:
--
--**Below screenshot is same as the publish command:**
--
  (% class="box" %)
  (((
--**mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA
++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/**
++~/~/DATA: The data stores in /var/iot/channels/
  )))
--
  [[image:image-20220527135828-12.png]]
  MQTT Publish configure
--
  [[image:image-20220527135929-13.png]]
  MQTT Channel settings
@@ -445,10 +445,8 @@
  MQTT Publish
++=== 4.4.2 Configure the MQTT Client for Downstream ===
--=== 4.4.2  Configure the MQTT Client for Downstream ===
--
--
  Below screen shot equal to this subscribe command:
  (% class="box" %)
@@ -477,16 +477,13 @@
  downstream simulation
--== 4.5  Add LoRa support to communicate with remote sensor ==
++== 4.5 Add LoRa support to communicate with remote sensor ==
--
  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.
++=== 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 ===
--=== 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.
  )))
@@ -497,8 +497,6 @@
  (((
  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.
--
--
  )))
  (((
@@ -509,8 +509,6 @@
  * Downstream: Listening broadcast message from gateway, and print it in console.
  * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below:
--
--
  [[image:image-20220527140354-18.png]]
  LoRa Parameter should match
@@ -530,10 +530,8 @@
  Downstream Data Flow
++=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
--=== 4.5.2  Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
--
--
  (((
  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.
  )))
@@ -540,17 +540,15 @@
  (((
  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.
--
--
--(% style="color:blue" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
++(% style="color:#4f81bd" %)**Video Instruction**(%%): (% style="color:blue" %)[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
  )))
  (((
--(% 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.
++(% style="color:#4f81bd" %)**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.
  )))
  (((
--(% style="color:blue" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
++(% style="color:#4f81bd" %)**Step 2**(%%): Make sure your Radio settings match the End Node settings.
  )))
  [[image:image-20220527141235-21.png]]
@@ -560,7 +560,7 @@
  (((
  (((
--(% 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.
++(% style="color:#4f81bd" %)**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.
  )))
  )))
@@ -568,13 +568,13 @@
--(% style="color:blue" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
++(% style="color:#4f81bd" %)**Step 4**(%%): Map the Device Address to Remote ID in MQTT server.
  [[image:image-20220613190635-2.png]]
--(% style="color:blue" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
++(% style="color:#4f81bd" %)**Step 5: Upstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server
  [[image:image-20220527141843-24.png]]
@@ -593,19 +593,19 @@
--(% style="color:blue" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
++(% style="color:#4f81bd" %)**Step 6: Set up subscribe**(%%)**:** Subscribe a topci for downstream.
  [[image:image-20220613191426-5.png]]
--(% style="color:blue" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
++(% style="color:#4f81bd" %)**Step 7: Downstream**(%%): Save the change, we can see the log info via "sytem log", End Node and MQTT Server.
  [[image:image-20220527142239-28.png]]
--=== 4.5.3  MQTT Downstream format ===
++=== MQTT Downstream format ===
  mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload**"
@@ -612,7 +612,7 @@
  (% class="box infomessage" %)
  (((
--**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"**
++mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello"
  )))
  mosquitto_pub -h $server_address -p $server_port -t $Client_ID -m "**dev_addr,imme/time,txt/hex,payload,txpw,txbw,SF,frequency,rxwindow**"
@@ -619,7 +619,7 @@
  (% class="box infomessage" %)
  (((
--**mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2"**
++mosquitto_pub -h 10.130.2.192 -p 1883 -t dragino-1d25dc/ -m "260211D,time,txt,hello,20,1,SF12,923300000,2 > /var/iot/push/test"
  )))
  Or use [[MQTT.fx>>https://mqttfx.jensd.de/index.php/download]]
@@ -626,24 +626,17 @@
  [[image:image-20220613192816-6.png||height="440" width="1056"]]
--
  (% 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"]]**
--
  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]]
++= 5. How to Debug =
--
--= 5.  How to Debug =
--
--
  User can login the gateway's console and run (% style="color:#4f81bd" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.
++= 6. How to ask for Support =
--= 6.  How to ask for Support =
--
--
  If a user still not have trouble making it works. please send a mail to support@dragino.com with the below info:
  * Detail of your LoRaWAN end node.

image-20220714155901-1.png

Author

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

Size

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

Content

Changes for page MQTT Forward Instruction

Summary

Details

Applications

Navigation