mqttdebug-tspspi

Name	mqttdebug-tspspi JSON
Version	0.0.1a2 JSON
	download
home_page	https://github.com/tspspi/mqttdebug
Summary	A simple MQTT debugging utility that allows subscribing to an arbitrary number of topics / publishing messages from the CLI
upload_time	2024-07-08 13:30:42
maintainer	None
docs_url	None
author	Thomas Spielauer
requires_python	>=3.6
license	None
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Simple MQTT debug helper

This is a simple tool that allows subscribing to an arbitrary number of
MQTT topics as well as publishing to an MQTT broker using a command line
utility.

## Example usage

### Configuration file

The configuration file that's sourced by both tools is supplied in JSON
format:

```
{
	"broker" : {
		"broker" : "example.com",
		"port" : 1883
	},
	"auth" : {
		"user" : "exampleuser",
		"password" : "examplepassword"
	}
}
```

### Subscribing to all topics

Dumping as plain text:

```
$ mqttsubscribe --cfg /path/to/configfile --topic "#"
```

Dumping as JSON:

```
$ mqttsubscribe --cfg /path/to/configfile --topic "#" --json
```

### Subscribing to specific topics

```
$ mqttsubscribe --cfg /path/to/configfile --topic "quakesr/experiment/camera/ebeam/raw/stored" --json
```

### Publishing a message from the CLI

```
$ mqttpublish --cfg /path/to/configfile --topic "examples/testtopic" --payload "Test payload"
```

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/tspspi/mqttdebug",
    "name": "mqttdebug-tspspi",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": null,
    "keywords": null,
    "author": "Thomas Spielauer",
    "author_email": "pypipackages01@tspi.at",
    "download_url": "https://files.pythonhosted.org/packages/28/9f/e2816d17b465ec96bdc4a1f128309e4e50cd4193b767d8cffcdba1b5408a/mqttdebug_tspspi-0.0.1a2.tar.gz",
    "platform": null,
    "description": "# Simple MQTT debug helper\n\nThis is a simple tool that allows subscribing to an arbitrary number of\nMQTT topics as well as publishing to an MQTT broker using a command line\nutility.\n\n## Example usage\n\n### Configuration file\n\nThe configuration file that's sourced by both tools is supplied in JSON\nformat:\n\n```\n{\n\t\"broker\" : {\n\t\t\"broker\" : \"example.com\",\n\t\t\"port\" : 1883\n\t},\n\t\"auth\" : {\n\t\t\"user\" : \"exampleuser\",\n\t\t\"password\" : \"examplepassword\"\n\t}\n}\n```\n\n### Subscribing to all topics\n\nDumping as plain text:\n\n```\n$ mqttsubscribe --cfg /path/to/configfile --topic \"#\"\n```\n\nDumping as JSON:\n\n```\n$ mqttsubscribe --cfg /path/to/configfile --topic \"#\" --json\n```\n\n### Subscribing to specific topics\n\n```\n$ mqttsubscribe --cfg /path/to/configfile --topic \"quakesr/experiment/camera/ebeam/raw/stored\" --json\n```\n\n### Publishing a message from the CLI\n\n```\n$ mqttpublish --cfg /path/to/configfile --topic \"examples/testtopic\" --payload \"Test payload\"\n```\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "A simple MQTT debugging utility that allows subscribing to an arbitrary number of topics / publishing messages from the CLI",
    "version": "0.0.1a2",
    "project_urls": {
        "Homepage": "https://github.com/tspspi/mqttdebug"
    },
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "68f1c8a9ce373e0f7627ff8218ca4602437615bec48d2ac53210e4b272b9d14e",
                "md5": "6e87a8985238fb9256d2b98e469990b2",
                "sha256": "182d8e0e940aa386849ebed55def28c10a579397e4fa385ac0b0c25ac66850ee"
            },
            "downloads": -1,
            "filename": "mqttdebug_tspspi-0.0.1a2-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "6e87a8985238fb9256d2b98e469990b2",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 6179,
            "upload_time": "2024-07-08T13:30:41",
            "upload_time_iso_8601": "2024-07-08T13:30:41.046265Z",
            "url": "https://files.pythonhosted.org/packages/68/f1/c8a9ce373e0f7627ff8218ca4602437615bec48d2ac53210e4b272b9d14e/mqttdebug_tspspi-0.0.1a2-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "289fe2816d17b465ec96bdc4a1f128309e4e50cd4193b767d8cffcdba1b5408a",
                "md5": "8c5fecd2c6dca64a32bdd73a0e9f972f",
                "sha256": "08e0d7f6529cbaa38037dd5758e5fbc55b5387c96f50b051b83164c353929c66"
            },
            "downloads": -1,
            "filename": "mqttdebug_tspspi-0.0.1a2.tar.gz",
            "has_sig": false,
            "md5_digest": "8c5fecd2c6dca64a32bdd73a0e9f972f",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 4624,
            "upload_time": "2024-07-08T13:30:42",
            "upload_time_iso_8601": "2024-07-08T13:30:42.872771Z",
            "url": "https://files.pythonhosted.org/packages/28/9f/e2816d17b465ec96bdc4a1f128309e4e50cd4193b767d8cffcdba1b5408a/mqttdebug_tspspi-0.0.1a2.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-07-08 13:30:42",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "tspspi",
    "github_project": "mqttdebug",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "lcname": "mqttdebug-tspspi"
}