MQTT Recorder

Simple cli tool for recording and replaying MQTT messages.

Install

pip install mqtt-recorder

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

mqtt-recorder --host localhost --mode record --file recording.csv

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"
    ]
}

mqtt-recorder --host localhost --mode replay --file test.csv

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution for mqtt-recorder 1.4.0
File	Size	Uploaded
mqtt_recorder-1.4.0.tar.gz	5.3 kB	Dec 13, 2024	Details

Table of built distributions (wheels) for mqtt-recorder 1.4.0
File	Interpreter	ABI	Platform	Reset
mqtt_recorder-1.4.0-py3-none-any.whl 6.8 kB Dec 13, 2024	Python 3	none	any	Details

Total release size: 12.2 kB

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	Dec 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.0.1 CPython/3.11.4`

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	Dec 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.0.1 CPython/3.11.4`