Changes for page MQTT Forward Instruction
Last modified by Kilight Cao on 2024/08/31 16:26
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,8 +1,6 @@ 1 - **~Contents:**1 + 2 2 3 -{{toc/}} 4 4 5 - 6 6 = 1. Introduction = 7 7 8 8 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse. ... ... @@ -12,7 +12,7 @@ 12 12 This MQTT forward instruction is for below devices: 13 13 14 14 * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]] 15 -* 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]])13 +* 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]]) 16 16 * LG02, OLG02 17 17 * LG308, DLOS8 18 18 * LPS8 ... ... @@ -22,9 +22,7 @@ 22 22 23 23 = 2. Firmware Change Log for MQTT feature = 24 24 25 -((( 26 26 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 27 -))) 28 28 29 29 * LG02_LG08-5.3.1580178039 30 30 ** Initiate version ... ... @@ -39,47 +39,33 @@ 39 39 * 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. 40 40 * 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, 41 41 42 -[[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png||height="348" width="600"]] 38 +[[~[~[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]] 43 43 44 44 General MQTT structure 45 45 46 - 47 47 == 3.2 How sensor data is forwarded == 48 48 49 49 In this MQTT forward feature, the key point is how the gateway process the sensor data. 50 50 51 - 52 52 === 3.2.1 Upstream === 53 53 54 54 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. 55 55 56 -((( 57 57 The data flow works as below diagram. 58 -))) 59 59 60 60 [[~[~[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]] 61 61 62 -((( 63 63 Upstream path 64 -))) 65 65 66 -((( 67 67 Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span> 68 -))) 69 69 70 -((( 71 - 72 -))) 73 - 74 74 === 3.2.2 Downstream === 75 75 76 76 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. 77 77 78 -((( 79 79 Below are the data flow for downstream. 80 -))) 81 81 82 -[[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png||height="368" width="600"]] 64 +[[~[~[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]] 83 83 84 84 Downstream path 85 85 ... ... @@ -88,9 +88,7 @@ 88 88 89 89 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 90 90 91 -((( 92 -Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros. 93 -))) 73 +Currently the -t (topic) and -m (message) support Macros. 94 94 95 95 === 3.3.1 -t topic macro === 96 96 ... ... @@ -110,7 +110,7 @@ 110 110 111 111 === 3.3.3 Example for Macro === 112 112 113 -[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]] 93 +[[~[~[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]] 114 114 115 115 MQTT Publish configure 116 116 ... ... @@ -121,13 +121,11 @@ 121 121 122 122 When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below: 123 123 124 -[[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png||height="325" width="600"]] 104 +[[~[~[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]] 125 125 126 126 Sensor Data 127 127 128 -((( 129 -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. 130 -))) 108 +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. 131 131 132 132 133 133 == 3.4 Modify the MQTT to support more options == ... ... @@ -134,134 +134,128 @@ 134 134 135 135 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: 136 136 137 -(% class="box" %) 138 -((( 139 -root@dragino-1ec39c:~~# mosquitto_pub ~-~-help 115 +{{{root@dragino-1ec39c:~# mosquitto_pub --help 140 140 mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit. 141 141 mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4. 142 - 118 + 143 143 Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL} 144 144 {-f file | -l | -n | -m message} 145 - [-c] [-k keepalive] [-q qos] [-r] [ ~-~-repeat N] [~-~-repeat-delay time]121 + [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time] 146 146 [-A bind_address] 147 147 [-i id] [-I id_prefix] 148 - [-d] [ ~-~-quiet]124 + [-d] [--quiet] 149 149 [-M max_inflight] 150 150 [-u username [-P password]] 151 - [ ~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]152 - [{ ~-~-cafile file |~-~-capath dir} [~-~-cert file] [~-~-key file]153 - [ ~-~-ciphers ciphers] [~-~-insecure]154 - [ ~-~-tls-alpn protocol]155 - [ ~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]156 - [ ~-~-psk hex-key~-~-psk-identity identity [~-~-ciphers ciphers]]157 - [ ~-~-proxy socks-url]158 - [ ~-~-property command identifier value]127 + [--will-topic [--will-payload payload] [--will-qos qos] [--will-retain]] 128 + [{--cafile file | --capath dir} [--cert file] [--key file] 129 + [--ciphers ciphers] [--insecure] 130 + [--tls-alpn protocol] 131 + [--tls-engine engine] [--keyform keyform] [--tls-engine-kpass-sha1]] 132 + [--psk hex-key --psk-identity identity [--ciphers ciphers]] 133 + [--proxy socks-url] 134 + [--property command identifier value] 159 159 [-D command identifier value] 160 - mosquitto_pub ~-~-help161 - 162 --A : bind the outgoing socket to this host/ip address. Use to control which interface 136 + mosquitto_pub --help 137 + 138 + -A : bind the outgoing socket to this host/ip address. Use to control which interface 163 163 the client communicates over. 164 --d : enable debug messages. 165 --D : Define MQTT v5 properties. See the documentation for more details. 166 --f : send the contents of a file as the message. 167 --h : mqtt host to connect to. Defaults to localhost. 168 --i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id. 169 --I : define the client id as id_prefix appended with the process id. Useful for when the 140 + -d : enable debug messages. 141 + -D : Define MQTT v5 properties. See the documentation for more details. 142 + -f : send the contents of a file as the message. 143 + -h : mqtt host to connect to. Defaults to localhost. 144 + -i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id. 145 + -I : define the client id as id_prefix appended with the process id. Useful for when the 170 170 broker is using the clientid_prefixes option. 171 --k : keep alive in seconds for this client. Defaults to 60. 172 --L : specify user, password, hostname, port and topic as a URL in the form: 173 - mqtt(s): ~/~/[username[:password]@]host[:port]/topic174 --l : read messages from stdin, sending a separate message for each line. 175 --m : message payload to send. 176 --M : the maximum inflight messages for QoS 1/2.. 177 --n : send a null (zero length) message. 178 --p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS. 179 --P : provide a password 180 --q : quality of service level to use for all messages. Defaults to 0. 181 --r : message should be retained. 182 --s : read message from stdin, sending the entire input as a message. 183 --t : mqtt topic to publish to. 184 --u : provide a username 185 --V : specify the version of the MQTT protocol to use when connecting. 147 + -k : keep alive in seconds for this client. Defaults to 60. 148 + -L : specify user, password, hostname, port and topic as a URL in the form: 149 + mqtt(s)://[username[:password]@]host[:port]/topic 150 + -l : read messages from stdin, sending a separate message for each line. 151 + -m : message payload to send. 152 + -M : the maximum inflight messages for QoS 1/2.. 153 + -n : send a null (zero length) message. 154 + -p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS. 155 + -P : provide a password 156 + -q : quality of service level to use for all messages. Defaults to 0. 157 + -r : message should be retained. 158 + -s : read message from stdin, sending the entire input as a message. 159 + -t : mqtt topic to publish to. 160 + -u : provide a username 161 + -V : specify the version of the MQTT protocol to use when connecting. 186 186 Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311. 187 - ~-~-help : display this message.188 - ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.189 - ~-~-repeat-delay : if using~-~-repeat, wait time seconds between publishes. Defaults to 0.190 - ~-~-quiet :(% class="mark" %)don't print error messages.191 - ~-~-will-payload : payload for the client Will, which is sent by the broker in case of163 + --help : display this message. 164 + --repeat : if publish mode is -f, -m, or -s, then repeat the publish N times. 165 + --repeat-delay : if using --repeat, wait time seconds between publishes. Defaults to 0. 166 + --quiet : don't print error messages. 167 + --will-payload : payload for the client Will, which is sent by the broker in case of 192 192 unexpected disconnection. If not given and will-topic is set, a zero 193 193 length message will be sent. 194 - ~-~-will-qos : QoS level for the client Will.195 - ~-~-will-retain : if given, make the client Will retained.196 - ~-~-will-topic : the topic on which to publish the client Will.197 - ~-~-cafile : path to a file containing trusted CA certificates to enable encrypted170 + --will-qos : QoS level for the client Will. 171 + --will-retain : if given, make the client Will retained. 172 + --will-topic : the topic on which to publish the client Will. 173 + --cafile : path to a file containing trusted CA certificates to enable encrypted 198 198 communication. 199 - ~-~-capath : path to a directory containing trusted CA certificates to enable encrypted175 + --capath : path to a directory containing trusted CA certificates to enable encrypted 200 200 communication. 201 - ~-~-cert : client certificate for authentication, if required by server.202 - ~-~-key : client private key for authentication, if required by server.203 - ~-~-keyform : keyfile type, can be either "pem" or "engine".204 - ~-~-ciphers : openssl compatible list of TLS ciphers to support.205 - ~-~-tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1.177 + --cert : client certificate for authentication, if required by server. 178 + --key : client private key for authentication, if required by server. 179 + --keyform : keyfile type, can be either "pem" or "engine". 180 + --ciphers : openssl compatible list of TLS ciphers to support. 181 + --tls-version : TLS protocol version, can be one of tlsv1.3 tlsv1.2 or tlsv1.1. 206 206 Defaults to tlsv1.2 if available. 207 - ~-~-insecure : do not check that the server certificate hostname matches the remote183 + --insecure : do not check that the server certificate hostname matches the remote 208 208 hostname. Using this option means that you cannot be sure that the 209 209 remote host is the server you wish to connect to and so is insecure. 210 210 Do not use this option in a production environment. 211 - ~-~-tls-engine : If set, enables the use of a TLS engine device.212 - ~-~-tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.213 - ~-~-psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.214 - ~-~-psk-identity : client identity string for TLS-PSK mode.215 - ~-~-proxy : SOCKS5 proxy URL of the form:216 - socks5h: ~/~/[username[:password]@]hostname[:port]187 + --tls-engine : If set, enables the use of a TLS engine device. 188 + --tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine. 189 + --psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode. 190 + --psk-identity : client identity string for TLS-PSK mode. 191 + --proxy : SOCKS5 proxy URL of the form: 192 + socks5h://[username[:password]@]hostname[:port] 217 217 Only "none" and "username" authentication is supported. 218 - 219 -See https:~/~/mosquitto.org/ for more information. 220 -))) 194 + 195 +See https://mosquitto.org/ for more information.}}} 221 221 222 222 223 223 and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines: 224 224 225 -(% class="box" %) 226 -((( 227 -# Call MQTT Publish command 228 - 229 -# 1. Case with User, Password and Client ID present (e.g. Azure) 200 +{{{# Call MQTT Publish command 201 + 202 +# 1. Case with User, Password and Client ID present (e.g. Azure) 230 230 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 231 -case="1" 232 -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" 233 - 204 + case="1" 205 + 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" 206 + 234 234 # 2. Case with Certificate, Key and ClientID present (e.g. AWS) 235 235 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then 236 -case="2" 237 -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"238 - 209 + case="2" 210 + 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" 211 + 239 239 # 3. Case with no User, Certificate or ClientID present 240 240 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then 241 -case="3" 242 -mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 243 - 214 + case="3" 215 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 216 + 244 244 # 4. Case with no User, Certificate, but with ClientID present 245 245 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then 246 -case="4" 247 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 248 - 219 + case="4" 220 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 221 + 249 249 # 5. Case with User and ClientID present, but no Password and no Certificate present 250 250 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 251 -case="5" 252 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data" 253 - 224 + case="5" 225 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data" 226 + 254 254 # 6. Case with User and Password present, but no ClientID and no Certificate present 255 255 elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then 256 -case="6" 257 -mosquitto_pub $D -h $server -p $port -q $pub_qos 258 - 229 + case="6" 230 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data" 231 + 259 259 # 0. Else - invalid parameters, just log 260 260 else 261 -case="Invalid parameters" 262 -logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 263 -fi 264 -))) 234 + case="Invalid parameters" 235 + logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 236 +fi}}} 265 265 266 266 267 267 = 4. Example to communicate to a simple MQTT server = ... ... @@ -397,6 +397,7 @@ 397 397 downstream simulation 398 398 399 399 372 +\\ 400 400 401 401 == 4.5 Add LoRa support to communicate with remote sensor == 402 402 ... ... @@ -439,8 +439,7 @@ 439 439 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. 440 440 441 441 442 - 443 -Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 415 +\\Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 444 444 445 445 446 446 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. ... ... @@ -521,6 +521,7 @@ 521 521 [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]] 522 522 ))) 523 523 496 + 524 524 = 6. How to Debug = 525 525 526 526 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.