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,4 +1,4 @@ 1 - **~Contents:**1 +Contents: 2 2 3 3 {{toc/}} 4 4 ... ... @@ -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]])15 +* 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"]] 40 +[[~[~[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"]] 66 +[[~[~[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 -))) 75 +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"]] 95 +[[~[~[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"]] 106 +[[~[~[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 -))) 110 +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,136 +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 117 +{{{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 - 120 + 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]123 + [-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]126 + [-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]129 + [--will-topic [--will-payload payload] [--will-qos qos] [--will-retain]] 130 + [{--cafile file | --capath dir} [--cert file] [--key file] 131 + [--ciphers ciphers] [--insecure] 132 + [--tls-alpn protocol] 133 + [--tls-engine engine] [--keyform keyform] [--tls-engine-kpass-sha1]] 134 + [--psk hex-key --psk-identity identity [--ciphers ciphers]] 135 + [--proxy socks-url] 136 + [--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 138 + mosquitto_pub --help 139 + 140 + -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 142 + -d : enable debug messages. 143 + -D : Define MQTT v5 properties. See the documentation for more details. 144 + -f : send the contents of a file as the message. 145 + -h : mqtt host to connect to. Defaults to localhost. 146 + -i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id. 147 + -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. 149 + -k : keep alive in seconds for this client. Defaults to 60. 150 + -L : specify user, password, hostname, port and topic as a URL in the form: 151 + mqtt(s)://[username[:password]@]host[:port]/topic 152 + -l : read messages from stdin, sending a separate message for each line. 153 + -m : message payload to send. 154 + -M : the maximum inflight messages for QoS 1/2.. 155 + -n : send a null (zero length) message. 156 + -p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS. 157 + -P : provide a password 158 + -q : quality of service level to use for all messages. Defaults to 0. 159 + -r : message should be retained. 160 + -s : read message from stdin, sending the entire input as a message. 161 + -t : mqtt topic to publish to. 162 + -u : provide a username 163 + -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 of165 + --help : display this message. 166 + --repeat : if publish mode is -f, -m, or -s, then repeat the publish N times. 167 + --repeat-delay : if using --repeat, wait time seconds between publishes. Defaults to 0. 168 + --quiet : don't print error messages. 169 + --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 encrypted172 + --will-qos : QoS level for the client Will. 173 + --will-retain : if given, make the client Will retained. 174 + --will-topic : the topic on which to publish the client Will. 175 + --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 encrypted177 + --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.179 + --cert : client certificate for authentication, if required by server. 180 + --key : client private key for authentication, if required by server. 181 + --keyform : keyfile type, can be either "pem" or "engine". 182 + --ciphers : openssl compatible list of TLS ciphers to support. 183 + --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 remote185 + --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]189 + --tls-engine : If set, enables the use of a TLS engine device. 190 + --tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine. 191 + --psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode. 192 + --psk-identity : client identity string for TLS-PSK mode. 193 + --proxy : SOCKS5 proxy URL of the form: 194 + socks5h://[username[:password]@]hostname[:port] 217 217 Only "none" and "username" authentication is supported. 218 - 219 -See https:~/~/mosquitto.org/ for more information. 220 -))) 196 + 197 +See https://mosquitto.org/ for more information.}}} 221 221 222 222 223 -((( 224 224 and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines: 225 -))) 226 226 227 -(% class="box" %) 228 -((( 229 -# Call MQTT Publish command 230 - 231 -# 1. Case with User, Password and Client ID present (e.g. Azure) 202 +{{{# Call MQTT Publish command 203 + 204 +# 1. Case with User, Password and Client ID present (e.g. Azure) 232 232 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 233 -case="1" 234 -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" 235 - 206 + case="1" 207 + 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" 208 + 236 236 # 2. Case with Certificate, Key and ClientID present (e.g. AWS) 237 237 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then 238 -case="2" 239 -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"240 - 211 + case="2" 212 + 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" 213 + 241 241 # 3. Case with no User, Certificate or ClientID present 242 242 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then 243 -case="3" 244 -mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 245 - 216 + case="3" 217 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 218 + 246 246 # 4. Case with no User, Certificate, but with ClientID present 247 247 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then 248 -case="4" 249 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 250 - 221 + case="4" 222 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 223 + 251 251 # 5. Case with User and ClientID present, but no Password and no Certificate present 252 252 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 253 -case="5" 254 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data" 255 - 226 + case="5" 227 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data" 228 + 256 256 # 6. Case with User and Password present, but no ClientID and no Certificate present 257 257 elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then 258 -case="6" 259 -mosquitto_pub $D -h $server -p $port -q $pub_qos 260 - 231 + case="6" 232 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data" 233 + 261 261 # 0. Else - invalid parameters, just log 262 262 else 263 -case="Invalid parameters" 264 -logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 265 -fi 266 -))) 236 + case="Invalid parameters" 237 + logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 238 +fi}}} 267 267 268 268 269 269 = 4. Example to communicate to a simple MQTT server = ... ... @@ -276,23 +276,21 @@ 276 276 277 277 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. 278 278 279 -((( 280 280 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. 281 -))) 282 282 283 -[[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png||height="201" width="600"]] 253 +[[~[~[image:https://wiki.dragino.com/images/thumb/0/06/MQTT_Forward_4.png/600px-MQTT_Forward_4.png~|~|height="201" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_4.png]] 284 284 285 285 Connect to MQTT Broker 286 286 287 287 After connected, use publish to public some thing to MQTT server. This to simulate upsteam 288 288 289 -[[image:https://wiki.dragino.com/images/thumb/b/bd/MQTT_Forward_5.png/600px-MQTT_Forward_5.png||height="149" width="600"]] 259 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/bd/MQTT_Forward_5.png/600px-MQTT_Forward_5.png~|~|height="149" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_5.png]] 290 290 291 291 Upstream: Publish message to MQTT Broker 292 292 293 293 To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below: 294 294 295 -[[image:https://wiki.dragino.com/images/thumb/3/3d/MQTT_Forward_6.png/600px-MQTT_Forward_6.png||height="279" width="600"]] 265 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3d/MQTT_Forward_6.png/600px-MQTT_Forward_6.png~|~|height="279" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Forward_6.png]] 296 296 297 297 Downstream: Subscribe a topic to get downstream 298 298 ... ... @@ -304,7 +304,7 @@ 304 304 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 305 305 306 306 307 - (% class="mark" %)**For Upstream**277 +For Upstream 308 308 309 309 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 310 310 ... ... @@ -312,82 +312,65 @@ 312 312 313 313 Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network. 314 314 315 -[[image:https://wiki.dragino.com/images/thumb/d/d0/MQTT_Command_6.png/600px-MQTT_Command_6.png||height="188" width="600"]] 285 +[[~[~[image:https://wiki.dragino.com/images/thumb/d/d0/MQTT_Command_6.png/600px-MQTT_Command_6.png~|~|height="188" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_6.png]] 316 316 317 317 mosquitto_pub 318 318 319 319 320 - (% class="mark" %)**For Downstream**290 +For Downstream 321 321 322 322 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 323 323 324 -[[image:https://wiki.dragino.com/images/thumb/8/89/MQTT_Command_7.png/600px-MQTT_Command_7.png||height="267" width="600"]] 294 +[[~[~[image:https://wiki.dragino.com/images/thumb/8/89/MQTT_Command_7.png/600px-MQTT_Command_7.png~|~|height="267" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_7.png]] 325 325 326 326 mosquitto_sub 327 327 328 - 329 329 == 4.4 Configure Dragino UI for MQTT connection == 330 330 331 331 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 332 332 333 -((( 334 -Go to (% class="mark" %)**Dragino Menu ~-~-> MQTT Client** 335 -))) 302 +Go to Dragino Menu ~-~-> MQTT Client 336 336 337 -[[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png||height="249" width="600"]] 304 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/bc/MQTT_Command_8.png/600px-MQTT_Command_8.png~|~|height="249" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_8.png]] 338 338 339 339 go to mqtt configure menu 340 340 341 -((( 342 -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. 343 -))) 308 +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. 344 344 345 -[[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png||height="240" width="600"]] 310 +[[~[~[image:https://wiki.dragino.com/images/thumb/1/14/MQTT_Commands_8.png/600px-MQTT_Commands_8.png~|~|height="240" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Commands_8.png]] 346 346 347 347 forward to MQTT 348 348 349 - 350 350 === 4.4.1 Configure the MQTT Client for Upstream === 351 351 352 352 Below screenshot is same as the publish command: 353 353 354 -(% class="box" %) 355 -((( 356 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 357 -~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 358 -~/~/CLIENTID: dragino-1b7060 359 -~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 360 -~/~/DATA: The data stores in /var/iot/channels/ 361 -))) 318 +{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 319 +//where the CLIENTID, CHANNEL & DATA are macro. represent for 320 +//CLIENTID: dragino-1b7060 321 +//CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 322 +//DATA: The data stores in /var/iot/channels/ 323 +}}} 362 362 363 -[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]] 325 +[[~[~[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]] 364 364 365 365 MQTT Publish configure 366 366 329 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png~|~|height="544" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_10.png]] 367 367 368 -[[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png||height="544" width="600"]] 369 - 370 370 MQTT Channel settings 371 371 372 -((( 373 373 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: 374 -))) 375 375 376 -(% class="box" %) 377 -((( 378 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46 379 -))) 335 +{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46 336 +}}} 380 380 381 -((( 382 382 to MQTT broker. 383 -))) 384 384 385 385 386 -((( 387 387 Below is a simulation to put this data to active the MQTT publish. 388 -))) 389 389 390 -[[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png||height="308" width="600"]] 343 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/30/MQTT_Command_11.png/600px-MQTT_Command_11.png~|~|height="308" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_11.png]] 391 391 392 392 MQTT Publish 393 393 ... ... @@ -396,21 +396,17 @@ 396 396 397 397 Below screen shot equal to this subscribe command: 398 398 399 -(% class="box" %) 400 -((( 401 -mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 402 -))) 352 +{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 353 +}}} 403 403 404 -[[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png||height="173" width="579"]] 355 +[[~[~[image:https://wiki.dragino.com/images/3/36/MQTT_Command_12.png~|~|height="173" width="579"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_12.png]] 405 405 406 406 MQTT Subscribe 407 407 408 408 409 -((( 410 410 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: 411 -))) 412 412 413 -[[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png||height="300" width="600"]] 362 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/b8/MQTT_Command_13.png/600px-MQTT_Command_13.png~|~|height="300" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_13.png]] 414 414 415 415 LoRa Broadcast parameters. 416 416 ... ... @@ -417,11 +417,13 @@ 417 417 418 418 And below is the subscribe simulation: 419 419 420 -[[image:https://wiki.dragino.com/images/thumb/6/60/MQTT_Command_14.png/600px-MQTT_Command_14.png||height="255" width="600"]] 369 +[[~[~[image:https://wiki.dragino.com/images/thumb/6/60/MQTT_Command_14.png/600px-MQTT_Command_14.png~|~|height="255" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_14.png]] 421 421 422 422 downstream simulation 423 423 424 424 374 +\\ 375 + 425 425 == 4.5 Add LoRa support to communicate with remote sensor == 426 426 427 427 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. ... ... @@ -428,27 +428,19 @@ 428 428 429 429 === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 430 430 431 -((( 432 432 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. 433 -))) 434 434 435 -((( 436 436 The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]] 437 -))) 438 438 439 -((( 440 440 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. 441 -))) 442 442 443 -((( 444 444 What does the Arduino Sketch do? The Arduino Sketch will: 445 -))) 446 446 447 447 * 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). 448 448 * Downstream: Listening broadcast message from gateway, and print it in console. 449 449 * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below: 450 450 451 -[[image:https://wiki.dragino.com/images/thumb/3/3b/MQTT_Command_17.png/600px-MQTT_Command_17.png||height="197" width="600"]] 394 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3b/MQTT_Command_17.png/600px-MQTT_Command_17.png~|~|height="197" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_17.png]] 452 452 453 453 LoRa Parameter should match 454 454 ... ... @@ -455,11 +455,11 @@ 455 455 456 456 Below is the test result after the Arduino Sketch is running. 457 457 458 -[[image:https://wiki.dragino.com/images/thumb/6/63/MQTT_Command_18.png/600px-MQTT_Command_18.png||height="319" width="600"]] 401 +[[~[~[image:https://wiki.dragino.com/images/thumb/6/63/MQTT_Command_18.png/600px-MQTT_Command_18.png~|~|height="319" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_18.png]] 459 459 460 460 Upstream Data Flow 461 461 462 -[[image:https://wiki.dragino.com/images/thumb/1/18/MQTT_Command_19.png/600px-MQTT_Command_19.png||height="309" width="600"]] 405 +[[~[~[image:https://wiki.dragino.com/images/thumb/1/18/MQTT_Command_19.png/600px-MQTT_Command_19.png~|~|height="309" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:MQTT_Command_19.png]] 463 463 464 464 Downstream Data Flow 465 465 ... ... @@ -466,33 +466,26 @@ 466 466 467 467 === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 468 468 469 -((( 470 470 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. 471 -))) 472 472 473 -((( 474 474 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. 475 -Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 476 -))) 477 477 478 -((( 416 + 417 +\\Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 418 + 419 + 479 479 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. 480 -))) 481 481 482 -((( 483 483 Step 2: Make sure your Radio settings match the End Node settings. 484 -))) 485 485 486 -[[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387" width="600"]] 424 +[[~[~[image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png~|~|height="387" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_5.png]] 487 487 488 488 Use Same Frequency Band as End Node 489 489 490 490 491 -((( 492 492 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 493 -))) 494 494 495 -[[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png||height="385" width="600"]] 431 +[[~[~[image:https://wiki.dragino.com/images/thumb/8/8d/LG308_MQTT_3.png/600px-LG308_MQTT_3.png~|~|height="385" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_3.png]] 496 496 497 497 Publish mush use META as data format for LG308 498 498 ... ... @@ -499,7 +499,7 @@ 499 499 500 500 Step 4: Map the Device Address to Remote ID in MQTT server. 501 501 502 -[[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png||height="335" width="600"]] 438 +[[~[~[image:https://wiki.dragino.com/images/thumb/7/7f/LG308_MQTT_4.png/600px-LG308_MQTT_4.png~|~|height="335" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_4.png]] 503 503 504 504 Map Dev Addr to remote ID 505 505 ... ... @@ -506,21 +506,21 @@ 506 506 507 507 Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server 508 508 509 -[[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png||height="279" width="600"]] 445 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/be/LG308_MQTT_6.png/600px-LG308_MQTT_6.png~|~|height="279" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6.png]] 510 510 511 511 Upstream Process 512 512 513 -[[image:https://wiki.dragino.com/images/thumb/0/07/LG308_MQTT_6_1.png/600px-LG308_MQTT_6_1.png||height="246" width="600"]] 449 +[[~[~[image:https://wiki.dragino.com/images/thumb/0/07/LG308_MQTT_6_1.png/600px-LG308_MQTT_6_1.png~|~|height="246" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6_1.png]] 514 514 515 515 Choose ASCII Format 516 516 517 -[[image:https://wiki.dragino.com/images/thumb/a/a3/LG308_MQTT_6_2.png/600px-LG308_MQTT_6_2.png||height="248" width="600"]] 453 +[[~[~[image:https://wiki.dragino.com/images/thumb/a/a3/LG308_MQTT_6_2.png/600px-LG308_MQTT_6_2.png~|~|height="248" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_6_2.png]] 518 518 519 519 LHT65 Decoder 520 520 521 521 Step 6: Set up subscribe: Subscribe a topci for downstream. 522 522 523 -[[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]] 459 +[[~[~[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png~|~|height="176" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_7.png]] 524 524 525 525 Subscribe to a topic 526 526 ... ... @@ -527,7 +527,7 @@ 527 527 528 528 Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 529 529 530 -[[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png||height="298" width="600"]] 466 +[[~[~[image:https://wiki.dragino.com/images/thumb/9/97/LG308_MQTT_8.png/600px-LG308_MQTT_8.png~|~|height="298" width="600"~]~]>>url:https://wiki.dragino.com/index.php/File:LG308_MQTT_8.png]] 531 531 532 532 Downstream Flow 533 533 ... ... @@ -536,36 +536,33 @@ 536 536 537 537 = 5. Example For Different MQTT Servers = 538 538 539 -(% style="width:731.222px" %) 540 -|=(% style="width: 270px;" %)((( 541 -[[image:https://wiki.dragino.com/images/thumb/7/73/ThingSpeak1.png/200px-ThingSpeak1.png||alt="ThingSpeak1.png" height="114" width="233"]] 475 +|=((( 476 +[[~[~[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]] 542 542 543 -== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] == 478 +=== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] === 544 544 545 545 546 546 [[Examples>>url:https://wiki.dragino.com/index.php/ThingSpeak_Examples]] 547 -)))|=( % style="width: 242px;" %)(((548 -[[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png||alt="Lewei50.png" height=" 65" width="223"]]482 +)))|=((( 483 +[[~[~[image:https://wiki.dragino.com/images/thumb/3/3b/Lewei50.png/200px-Lewei50.png~|~|alt="Lewei50.png" height="58" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:Lewei50.png]] 549 549 550 -(% class="wikigeneratedid" %) 551 -== == 485 +=== [[乐联网平台>>url:https://www.lewei50.com/]] === 552 552 553 -== [[乐联网平台>>url:https://www.lewei50.com/]] == 554 554 488 +[[lewei Example>>url:https://wiki.dragino.com/index.php/Lewei_Example_mqtt]] 489 +)))|=((( 490 +[[~[~[image:https://wiki.dragino.com/images/thumb/a/aa/AWS-IOT.png/200px-AWS-IOT.png~|~|alt="AWS-IOT.png" height="122" width="200"~]~]>>url:https://wiki.dragino.com/index.php/File:AWS-IOT.png]] 555 555 556 -[[lewei Example>>url:https://wiki.dragino.com/index.php/Lewei_Example_mqtt]] 557 -)))|=(% style="width: 214px;" %)((( 558 -[[image:https://wiki.dragino.com/images/thumb/a/aa/AWS-IOT.png/200px-AWS-IOT.png||alt="AWS-IOT.png" height="112" width="183"]] 492 +=== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] === 559 559 560 -== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] == 561 561 562 - 563 563 [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]] 564 564 ))) 565 565 498 + 566 566 = 6. How to Debug = 567 567 568 -User can login the gateway's console and run (% class="mark" %)**logread -f**(%%). It will shows the output when there is packet arrive.User can see if it is correct.501 +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. 569 569 570 570 = 7. How to ask for Support = 571 571