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
-
... ... @@ -88,7 +88,9 @@ 88 88 89 89 The MQTT publish command use Macro settings to generate flexible upstream payload for MQTT publish. 90 90 91 +((( 91 91 Currently the (% class="mark" %)**-t (topic)**(%%) and (% class="mark" %)**-m (message)**(%%) support Macros. 93 +))) 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"~]~]>>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"]] 112 112 113 113 MQTT Publish configure 114 114 ... ... @@ -119,11 +119,13 @@ 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"~]~]>>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"]] 123 123 124 124 Sensor Data 125 125 126 -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 +))) 127 127 128 128 129 129 == 3.4 Modify the MQTT to support more options == ... ... @@ -130,128 +130,134 @@ 130 130 131 131 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: 132 132 133 -{{{root@dragino-1ec39c:~# mosquitto_pub --help 137 +(% class="box" %) 138 +((( 139 +root@dragino-1ec39c:~~# mosquitto_pub ~-~-help 134 134 mosquitto_pub is a simple mqtt client that will publish a message on a single topic and exit. 135 135 mosquitto_pub version 1.6.4 running on libmosquitto 1.6.4. 136 - 142 + 137 137 Usage: mosquitto_pub {[-h host] [-p port] [-u username] [-P password] -t topic | -L URL} 138 138 {-f file | -l | -n | -m message} 139 - [-c] [-k keepalive] [-q qos] [-r] [--repeat N] [--repeat-delay time] 145 + [-c] [-k keepalive] [-q qos] [-r] [~-~-repeat N] [~-~-repeat-delay time] 140 140 [-A bind_address] 141 141 [-i id] [-I id_prefix] 142 - [-d] [--quiet] 148 + [-d] [~-~-quiet] 143 143 [-M max_inflight] 144 144 [-u username [-P password]] 145 - [--will-topic [--will-payload payload] [--will-qos qos] [--will-retain]] 146 - [{--cafile file | --capath dir} [--cert file] [--key file] 147 - [--ciphers ciphers] [--insecure] 148 - [--tls-alpn protocol] 149 - [--tls-engine engine] [--keyform keyform] [--tls-engine-kpass-sha1]] 150 - [--psk hex-key --psk-identity identity [--ciphers ciphers]] 151 - [--proxy socks-url] 152 - [--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] 153 153 [-D command identifier value] 154 - mosquitto_pub --help 155 - 156 - 160 + mosquitto_pub ~-~-help 161 + 162 +-A : bind the outgoing socket to this host/ip address. Use to control which interface 157 157 the client communicates over. 158 - 159 - 160 - 161 - 162 - 163 - 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 164 164 broker is using the clientid_prefixes option. 165 - 166 - 167 - mqtt(s)://[username[:password]@]host[:port]/topic 168 - 169 - 170 - 171 - 172 - 173 - 174 - 175 - 176 - 177 - 178 - 179 - 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. 180 180 Can be mqttv5, mqttv311 or mqttv31. Defaults to mqttv311. 181 - 182 - 183 - 184 - 185 - 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 186 186 unexpected disconnection. If not given and will-topic is set, a zero 187 187 length message will be sent. 188 - 189 - 190 - 191 - 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 192 192 communication. 193 - 199 +~-~-capath : path to a directory containing trusted CA certificates to enable encrypted 194 194 communication. 195 - 196 - 197 - 198 - 199 - 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. 200 200 Defaults to tlsv1.2 if available. 201 - 207 +~-~-insecure : do not check that the server certificate hostname matches the remote 202 202 hostname. Using this option means that you cannot be sure that the 203 203 remote host is the server you wish to connect to and so is insecure. 204 204 Do not use this option in a production environment. 205 - 206 - 207 - 208 - 209 - 210 - 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] 211 211 Only "none" and "username" authentication is supported. 212 - 213 -See https://mosquitto.org/ for more information.}}} 218 + 219 +See https:~/~/mosquitto.org/ for more information. 220 +))) 214 214 215 215 216 216 and modify the /usr/bin/mqtt_process.sh script, the location to change the command option is below lines: 217 217 218 -{{{# Call MQTT Publish command 219 - 220 -# 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) 221 221 if [ ! -z "$pass" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 222 - 223 - 224 - 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 + 225 225 # 2. Case with Certificate, Key and ClientID present (e.g. AWS) 226 226 elif [ ! -z "$certfile" ] && [ ! -z "$key" ] && [ ! -z "$clientID" ]; then 227 - 228 - 229 - 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 + 230 230 # 3. Case with no User, Certificate or ClientID present 231 231 elif [ -z "$user" ] && [ -z "$certfile" ] && [ -z "$clientID" ]; then 232 - 233 - 234 - 241 +case="3" 242 +mosquitto_pub $D -h $server -p $port -q $pub_qos -t $pub_topic $PUB_FLAG "$mqtt_data" 243 + 235 235 # 4. Case with no User, Certificate, but with ClientID present 236 236 elif [ -z "$user" ] && [ -z "$certfile" ] && [ ! -z "$clientID" ]; then 237 - 238 - 239 - 246 +case="4" 247 +mosquitto_pub $D -h $server -p $port -q $pub_qos -i $clientID -t $pub_topic $PUB_FLAG "$mqtt_data" 248 + 240 240 # 5. Case with User and ClientID present, but no Password and no Certificate present 241 241 elif [ -z "$pass" ] && [ -z "$certfile" ] && [ ! -z "$user" ] && [ ! -z "$clientID" ]; then 242 - 243 - 244 - 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 + 245 245 # 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 - 248 - 249 - 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 + 250 250 # 0. Else - invalid parameters, just log 251 251 else 252 - case="Invalid parameters" 253 - logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 254 -fi}}} 261 +case="Invalid parameters" 262 +logger "[IoT.MQTT]:Invalid Parameters - mosquitto_pub not called." 263 +fi 264 +))) 255 255 256 256 257 257 = 4. Example to communicate to a simple MQTT server =