Changes for page MQTT Forward Instruction
Last modified by Xiaoling on 2022/09/02 18:11
Summary
-
Page properties (1 modified, 0 added, 0 removed)
Details
- Page properties
-
- Content
-
... ... @@ -1,6 +1,8 @@ 1 - 1 +**~ Contents：** 2 2 3 +{{toc/}} 3 3 5 + 4 4 = 1. Introduction = 5 5 6 6 Dragino LoRa/LoRaWAN gateway support MQTT forwarding. It can forward the sensor data from LoRa network to MQTT server , and vice verse. ... ... @@ -10,7 +10,7 @@ 10 10 This MQTT forward instruction is for below devices: 11 11 12 12 * Firmware Version > LG02_LG08-5.3.1580178039 [[Firmware Download>>url:http://www.dragino.com/downloads/index.php?dir=LoRa_Gateway/LPS8/Firmware/Release/]] 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]]) 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]]) 14 14 * LG02, OLG02 15 15 * LG308, DLOS8 16 16 * LPS8 ... ... @@ -20,7 +20,9 @@ 20 20 21 21 = 2. Firmware Change Log for MQTT feature = 22 22 25 +((( 23 23 This instruction is wrote start from LG02_LG08-5.3.1580178039. Below is related change log since this version of firmware. 27 +))) 24 24 25 25 * LG02_LG08-5.3.1580178039 26 26 ** Initiate version ... ... @@ -35,33 +35,47 @@ 35 35 * 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. 36 36 * 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, 37 37 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]]42 +[[image:https://wiki.dragino.com/images/thumb/4/45/MQTT_Forward_1.png/600px-MQTT_Forward_1.png||height="348" width="600"]] 39 39 40 40 General MQTT structure 41 41 46 + 42 42 == 3.2 How sensor data is forwarded == 43 43 44 44 In this MQTT forward feature, the key point is how the gateway process the sensor data. 45 45 51 + 46 46 === 3.2.1 Upstream === 47 47 48 48 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. 49 49 56 +((( 50 50 The data flow works as below diagram. 58 +))) 51 51 52 52 [[~[~[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]] 53 53 62 +((( 54 54 Upstream path 64 +))) 55 55 66 +((( 56 56 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 +))) 57 57 70 +((( 71 + 72 +))) 73 + 58 58 === 3.2.2 Downstream === 59 59 60 60 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. 61 61 78 +((( 62 62 Below are the data flow for downstream. 80 +))) 63 63 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]]82 +[[image:https://wiki.dragino.com/images/thumb/3/3a/MQTT_Forward_3.png/600px-MQTT_Forward_3.png||height="368" width="600"]] 65 65 66 66 Downstream path 67 67 ... ... @@ -70,7 +70,9 @@ 70 70 71 71 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 72 72 73 -Currently the -t (topic) and -m (message) support Macros. 91 +((( 92 +Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros. 93 +))) 74 74 75 75 === 3.3.1 -t topic macro === 76 76 ... ... @@ -90,7 +90,7 @@ 90 90 91 91 === 3.3.3 Example for Macro === 92 92 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]]113 +[[image:https://wiki.dragino.com/images/thumb/c/c7/MQTT_Command_9.png/600px-MQTT_Command_9.png||height="385" width="600"]] 94 94 95 95 MQTT Publish configure 96 96 ... ... @@ -101,11 +101,13 @@ 101 101 102 102 When there is a LoRa sensor arrive. it will be store at the /var/iot/channels as below: 103 103 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]]124 +[[image:https://wiki.dragino.com/images/thumb/c/c4/MQTT_Command_20.png/600px-MQTT_Command_20.png||height="325" width="600"]] 105 105 106 106 Sensor Data 107 107 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. 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 +))) 109 109 110 110 111 111 == 3.4 Modify the MQTT to support more options == ... ... @@ -112,128 +112,134 @@ 112 112 113 113 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: 114 114 115 -{{{root@dragino-1ec39c:~# mosquitto_pub --help 137 +(% class="box" %) 138 +((( 139 +root@dragino-1ec39c:~~# mosquitto_pub ~-~-help 116 116 mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit. 117 117 mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4. 118 - 142 + 119 119 Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL} 120 120 {-f file | -l | -n | -m message} 121 - [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time] 145 + [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time] 122 122 [-A bind_address] 123 123 [-i id] [-I id_prefix] 124 - [-d] [--quiet] 148 + [-d] [~-~-quiet] 125 125 [-M max_inflight] 126 126 [-u username [-P password]] 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] 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] 135 135 [-D command identifier value] 136 - mosquitto_pub --help 137 - 138 - 160 + mosquitto_pub ~-~-help 161 + 162 +-A : bind the outgoing socket to this host/ip address. Use to control which interface 139 139 the client communicates over. 140 - 141 - 142 - 143 - 144 - 145 - 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 146 146 broker is using the clientid_prefixes option. 147 - 148 - 149 - mqtt(s)://[username[:password]@]host[:port]/topic 150 - 151 - 152 - 153 - 154 - 155 - 156 - 157 - 158 - 159 - 160 - 161 - 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]/topic 174 +-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. 162 162 Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311. 163 - 164 - 165 - 166 - 167 - 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 of 168 168 unexpected disconnection. If not given and will-topic is set, a zero 169 169 length message will be sent. 170 - 171 - 172 - 173 - 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 encrypted 174 174 communication. 175 - 199 +~-~-capath : path to a directory containing trusted CA certificates to enable encrypted 176 176 communication. 177 - 178 - 179 - 180 - 181 - 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. 182 182 Defaults to tlsv1.2 if available. 183 - 207 +~-~-insecure : do not check that the server certificate hostname matches the remote 184 184 hostname. Using this option means that you cannot be sure that the 185 185 remote host is the server you wish to connect to and so is insecure. 186 186 Do not use this option in a production environment. 187 - 188 - 189 - 190 - 191 - 192 - socks5h://[username[:password]@]hostname[:port] 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] 193 193 Only "none" and "username" authentication is supported. 194 - 195 -See https://mosquitto.org/ for more information.}}} 218 + 219 +See https:~/~/mosquitto.org/ for more information. 220 +))) 196 196 197 197 198 198 and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines: 199 199 200 -{{{# Call MQTT Publish command 201 - 202 -# 1. Case with User, Password and Client ID present (e.g. Azure) 225 +(% class="box" %) 226 +((( 227 +# Call MQTT Publish command 228 + 229 +# 1. Case with User, Password and Client ID present (e.g. Azure) 203 203 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 204 - 205 - 206 - 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 + 207 207 # 2. Case with Certificate, Key and ClientID present (e.g. AWS) 208 208 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then 209 - 210 - 211 - 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 + 212 212 # 3. Case with no User, Certificate or ClientID present 213 213 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then 214 - 215 - 216 - 241 +case="3" 242 +mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 243 + 217 217 # 4. Case with no User, Certificate, but with ClientID present 218 218 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then 219 - 220 - 221 - 246 +case="4" 247 +mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 248 + 222 222 # 5. Case with User and ClientID present, but no Password and no Certificate present 223 223 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 224 - 225 - 226 - 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 + 227 227 # 6. Case with User and Password present, but no ClientID and no Certificate present 228 228 elif [ ! -z "$user" ] && [ ! -z "$pass" ] && [ -z "$clientID" ] && [ -z "$certfile" ]; then 229 - 230 - 231 - 256 +case="6" 257 +mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic -u $user -P "$pass" $PUB_FLAG "$mqtt_data" 258 + 232 232 # 0. Else - invalid parameters, just log 233 233 else 234 - case="Invalid parameters" 235 - logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 236 -fi}}} 261 +case="Invalid parameters" 262 +logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 263 +fi 264 +))) 237 237 238 238 239 239 = 4. Example to communicate to a simple MQTT server = ... ... @@ -369,7 +369,6 @@ 369 369 downstream simulation 370 370 371 371 372 -\\ 373 373 374 374 == 4.5 Add LoRa support to communicate with remote sensor == 375 375 ... ... @@ -412,7 +412,8 @@ 412 412 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. 413 413 414 414 415 -\\Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 442 + 443 +Video Instruction:[[https:~~/~~/youtu.be/qJTY441-t90>>url:https://youtu.be/qJTY441-t90]] 416 416 417 417 418 418 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. ... ... @@ -493,7 +493,6 @@ 493 493 [[AWS Examples>>url:https://wiki.dragino.com/index.php/MQTT_Forward_to_Amazon_AWS-IOT]] 494 494 ))) 495 495 496 - 497 497 = 6. How to Debug = 498 498 499 499 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.