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