Changes for page MQTT Forward Instruction

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

From version < 1.9 >

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

To version < 1.2 >

edited by Xiaoling
on 2022/05/12 15:37

Change comment: There is no comment for this version

Raw
Rendered

Summary

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

Details

Page properties

Content

@@ -1,18 +1,13 @@
--**~     Contents：**
++= INTRODUCTION =
--{{toc/}}
--
--
--= 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 ==
++== 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 (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
@@ -20,79 +20,65 @@
  * 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 =
++\\
--(((
++= 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.
--)))
  * LG02_LG08-5.3.1580178039
  ** Initiate version
--= 3. MQTT forward operating principle =
++\\
--== 3.1 Network Structure ==
++= MQTT forward operating principle =
++== 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,
--[[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png||height="348" width="600"]]
++[[~[~[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png~|~|height="348" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_1.png]]
  General MQTT structure
++== 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.
++=== 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: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]]
--(((
  Upstream path
--)))
--(((
  Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span>
--)))
--(((
--
--)))
++=== 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:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png||height="368" width="600"]]
++[[~[~[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png~|~|height="368" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_3.png]]
  Downstream path
--== 3.3 Macro Definition ==
++== Macro Definition ==
  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 -t (topic) and -m (message) support Macros.
--=== 3.3.1 -t topic macro ===
++=== -t topic macro ===
  * CHANNEL: Remote Channel ID
  * CLIENTID: Client ID , Same as -i
@@ -100,7 +100,7 @@
  * USERNAME: User ID (-u)
  * HOSTNAME: Device Hostname
--=== 3.3.2 -m message macro ===
++=== -m message macro ===
  * HOSTNAME: Device Hostname
  * CHANNEL: Remote Channel ID
@@ -108,9 +108,9 @@
  * META: Completely sensor data with time stamp and rssi
  * JSON: Convert META to json format.
--=== 3.3.3 Example for Macro ===
++=== Example for Macro ===
--[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]]
++[[~[~[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_9.png]]
  MQTT Publish configure
@@ -121,156 +121,151 @@
  When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below:
--[[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png||height="325" width="600"]]
++[[~[~[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png~|~|height="325" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_20.png]]
  Sensor Data
--(((
--According to above macro. Gateway will publish (% class="mark" %)**field1=22.0&field2=49.0**(%%) to topic: (% class="mark" %)**dragino-1b7060/78901/data**(%%), where 78901 is the remote channel for this node ID.
--)))
++According to above macro. Gateway will publish field1=22.0&field2=49.0 to topic: dragino-1b7060/78901/data, where 78901 is the remote channel for this node ID.
--== 3.4 Modify the MQTT to support more options ==
++\\
++
++== 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" %)
--(((
--root@dragino-1ec39c:~~# mosquitto_pub ~-~-help
++{{{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}
                       {-f file | -l | -n | -m message}
--                     [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time]
++                     [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time]
                       [-A bind_address]
                       [-i id] [-I id_prefix]
--                     [-d] [~-~-quiet]
++                     [-d] [--quiet]
                       [-M max_inflight]
                       [-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]]
--                     [~-~-psk hex-key ~-~-psk-identity identity [~-~-ciphers ciphers]]
--                     [~-~-proxy socks-url]
--                     [~-~-property command identifier value]
++                     [--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]]
++                     [--psk hex-key --psk-identity identity [--ciphers ciphers]]
++                     [--proxy socks-url]
++                     [--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
++       mosquitto_pub --help
++
++ -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.
---f : send the contents of a file as the message.
---h : mqtt host to connect to. Defaults to localhost.
---i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.
---I : define the client id as id_prefix appended with the process id. Useful for when the
++ -d : enable debug messages.
++ -D : Define MQTT v5 properties. See the documentation for more details.
++ -f : send the contents of a file as the message.
++ -h : mqtt host to connect to. Defaults to localhost.
++ -i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id.
++ -I : define the client id as id_prefix appended with the process id. Useful for when the
        broker is using the clientid_prefixes option.
---k : keep alive in seconds for this client. Defaults to 60.
---L : specify user, password, hostname, port and topic as a URL in the form:
--      mqtt(s):~/~/[username[:password]@]host[:port]/topic
---l : read messages from stdin, sending a separate message for each line.
---m : message payload to send.
---M : the maximum inflight messages for QoS 1/2..
---n : send a null (zero length) message.
---p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.
---P : provide a password
---q : quality of service level to use for all messages. Defaults to 0.
---r : message should be retained.
---s : read message from stdin, sending the entire input as a message.
---t : mqtt topic to publish to.
---u : provide a username
---V : specify the version of the MQTT protocol to use when connecting.
++ -k : keep alive in seconds for this client. Defaults to 60.
++ -L : specify user, password, hostname, port and topic as a URL in the form:
++      mqtt(s)://[username[:password]@]host[:port]/topic
++ -l : read messages from stdin, sending a separate message for each line.
++ -m : message payload to send.
++ -M : the maximum inflight messages for QoS 1/2..
++ -n : send a null (zero length) message.
++ -p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS.
++ -P : provide a password
++ -q : quality of service level to use for all messages. Defaults to 0.
++ -r : message should be retained.
++ -s : read message from stdin, sending the entire input as a message.
++ -t : mqtt topic to publish to.
++ -u : provide a username
++ -V : specify the version of the MQTT protocol to use when connecting.
        Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311.
--~-~-help : display this message.
--~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
--~-~-repeat-delay : if using ~-~-repeat, wait time seconds between publishes. Defaults to 0.
--~-~-quiet : (% class="mark" %)don't print error messages.
--~-~-will-payload : payload for the client Will, which is sent by the broker in case of
++ --help : display this message.
++ --repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.
++ --repeat-delay : if using --repeat, wait time seconds between publishes. Defaults to 0.
++ --quiet : don't print error messages.
++ --will-payload : payload for the client Will, which is sent by the broker in case of
                    unexpected disconnection. If not given and will-topic is set, a zero
                    length message will be sent.
--~-~-will-qos : QoS level for the client Will.
--~-~-will-retain : if given, make the client Will retained.
--~-~-will-topic : the topic on which to publish the client Will.
--~-~-cafile : path to a file containing trusted CA certificates to enable encrypted
++ --will-qos : QoS level for the client Will.
++ --will-retain : if given, make the client Will retained.
++ --will-topic : the topic on which to publish the client Will.
++ --cafile : path to a file containing trusted CA certificates to enable encrypted
              communication.
--~-~-capath : path to a directory containing trusted CA certificates to enable encrypted
++ --capath : path to a directory containing trusted CA certificates to enable encrypted
              communication.
--~-~-cert : client certificate for authentication, if required by server.
--~-~-key : client private key for authentication, if required by server.
--~-~-keyform : keyfile type, can be either "pem" or "engine".
--~-~-ciphers : openssl compatible list of TLS ciphers to support.
--~-~-tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.
++ --cert : client certificate for authentication, if required by server.
++ --key : client private key for authentication, if required by server.
++ --keyform : keyfile type, can be either "pem" or "engine".
++ --ciphers : openssl compatible list of TLS ciphers to support.
++ --tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.
                   Defaults to tlsv1.2 if available.
--~-~-insecure : do not check that the server certificate hostname matches the remote
++ --insecure : do not check that the server certificate hostname matches the remote
                hostname. Using this option means that you cannot be sure that the
                remote host is the server you wish to connect to and so is insecure.
                Do not use this option in a production environment.
--~-~-tls-engine : If set, enables the use of a TLS engine device.
--~-~-tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.
--~-~-psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.
--~-~-psk-identity : client identity string for TLS-PSK mode.
--~-~-proxy : SOCKS5 proxy URL of the form:
--           socks5h:~/~/[username[:password]@]hostname[:port]
++ --tls-engine : If set, enables the use of a TLS engine device.
++ --tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.
++ --psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.
++ --psk-identity : client identity string for TLS-PSK mode.
++ --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)
++{{{# Call MQTT Publish command
++
++# 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"
--
++ 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)
  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"
--
++ 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
  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"
--
++ 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
  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"
--
++ 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
  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"
--
++ 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
  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"
--
++ 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
  else
--case="Invalid parameters"
--logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
--fi
--)))
++ case="Invalid parameters"
++ logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called."
++fi}}}
--= 4. Example to communicate to a simple MQTT server =
++= Example to communicate to a simple MQTT server =
--== 4.1 Overview ==
++== 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 ==
++== 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.
@@ -293,7 +293,7 @@
  Downstream: Subscribe a topic to get downstream
--== 4.3 Simulate via Dragino Command Line ==
++== 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.
@@ -321,7 +321,7 @@
  mosquitto_sub
--== 4.4 Configure Dragino UI for MQTT connection ==
++== Configure Dragino UI for MQTT connection ==
  This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection.
@@ -337,7 +337,7 @@
  forward to MQTT
--=== 4.4.1 Configure the MQTT Client for Upstream ===
++=== Configure the MQTT Client for Upstream ===
  Below screenshot is same as the publish command:
@@ -371,7 +371,7 @@
  MQTT Publish
--=== 4.4.2 Configure the MQTT Client for Downstream ===
++=== Configure the MQTT Client for Downstream ===
  Below screen shot equal to this subscribe command:
@@ -397,12 +397,13 @@
  downstream simulation
++\\
--== 4.5 Add LoRa support to communicate with remote sensor ==
++== 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 ===
++=== 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.
@@ -432,7 +432,7 @@
  Downstream Data Flow
--=== 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 ===
++=== 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.
@@ -439,8 +439,7 @@
  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.
--
--Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]]
++\\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.
@@ -496,7 +496,7 @@
  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 =
++= Example For Different MQTT Servers =
  |=(((
  [[~[~[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png~|~|alt="ThingSpeak1.png" height="98" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:ThingSpeak1.png]]
@@ -521,11 +521,12 @@
  [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]]
  )))
--= 6. How to Debug =
++= How to Debug =
++
  User can login the gateway's console and run **logread -f**. It will shows the output when there is packet arrive.User can see if it is correct.
--= 7. How to ask for Support =
++= 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:

Changes for page MQTT Forward Instruction

Summary

Details

Applications

Navigation