| Library version: | 0.4.0 |
|---|---|
| Library scope: | global |
| Named arguments: | supported |
A keyword library for Robot Framework. It provides keywords for performing various operations on an MQTT broker. See http://mqtt.org/ for more details on MQTT specification.
This library uses eclipse project's paho client. For more information on underlying methods and documentation, see: http://eclipse.org/paho/clients/python/docs/
| Arguments | Documentation |
|---|---|
| loop_timeout=5 seconds |
| Keyword | Arguments | Documentation | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Connect | broker, port=1883, client_id=, clean_session=True | Connect to an MQTT broker. This is a pre-requisite step for publish and subscribe keywords. broker MQTT broker host port broker port (default 1883) client_id if not specified, a random id is generated clean_session specifies the clean session flag for the connection Examples: Connect to a broker with default port and client id
Connect to a broker by specifying the port and client id explicitly
Connect to a broker with clean session flag set to false
| |||||||||||||||||||||||||
| Disconnect | Disconnect from MQTT Broker. Example:
| ||||||||||||||||||||||||||
| Publish | topic, message=None, qos=0, retain=False | Publish a message to a topic with specified qos and retained flag. It is required that a connection has been established using Connect keyword before using this keyword. topic topic to which the message will be published message message payload to publish qos qos of the message retain retained flag Examples:
| |||||||||||||||||||||||||
| Publish Multiple | msgs, hostname=localhost, port=1883, client_id=, keepalive=60, will=None, auth=None, tls=None, protocol=3 | Publish multiple messages and disconnect. This keyword uses the multiple function of publish module. msgs a list of messages to publish. Each message is either a dict or a tuple. If a dict, it must be of the form: msg = {'topic':"<topic>", 'payload':"<payload>", 'qos':<qos>, 'retain':<retain>} Only the topic must be present. Default values will be used for any missing arguments. If a tuple, then it must be of the form: ("<topic>", "<payload>", qos, retain) See publish single for the description of hostname, port, client_id, keepalive, will, auth, tls, protocol. Example:
| |||||||||||||||||||||||||
| Publish Single | topic, payload=None, qos=0, retain=False, hostname=localhost, port=1883, client_id=, keepalive=60, will=None, auth=None, tls=None, protocol=3 | Publish a single message and disconnect. This keyword uses the single function of publish module. topic topic to which the message will be published payload message payload to publish (default None) qos qos of the message (default 0) retain retain flag (True or False, default False) hostname MQTT broker host (default localhost) port broker port (default 1883) client_id if not specified, a random id is generated keepalive keepalive timeout value for client will a dict containing will parameters for client: will = {'topic': "<topic>", 'payload':"<payload">, 'qos':<qos>, 'retain':<retain>} auth a dict containing authentication parameters for the client: auth = {'username':"<username>", 'password':"<password>"} tls a dict containing TLS configuration parameters for the client: dict = {'ca_certs':"<ca_certs>", 'certfile':"<certfile>", 'keyfile':"<keyfile>", 'tls_version':"<tls_version>", 'ciphers':"<ciphers">} protocol MQTT protocol version (MQTTv31 or MQTTv311) Example: Publish a message on specified topic and disconnect:
| |||||||||||||||||||||||||
| Subscribe | topic, qos, timeout=1, limit=1 | Subscribe to a topic and return a list of message payloads received within the specified time. topic topic to subscribe to qos quality of service for the subscription timeout duration of subscription limit the max number of payloads that will be returned. Specify 0 for no limit Examples: Subscribe and get a list of all messages received within 5 seconds
Subscribe and get 1st message received within 60 seconds
| |||||||||||||||||||||||||
| Subscribe And Validate | topic, qos, payload, timeout=1 | Subscribe to a topic and validate that the specified payload is received within timeout. It is required that a connection has been established using Connect keyword. The payload can be specified as a python regular expression. If the specified payload is not received within timeout, an AssertionError is thrown. topic topic to subscribe to qos quality of service for the subscription payload payload (message) that is expected to arrive timeout time to wait for the payload to arrive Examples:
| |||||||||||||||||||||||||
| Unsubscribe | topic | Unsubscribe the client from the specified topic. topic topic to unsubscribe from Example:
|