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
Topics can be selected using a json file.
Example
{
"topics": [
"/myhome/groundfloor/livingroom/temperature",
"USA/California/San Francisco/Silicon Valley"
]
}
Replaying
mqtt-recorder --host localhost --mode replay --file test.csv
1 maintainer
Metadata
1 maintainer
Release files for mqtt-recorder 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| mqtt_recorder-1.4.0.tar.gz | 5.3 kB | Without provenance | Details for mqtt_recorder-1.4.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| mqtt_recorder-1.4.0-py3-none-any.whl | Python 3 | none | any | Details for mqtt_recorder-1.4.0-py3-none-any.whl |
Total release size: 12.2 kB
Release files / mqtt_recorder-1.4.0.tar.gz
| Download URL | mqtt_recorder-1.4.0.tar.gz |
|---|---|
| Size | 5.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
c7f872fe9a29efc3d39287cea6bd47f822e7abfa82ca3f2db69b805e78d8050d
|
|
BLAKE2b-256 checksum How to use checksums |
686cf62d7cb70738ff0a26784f2b12666b6c743408bc39cdd37e3874b2230b2d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.4
|
Release files / mqtt_recorder-1.4.0-py3-none-any.whl
| Download URL | mqtt_recorder-1.4.0-py3-none-any.whl |
|---|---|
| Size | 6.8 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4d832e6551315f96ca44f426e582c7b0ff1c1a6df4710ae9f597b2574f685c4f
|
|
BLAKE2b-256 checksum How to use checksums |
58391e6c715be2c9e844e94231edbdd999af0a464a6544b84d9b085f4354b166
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.0.1 CPython/3.11.4
|
Security for mqtt-recorder 1.4.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
