robotframework-mqtt5library


Namerobotframework-mqtt5library JSON
Version 0.8.3 PyPI version JSON
download
home_page
SummaryMQTT5Library is a Robot Framework library that provides keywords for testing on MQTTv5 brokers.
upload_time2023-01-27 15:27:41
maintainer
docs_urlNone
author
requires_python>=3.7
license
keywords robotframework testing testautomation mqtt
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            MQTTLibrary for Robot Framework
===============================

[![image](https://travis-ci.org/randomsync/robotframework-mqttlibrary.svg?branch=master)](https://travis-ci.org/randomsync/robotframework-mqttlibrary)

[![image](https://badge.fury.io/py/robotframework-mqttlibrary.svg)](https://badge.fury.io/py/robotframework-mqttlibrary)

MQTTLibrary is a [Robot Framework](http://robotframework.org) library
that provides keywords for testing on MQTT brokers.
[MQTT](http://mqtt.org/) is a lightweight protocol for
machine-to-machine communication, typically used for IoT messaging. This
library uses the [paho](https://eclipse.org/paho/) client library
published by eclipse project.

Installation
------------

MQTTLibrary can be installed using [pip](http://pip-installer.org):

    pip install robotframework-mqtt5library

Usage
-----

Import the library:

``` {.robotframework}
*** Settings ***
Library          MQTTLibrary
```

Connect to the broker, publish and disconnect:

``` {.robotframework}
*** Test Cases ***
Publish
    Connect    ${brokerhost}    ${brokerport}    ca_cert=${ca_cert}    certfile=${certfile}    keyfile=${keyfile}
    Publish     topic=test/mqtt_test    message=test message
    [Teardown]  Disconnect
```

Connect to the broker, subscribe and validate that a message is
received:

``` {.robotframework}
*** Test Cases ***
Subscribe and Validate
    Connect    ${brokerhost}    ${brokerport}    ca_cert=${ca_cert}    certfile=${certfile}    keyfile=${keyfile}
    Subscribe and Validate  topic=test/mqtt_test    qos=2   payload=test
    [Teardown]              Disconnect
```

Keyword documentation is available at:
<http://kemilsoderberg.github.io/robotframework-mqtt5library>.

For general information about using test libraries with Robot Framework,
see [Robot Framework User
Guide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#using-test-libraries).

Contributing
------------

The keywords in this library are based on some of the methods available
in eclipse paho client library. If you\'d like to add keywords, see
[instructions]() on creating/updating libraries for Robot Framework.

License
-------

MQTT5Library is open source software provided under the [Apache License
2.0](http://apache.org/licenses/LICENSE-2.0).

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "robotframework-mqtt5library",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.7",
    "maintainer_email": "",
    "keywords": "robotframework,testing,testautomation,mqtt",
    "author": "",
    "author_email": "Gaurav Gupta <gaurav@randomsync.net>, Emil S\u00f6derberg <emil@stutt.se>",
    "download_url": "https://files.pythonhosted.org/packages/63/1f/df2c3d68d09cf8d732d6a1e6cc018e3b2f78692a8488b5f8f717fab0a891/robotframework-mqtt5library-0.8.3.tar.gz",
    "platform": null,
    "description": "MQTTLibrary for Robot Framework\n===============================\n\n[![image](https://travis-ci.org/randomsync/robotframework-mqttlibrary.svg?branch=master)](https://travis-ci.org/randomsync/robotframework-mqttlibrary)\n\n[![image](https://badge.fury.io/py/robotframework-mqttlibrary.svg)](https://badge.fury.io/py/robotframework-mqttlibrary)\n\nMQTTLibrary is a [Robot Framework](http://robotframework.org) library\nthat provides keywords for testing on MQTT brokers.\n[MQTT](http://mqtt.org/) is a lightweight protocol for\nmachine-to-machine communication, typically used for IoT messaging. This\nlibrary uses the [paho](https://eclipse.org/paho/) client library\npublished by eclipse project.\n\nInstallation\n------------\n\nMQTTLibrary can be installed using [pip](http://pip-installer.org):\n\n    pip install robotframework-mqtt5library\n\nUsage\n-----\n\nImport the library:\n\n``` {.robotframework}\n*** Settings ***\nLibrary          MQTTLibrary\n```\n\nConnect to the broker, publish and disconnect:\n\n``` {.robotframework}\n*** Test Cases ***\nPublish\n    Connect    ${brokerhost}    ${brokerport}    ca_cert=${ca_cert}    certfile=${certfile}    keyfile=${keyfile}\n    Publish     topic=test/mqtt_test    message=test message\n    [Teardown]  Disconnect\n```\n\nConnect to the broker, subscribe and validate that a message is\nreceived:\n\n``` {.robotframework}\n*** Test Cases ***\nSubscribe and Validate\n    Connect    ${brokerhost}    ${brokerport}    ca_cert=${ca_cert}    certfile=${certfile}    keyfile=${keyfile}\n    Subscribe and Validate  topic=test/mqtt_test    qos=2   payload=test\n    [Teardown]              Disconnect\n```\n\nKeyword documentation is available at:\n<http://kemilsoderberg.github.io/robotframework-mqtt5library>.\n\nFor general information about using test libraries with Robot Framework,\nsee [Robot Framework User\nGuide](http://robotframework.org/robotframework/latest/RobotFrameworkUserGuide.html#using-test-libraries).\n\nContributing\n------------\n\nThe keywords in this library are based on some of the methods available\nin eclipse paho client library. If you\\'d like to add keywords, see\n[instructions]() on creating/updating libraries for Robot Framework.\n\nLicense\n-------\n\nMQTT5Library is open source software provided under the [Apache License\n2.0](http://apache.org/licenses/LICENSE-2.0).\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "MQTT5Library is a Robot Framework library that provides keywords for testing on MQTTv5 brokers.",
    "version": "0.8.3",
    "split_keywords": [
        "robotframework",
        "testing",
        "testautomation",
        "mqtt"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "30a35327a084f8a699518095db9878f088ec35268118db523e9756a119cb00ed",
                "md5": "380130307be3d6ac6dcf64e162c30ecd",
                "sha256": "a063eee047d724e9a2edbfa6f8214226e6e696e10f30afd4b7831303fc13dd98"
            },
            "downloads": -1,
            "filename": "robotframework_mqtt5library-0.8.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "380130307be3d6ac6dcf64e162c30ecd",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.7",
            "size": 11445,
            "upload_time": "2023-01-27T15:27:37",
            "upload_time_iso_8601": "2023-01-27T15:27:37.578153Z",
            "url": "https://files.pythonhosted.org/packages/30/a3/5327a084f8a699518095db9878f088ec35268118db523e9756a119cb00ed/robotframework_mqtt5library-0.8.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "631fdf2c3d68d09cf8d732d6a1e6cc018e3b2f78692a8488b5f8f717fab0a891",
                "md5": "b9c7e000e598be387494e21a5d0147e6",
                "sha256": "67540cec101763569cc018d5cb4b56699f19a2d8c511c348f3cbf49fb09b8649"
            },
            "downloads": -1,
            "filename": "robotframework-mqtt5library-0.8.3.tar.gz",
            "has_sig": false,
            "md5_digest": "b9c7e000e598be387494e21a5d0147e6",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.7",
            "size": 11554,
            "upload_time": "2023-01-27T15:27:41",
            "upload_time_iso_8601": "2023-01-27T15:27:41.636019Z",
            "url": "https://files.pythonhosted.org/packages/63/1f/df2c3d68d09cf8d732d6a1e6cc018e3b2f78692a8488b5f8f717fab0a891/robotframework-mqtt5library-0.8.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-01-27 15:27:41",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "lcname": "robotframework-mqtt5library"
}
        
Elapsed time: 0.03692s