|
| 1 | +#PHPMQTT CLI |
| 2 | + |
| 3 | +``` |
| 4 | + ____ _ _ ____ __ __ ___ _____ _____ |
| 5 | + | _ \| | | | _ \| \/ |/ _ \_ _|_ _| |
| 6 | + | |_) | |_| | |_) | |\/| | | | || | | | |
| 7 | + | __/| _ | __/| | | | |_| || | | | |
| 8 | + |_| |_| |_|_| |_| |_|\__\_\|_| |_| |
| 9 | +``` |
| 10 | + |
| 11 | +##Install |
| 12 | + |
| 13 | +```bash |
| 14 | +composer require simps/mqtt-cli |
| 15 | +``` |
| 16 | + |
| 17 | +##Usage |
| 18 | + |
| 19 | +###Publish |
| 20 | + |
| 21 | +```bash |
| 22 | +$ php bin/mqtt publish --help |
| 23 | +Description: |
| 24 | + Publishing simple messages |
| 25 | + |
| 26 | +Usage: |
| 27 | + publish [options] |
| 28 | + |
| 29 | +Options: |
| 30 | + -H, --host[=HOST] Specify the host to connect to [default:"localhost"] |
| 31 | + -P, --port[=PORT] Connect to the port specified [default: 1883] |
| 32 | + -t, --topic=TOPIC The MQTT topic on which to publish the message |
| 33 | + -m, --message=MESSAGE Send a single message from thecommand line |
| 34 | + -i, --id[=ID] The id to usefor this client [default:""] |
| 35 | + --qos[=QOS] Specify the quality of service to usefor the message, from 0, 1 and 2 [default: 0] |
| 36 | + --dup[=DUP] If the DUP flag isset to 0, it indicates that this is the first occasion that the Client or Server has attempted to send this PUBLISH packet [default: 0] |
| 37 | + -r, --retain[=RETAIN] If the RETAIN flag isset to 1in a PUBLISH packet sent by a Client to a Server, the Server MUST replace any existing retained messagefor this topic and store the Application Message [default: 0] |
| 38 | + -u, --username[=USERNAME] Provide a username to be usedfor authenticating with the broker |
| 39 | + -p, --pw[=PW] Provide a password to be usedfor authenticating with the broker |
| 40 | + -c, --clean-session[=CLEAN-SESSION] Setting the'clean session' flag [default: true] |
| 41 | + -l, --level=LEVEL MQTT Protocol level [default: 4] |
| 42 | + -k, --keepalive[=KEEPALIVE] The number of seconds between sending PING commands to the brokerfor the purposes of informing it we are still connected and functioning [default: 0] |
| 43 | + --will-topic[=WILL-TOPIC] The topic on which to send a Will,in the event that the client disconnects unexpectedly |
| 44 | + --will-message[=WILL-MESSAGE] Specify a message that will be stored by the broker and sent outif this client disconnects unexpectedly |
| 45 | + --will-qos[=WILL-QOS] The QoS to usefor the Will [default: 0] |
| 46 | + --will-retain[=WILL-RETAIN] If given,if the client disconnects unexpectedly the message sent out will be treated as a retained message [default: 0] |
| 47 | + -S, --ssl[=SSL] Enable SSL encryption [default: false] |
| 48 | + --config-path[=CONFIG-PATH] Setting the Swoole config file path |
| 49 | + --properties-path[=PROPERTIES-PATH] Setting the Properties config file path |
| 50 | + -h, --help Displayhelpfor the given command. When nocommand is given displayhelpfor the listcommand |
| 51 | + -q, --quiet Do not output any message |
| 52 | + -V, --version Display this application version |
| 53 | + --ansi Force ANSI output |
| 54 | + --no-ansi Disable ANSI output |
| 55 | + -n, --no-interaction Do not ask any interactive question |
| 56 | + -v|vv|vvv, --verbose Increase the verbosity of messages: 1for normal output, 2for more verbose output and 3for debug |
| 57 | + |
| 58 | +Help: |
| 59 | + An MQTT version 3.1/3.1.1/5.0 clientfor publishing simple messages |
| 60 | +``` |