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)
-
Attachments (0 modified, 0 added, 1 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 ( (% style="color:red" %)**Warning**(%%): LG01-P LG01-S use another instruction: [[MQTT for LG01-P/LG01S>>url:https://wiki.dragino.com/index.php/Through_MQTT_to_upload_data]])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 ... ... @@ -19,15 +19,15 @@ 19 19 * LIG16 20 20 * MS14 series if installed with the same firmware. (in this case, the MQTT forward will work , but no LoRa support) 21 21 22 + 22 22 = 2. Firmware Change Log for MQTT feature = 23 23 24 -((( 25 25 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 26 -))) 27 27 28 28 * LG02_LG08-5.3.1580178039 29 29 ** Initiate version 30 30 30 + 31 31 = 3. MQTT forward operating principle = 32 32 33 33 == 3.1 Network Structure == ... ... @@ -37,47 +37,33 @@ 37 37 * 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. 38 38 * 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, 39 39 40 -[[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]] 41 41 42 42 General MQTT structure 43 43 44 - 45 45 == 3.2 How sensor data is forwarded == 46 46 47 47 In this MQTT forward feature, the key point is how the gateway process the sensor data. 48 48 49 - 50 50 === 3.2.1 Upstream === 51 51 52 52 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. 53 53 54 -((( 55 55 The data flow works as below diagram. 56 -))) 57 57 58 58 [[~[~[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]] 59 59 60 -((( 61 61 Upstream path 62 -))) 63 63 64 -((( 65 65 Note: The sensor data can base or LoRa or other method, as long as there are data on the file /var/iot/channels. /span> 66 -))) 67 67 68 -((( 69 - 70 -))) 71 - 72 72 === 3.2.2 Downstream === 73 73 74 74 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. 75 75 76 -((( 77 77 Below are the data flow for downstream. 78 -))) 79 79 80 -[[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]] 81 81 82 82 Downstream path 83 83 ... ... @@ -86,9 +86,7 @@ 86 86 87 87 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 88 88 89 -((( 90 -Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros. 91 -))) 75 +Currently the -t (topic) and -m (message) support Macros. 92 92 93 93 === 3.3.1 -t topic macro === 94 94 ... ... @@ -108,7 +108,7 @@ 108 108 109 109 === 3.3.3 Example for Macro === 110 110 111 -[[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]] 112 112 113 113 MQTT Publish configure 114 114 ... ... @@ -119,13 +119,11 @@ 119 119 120 120 When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below: 121 121 122 -[[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]] 123 123 124 124 Sensor Data 125 125 126 -((( 127 -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. 128 -))) 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. 129 129 130 130 131 131 == 3.4 Modify the MQTT to support more options == ... ... @@ -132,126 +132,128 @@ 132 132 133 133 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: 134 134 135 -(% class="box" %) 136 -((( 137 -root@dragino-1ec39c:~~# mosquitto_pub ~-~-help 117 +{{{root@dragino-1ec39c:~# mosquitto_pub --help 138 138 mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit. 139 139 mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4. 140 -\\Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL} 120 + 121 +Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL} 141 141 {-f file | -l | -n | -m message} 142 - [-c] [-k keepalive] [-q qos] [-r] [ ~-~-repeat N] [~-~-repeat-delay time]123 + [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time] 143 143 [-A bind_address] 144 144 [-i id] [-I id_prefix] 145 - [-d] [ ~-~-quiet]126 + [-d] [--quiet] 146 146 [-M max_inflight] 147 147 [-u username [-P password]] 148 - [ ~-~-will-topic [~-~-will-payload payload] [~-~-will-qos qos] [~-~-will-retain]]149 - [{ ~-~-cafile file |~-~-capath dir} [~-~-cert file] [~-~-key file]150 - [ ~-~-ciphers ciphers] [~-~-insecure]151 - [ ~-~-tls-alpn protocol]152 - [ ~-~-tls-engine engine] [~-~-keyform keyform] [~-~-tls-engine-kpass-sha1]]153 - [ ~-~-psk hex-key~-~-psk-identity identity [~-~-ciphers ciphers]]154 - [ ~-~-proxy socks-url]155 - [ ~-~-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] 156 156 [-D command identifier value] 157 - mosquitto_pub ~-~-help 158 -\\-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 159 159 the client communicates over. 160 --d : enable debug messages. 161 --D : Define MQTT v5 properties. See the documentation for more details. 162 --f : send the contents of a file as the message. 163 --h : mqtt host to connect to. Defaults to localhost. 164 --i : id to use for this client. Defaults to mosquitto_pub_ appended with the process id. 165 --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 166 166 broker is using the clientid_prefixes option. 167 --k : keep alive in seconds for this client. Defaults to 60. 168 --L : specify user, password, hostname, port and topic as a URL in the form: 169 - mqtt(s): ~/~/[username[:password]@]host[:port]/topic170 --l : read messages from stdin, sending a separate message for each line. 171 --m : message payload to send. 172 --M : the maximum inflight messages for QoS 1/2.. 173 --n : send a null (zero length) message. 174 --p : network port to connect to. Defaults to 1883 for plain MQTT and 8883 for MQTT over TLS. 175 --P : provide a password 176 --q : quality of service level to use for all messages. Defaults to 0. 177 --r : message should be retained. 178 --s : read message from stdin, sending the entire input as a message. 179 --t : mqtt topic to publish to. 180 --u : provide a username 181 --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. 182 182 Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311. 183 - ~-~-help : display this message.184 - ~-~-repeat : if publish mode is -f, -m, or -s, then repeat the publish N times.185 - ~-~-repeat-delay : if using~-~-repeat, wait time seconds between publishes. Defaults to 0.186 - ~-~-quiet :(% class="mark" %)don't print error messages.187 - ~-~-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 188 188 unexpected disconnection. If not given and will-topic is set, a zero 189 189 length message will be sent. 190 - ~-~-will-qos : QoS level for the client Will.191 - ~-~-will-retain : if given, make the client Will retained.192 - ~-~-will-topic : the topic on which to publish the client Will.193 - ~-~-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 194 194 communication. 195 - ~-~-capath : path to a directory containing trusted CA certificates to enable encrypted177 + --capath : path to a directory containing trusted CA certificates to enable encrypted 196 196 communication. 197 - ~-~-cert : client certificate for authentication, if required by server.198 - ~-~-key : client private key for authentication, if required by server.199 - ~-~-keyform : keyfile type, can be either "pem" or "engine".200 - ~-~-ciphers : openssl compatible list of TLS ciphers to support.201 - ~-~-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. 202 202 Defaults to tlsv1.2 if available. 203 - ~-~-insecure : do not check that the server certificate hostname matches the remote185 + --insecure : do not check that the server certificate hostname matches the remote 204 204 hostname. Using this option means that you cannot be sure that the 205 205 remote host is the server you wish to connect to and so is insecure. 206 206 Do not use this option in a production environment. 207 - ~-~-tls-engine : If set, enables the use of a TLS engine device.208 - ~-~-tls-engine-kpass-sha1 : SHA1 of the key password to be used with the selected SSL engine.209 - ~-~-psk : pre-shared-key in hexadecimal (no leading 0x) to enable TLS-PSK mode.210 - ~-~-psk-identity : client identity string for TLS-PSK mode.211 - ~-~-proxy : SOCKS5 proxy URL of the form:212 - 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] 213 213 Only "none" and "username" authentication is supported. 214 - \\See https:~/~/mosquitto.org/ for more information.215 - )))196 + 197 +See https://mosquitto.org/ for more information.}}} 216 216 217 217 218 -((( 219 219 and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines: 220 -))) 221 221 222 -(% class="box" %) 223 -((( 224 -# Call MQTT Publish command 225 -\\# 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) 226 226 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 227 -case="1" 228 -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" 229 -\\# 2. Case with Certificate, Key and ClientID present (e.g. AWS) 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 + 209 +# 2. Case with Certificate, Key and ClientID present (e.g. AWS) 230 230 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then 231 -case="2" 232 -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" 233 -\\# 3. Case with no User, Certificate or ClientID present 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 + 214 +# 3. Case with no User, Certificate or ClientID present 234 234 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then 235 -case="3" 236 -mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 237 -\\# 4. Case with no User, Certificate, but with ClientID present 216 + case="3" 217 + mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 218 + 219 +# 4. Case with no User, Certificate, but with ClientID present 238 238 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then 239 -case="4" 240 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 241 -\\# 5. Case with User and ClientID present, but no Password and no Certificate present 221 + case="4" 222 + mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 223 + 224 +# 5. Case with User and ClientID present, but no Password and no Certificate present 242 242 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 243 -case="5" 244 -mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic -u $user $PUB_FLAG "$mqtt_data" 245 -\\# 6. Case with User and Password present, but no ClientID and no Certificate present 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 + 229 +# 6. Case with User and Password present, but no ClientID and no Certificate present 246 246 elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then 247 -case="6" 248 -mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data" 249 -\\# 0. Else - invalid parameters, just log 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 + 234 +# 0. Else - invalid parameters, just log 250 250 else 251 -case="Invalid parameters" 252 -logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 253 -fi 254 -))) 236 + case="Invalid parameters" 237 + logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 238 +fi}}} 255 255 256 256 257 257 = 4. Example to communicate to a simple MQTT server = ... ... @@ -264,23 +264,21 @@ 264 264 265 265 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. 266 266 267 -((( 268 268 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. 269 -))) 270 270 271 -[[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]] 272 272 273 273 Connect to MQTT Broker 274 274 275 275 After connected, use publish to public some thing to MQTT server. This to simulate upsteam 276 276 277 -[[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]] 278 278 279 279 Upstream: Publish message to MQTT Broker 280 280 281 281 To simulate a downstream, use MQTT.fx to subscribe a topic, and publish something to this topic. as Below: 282 282 283 -[[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]] 284 284 285 285 Downstream: Subscribe a topic to get downstream 286 286 ... ... @@ -292,7 +292,7 @@ 292 292 In the Dragino Gateway, we use [[mosquitto client>>url:https://mosquitto.org/]] for MQTT connection. 293 293 294 294 295 - (% class="mark" %)**For Upstream**277 +For Upstream 296 296 297 297 command is [[mosquitto_pub>>url:https://mosquitto.org/man/mosquitto_pub-1.html]] 298 298 ... ... @@ -300,82 +300,65 @@ 300 300 301 301 Note: 192.168.199.148 is MQTT broker address, the gateway and the MQTT broker PC are in the same network. 302 302 303 -[[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]] 304 304 305 305 mosquitto_pub 306 306 307 307 308 - (% class="mark" %)**For Downstream**290 +For Downstream 309 309 310 310 Use [[mosquitto_sub>>url:https://mosquitto.org/man/mosquitto_sub-1.html]] to subscribe the change on the topic. 311 311 312 -[[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]] 313 313 314 314 mosquitto_sub 315 315 316 - 317 317 == 4.4 Configure Dragino UI for MQTT connection == 318 318 319 319 This chapter are step by step to show to configure the Dragino Menu for MQTT auto connection. 320 320 321 -((( 322 -Go to (% class="mark" %)**Dragino Menu ~-~-> MQTT Client** 323 -))) 302 +Go to Dragino Menu ~-~-> MQTT Client 324 324 325 -[[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]] 326 326 327 327 go to mqtt configure menu 328 328 329 -((( 330 -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. 331 -))) 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. 332 332 333 -[[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]] 334 334 335 335 forward to MQTT 336 336 337 - 338 338 === 4.4.1 Configure the MQTT Client for Upstream === 339 339 340 340 Below screenshot is same as the publish command: 341 341 342 -(% class="box" %) 343 -((( 344 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t CLIENTID/CHANNEL/data -m DATA 345 -~/~/where the CLIENTID, CHANNEL & DATA are macro. represent for 346 -~/~/CLIENTID: dragino-1b7060 347 -~/~/CHANNEL: Remote ID in Channel settings; here is 78901 or 567456 348 -~/~/DATA: The data stores in /var/iot/channels/ 349 -))) 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 +}}} 350 350 351 -[[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]] 352 352 353 353 MQTT Publish configure 354 354 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]] 355 355 356 -[[image:https://wiki.dragino.com/images/thumb/b/b7/MQTT_Command_10.png/600px-MQTT_Command_10.png||height="544" width="600"]] 357 - 358 358 MQTT Channel settings 359 359 360 -((( 361 361 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: 362 -))) 363 363 364 -(% class="box" %) 365 -((( 366 -mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46 367 -))) 335 +{{{mosquitto_pub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t dragino-1b7060/78901/data -m temp=46 336 +}}} 368 368 369 -((( 370 370 to MQTT broker. 371 -))) 372 372 373 373 374 -((( 375 375 Below is a simulation to put this data to active the MQTT publish. 376 -))) 377 377 378 -[[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]] 379 379 380 380 MQTT Publish 381 381 ... ... @@ -384,21 +384,17 @@ 384 384 385 385 Below screen shot equal to this subscribe command: 386 386 387 -(% class="box" %) 388 -((( 389 -mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 390 -))) 352 +{{{ mosquitto_sub -h 192.168.199.148 -p 1883 -i dragino-1b7060 -t command. 353 +}}} 391 391 392 -[[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]] 393 393 394 394 MQTT Subscribe 395 395 396 396 397 -((( 398 398 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: 399 -))) 400 400 401 -[[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]] 402 402 403 403 LoRa Broadcast parameters. 404 404 ... ... @@ -405,11 +405,13 @@ 405 405 406 406 And below is the subscribe simulation: 407 407 408 -[[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]] 409 409 410 410 downstream simulation 411 411 412 412 374 +\\ 375 + 413 413 == 4.5 Add LoRa support to communicate with remote sensor == 414 414 415 415 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. ... ... @@ -416,27 +416,19 @@ 416 416 417 417 === 4.5.1 Use LoRa Raw protocol for communication ~-~- For LG01/LG02 === 418 418 419 -((( 420 420 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. 421 -))) 422 422 423 -((( 424 424 The example Sketch for LoRa Shield +Arduino is here: [[LoRa_Shield_Sketch_For_MQTT>>url:http://www.dragino.com/downloads/index.php?dir=LoraShield/]] 425 -))) 426 426 427 -((( 428 428 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. 429 -))) 430 430 431 -((( 432 432 What does the Arduino Sketch do? The Arduino Sketch will: 433 -))) 434 434 435 435 * 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). 436 436 * Downstream: Listening broadcast message from gateway, and print it in console. 437 437 * The LoRa parameter settings in Arduino should match the LoRa settings in gateway, as below: 438 438 439 -[[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]] 440 440 441 441 LoRa Parameter should match 442 442 ... ... @@ -443,11 +443,11 @@ 443 443 444 444 Below is the test result after the Arduino Sketch is running. 445 445 446 -[[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]] 447 447 448 448 Upstream Data Flow 449 449 450 -[[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]] 451 451 452 452 Downstream Data Flow 453 453 ... ... @@ -454,107 +454,96 @@ 454 454 455 455 === 4.5.2 Use LoRaWAN Protocol for communication ~-~- For LG308/LPS8/DLOS8 === 456 456 457 -((( 458 -Since firmware (% class="mark" %)**LG02_LG08~-~-build-v5.3.1585192026-20200326-1109,**(%%) Dragino LoRaWAN gateways support the communication to LoRaWAN (% class="mark" %)**ABP end node**(%%) locally without the need of LoRaWAN server. This feature allow us to integrate MQTT in the gateway to support LoRaWAN to MQTT forwarding or visa verse. 459 -))) 412 +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. 460 460 461 -((( 462 -When use test this feature, please use the version higher then : (% class="mark" %)**LG02_LG08~-~-build-v5.4.1593400722-20200629-1120**(%%), in this version, the upload format is changed and readable, which is easier for integration. 463 -(% class="mark" %)**Video Instruction**(%%):[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 464 -))) 414 +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. 465 465 466 -((( 467 -**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. 468 -))) 469 469 470 -((( 471 -**Step 2**: Make sure your Radio settings match the End Node settings. 472 -))) 417 +\\Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 418 + 473 473 474 -[[ image:https://wiki.dragino.com/images/thumb/f/f7/LG308_MQTT_5.png/600px-LG308_MQTT_5.png||height="387"width="600"]]420 +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. 475 475 422 +Step 2: Make sure your Radio settings match the End Node settings. 423 + 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]] 425 + 476 476 Use Same Frequency Band as End Node 477 477 478 478 479 -((( 480 -((( 481 -**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 482 -))) 483 -))) 429 +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 484 484 485 -[[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]] 486 486 487 487 Publish mush use META as data format for LG308 488 488 489 489 490 - **Step 4**: Map the Device Address to Remote ID in MQTT server.436 +Step 4: Map the Device Address to Remote ID in MQTT server. 491 491 492 -[[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]] 493 493 494 494 Map Dev Addr to remote ID 495 495 496 496 497 - **Step 5: Upstream**: Save the change, we can see the log info via "sytem log", End Node and MQTT Server443 +Step 5: Upstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server 498 498 499 -[[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]] 500 500 501 501 Upstream Process 502 502 503 -[[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]] 504 504 505 505 Choose ASCII Format 506 506 507 -[[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]] 508 508 509 509 LHT65 Decoder 510 510 457 +Step 6: Set up subscribe: Subscribe a topci for downstream. 511 511 512 - **Step 6:Setupubscribe:** Subscribeatopcifordownstream.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]] 513 513 514 -[[image:https://wiki.dragino.com/images/thumb/b/b9/LG308_MQTT_7.png/600px-LG308_MQTT_7.png||height="176" width="600"]] 515 - 516 516 Subscribe to a topic 517 517 518 518 519 - **Step 7**: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server.464 +Step 7: Downstream: Save the change, we can see the log info via "sytem log", End Node and MQTT Server. 520 520 521 -[[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]] 522 522 523 523 Downstream Flow 524 524 525 - (% class="mark" %)**Notice: The text use for Downstream must meet the requirement from [[LG308 Downstream Payload>>url:https://wiki.dragino.com/index.php/Communication_with_ABP_End_Node#Downstream]]**470 +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]] 526 526 527 527 528 528 = 5. Example For Different MQTT Servers = 529 529 530 -(% style="width:731.222px" %) 531 -|=(% style="width: 270px;" %)((( 532 -[[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]] 533 533 534 -== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] == 478 +=== [[ThingSpeak Server>>url:http://www.thingspeak.com/]] === 535 535 536 536 537 537 [[Examples>>url:https://wiki.dragino.com/index.php/ThingSpeak_Examples]] 538 -)))|=( % style="width: 242px;" %)(((539 -[[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]] 540 540 485 +=== [[乐联网平台>>url:https://www.lewei50.com/]] === 541 541 542 -== [[乐联网平台>>url:https://www.lewei50.com/]] == 543 543 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]] 544 544 545 -[[lewei Example>>url:https://wiki.dragino.com/index.php/Lewei_Example_mqtt]] 546 -)))|=(% style="width: 214px;" %)((( 547 -[[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/]] === 548 548 549 -== [[AWS-IOT>>url:https://aws.amazon.com/cn/iot-platform/how-it-works/]] == 550 550 551 - 552 552 [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]] 553 553 ))) 554 554 498 + 555 555 = 6. How to Debug = 556 556 557 -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. 558 558 559 559 = 7. How to ask for Support = 560 560
- image-20220527133547-1.png
-
- Author
-
... ... @@ -1,1 +1,0 @@ 1 -XWiki.Xiaoling - Size
-
... ... @@ -1,1 +1,0 @@ 1 -199.3 KB - Content