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