| Name | mqtt-recorder JSON |
| Version |
1.4.0
JSON |
| download |
| home_page | None |
| Summary | MQTT recorder tool |
| upload_time | 2024-12-13 16:41:53 |
| maintainer | None |
| docs_url | None |
| author | RPDSWTK |
| requires_python | >=3.7 |
| license | MIT License Copyright (c) 2020 RPDSWTK Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. |
| keywords |
feed
reader
tutorial
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# MQTT Recorder
Simple cli tool for recording and replaying MQTT messages.
# Install
`pip install mqtt-recorder`
## Usage
| Argument | Description | Required | Default |
| ---------------------- | -------------------------------------------------------- | -------- | ------- |
| -h, --help | Show help | | |
| --host | MQTT broker address | x | |
| --port | MQTT broker port | | 1883 |
| --client_id | MQTT Client ID | | |
| --mode | mode: record/replay | x | |
| --file | output/input csv file | x | |
| --loop | looping replay | | false |
| --qos | Quality of Service that will be used for subscriptions | | 0 |
| --topics | json file containing selected topics for subscriptions | | null |
| -t, --topic | Single topic to subscribe to | | null |
| --enable_ssl | True to enable MQTTs support, False otherwise | | False |
| --tls_insecure | If certs is self-generated, change to True | | False |
| --ca_cert | Path to the Certificate Authority certificate files | | None |
| --certfile | Path to the client certificate | | None |
| --keyfile | Path to the client private key | | None |
| --username | MQTT broker username | | None |
| --password | MQTT broker password | | None |
| --encode_b64 | True to store message payloads as base64 encoded strings | | False |
| --csv_field_size_limit | CSV field size limit | | False |
### Recording
#### Subscribing to every topic
`mqtt-recorder --host localhost --mode record --file recording.csv`
#### Subscribing to selected topics
`mqtt-recorder --host localhost --mode record --file test.csv --topics topics.json`<br>
Topics can be selected using a json file.
Example
```json
{
"topics": [
"/myhome/groundfloor/livingroom/temperature",
"USA/California/San Francisco/Silicon Valley"
]
}
```
### Replaying
`mqtt-recorder --host localhost --mode replay --file test.csv`
Raw data
{
"_id": null,
"home_page": null,
"name": "mqtt-recorder",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "feed, reader, tutorial",
"author": "RPDSWTK",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/68/6c/f62d7cb70738ff0a26784f2b12666b6c743408bc39cdd37e3874b2230b2d/mqtt_recorder-1.4.0.tar.gz",
"platform": null,
"description": "# MQTT Recorder\r\n\r\nSimple cli tool for recording and replaying MQTT messages.\r\n\r\n# Install\r\n\r\n`pip install mqtt-recorder`\r\n\r\n## Usage\r\n| Argument | Description | Required | Default |\r\n| ---------------------- | -------------------------------------------------------- | -------- | ------- |\r\n| -h, --help | Show help | | |\r\n| --host | MQTT broker address | x | |\r\n| --port | MQTT broker port | | 1883 |\r\n| --client_id | MQTT Client ID | | |\r\n| --mode | mode: record/replay | x | |\r\n| --file | output/input csv file | x | |\r\n| --loop | looping replay | | false |\r\n| --qos | Quality of Service that will be used for subscriptions | | 0 |\r\n| --topics | json file containing selected topics for subscriptions | | null |\r\n| -t, --topic | Single topic to subscribe to | | null |\r\n| --enable_ssl | True to enable MQTTs support, False otherwise | | False |\r\n| --tls_insecure | If certs is self-generated, change to True | | False |\r\n| --ca_cert | Path to the Certificate Authority certificate files | | None |\r\n| --certfile | Path to the client certificate | | None |\r\n| --keyfile | Path to the client private key | | None |\r\n| --username | MQTT broker username | | None |\r\n| --password | MQTT broker password | | None |\r\n| --encode_b64 | True to store message payloads as base64 encoded strings | | False |\r\n| --csv_field_size_limit | CSV field size limit | | False |\r\n\r\n### Recording\r\n#### Subscribing to every topic\r\n`mqtt-recorder --host localhost --mode record --file recording.csv`\r\n#### Subscribing to selected topics\r\n`mqtt-recorder --host localhost --mode record --file test.csv --topics topics.json`<br>\r\nTopics can be selected using a json file.\r\nExample\r\n```json\r\n{\r\n \"topics\": [\r\n \"/myhome/groundfloor/livingroom/temperature\",\r\n \"USA/California/San Francisco/Silicon Valley\"\r\n ]\r\n}\r\n```\r\n### Replaying\r\n`mqtt-recorder --host localhost --mode replay --file test.csv`\r\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2020 RPDSWTK Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.",
"summary": "MQTT recorder tool",
"version": "1.4.0",
"project_urls": {
"Homepage": "https://github.com/rpdswtk/mqtt_recorder"
},
"split_keywords": [
"feed",
" reader",
" tutorial"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58391e6c715be2c9e844e94231edbdd999af0a464a6544b84d9b085f4354b166",
"md5": "febbf3528ae2debbb9cee085e775984b",
"sha256": "4d832e6551315f96ca44f426e582c7b0ff1c1a6df4710ae9f597b2574f685c4f"
},
"downloads": -1,
"filename": "mqtt_recorder-1.4.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "febbf3528ae2debbb9cee085e775984b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 6844,
"upload_time": "2024-12-13T16:41:52",
"upload_time_iso_8601": "2024-12-13T16:41:52.196996Z",
"url": "https://files.pythonhosted.org/packages/58/39/1e6c715be2c9e844e94231edbdd999af0a464a6544b84d9b085f4354b166/mqtt_recorder-1.4.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "686cf62d7cb70738ff0a26784f2b12666b6c743408bc39cdd37e3874b2230b2d",
"md5": "c580f39c8c7b71c7444aefc169bc6f6a",
"sha256": "c7f872fe9a29efc3d39287cea6bd47f822e7abfa82ca3f2db69b805e78d8050d"
},
"downloads": -1,
"filename": "mqtt_recorder-1.4.0.tar.gz",
"has_sig": false,
"md5_digest": "c580f39c8c7b71c7444aefc169bc6f6a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 5327,
"upload_time": "2024-12-13T16:41:53",
"upload_time_iso_8601": "2024-12-13T16:41:53.786025Z",
"url": "https://files.pythonhosted.org/packages/68/6c/f62d7cb70738ff0a26784f2b12666b6c743408bc39cdd37e3874b2230b2d/mqtt_recorder-1.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-13 16:41:53",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rpdswtk",
"github_project": "mqtt_recorder",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "mqtt-recorder"
}
