Skip to main content

MQTT recorder tool

Project description

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
--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

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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mqtt-recorder-1.3.0.tar.gz (5.0 kB view details)

Uploaded Source

Built Distribution

mqtt_recorder-1.3.0-py3-none-any.whl (6.5 kB view details)

Uploaded Python 3

File details

Details for the file mqtt-recorder-1.3.0.tar.gz.

File metadata

  • Download URL: mqtt-recorder-1.3.0.tar.gz
  • Upload date:
  • Size: 5.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.10.4

File hashes

Hashes for mqtt-recorder-1.3.0.tar.gz
Algorithm Hash digest
SHA256 a6aced725ca914b7c7d52bc37b3f3841eccacaf3ab0417a9283eb880c6abfccc
MD5 1ae9c5250ff8397886c461129c0bcbcd
BLAKE2b-256 a8417ef6a0710ca8ecfd80acdde8f7306f90160fa803681d73cbfde361ef9aa5

See more details on using hashes here.

File details

Details for the file mqtt_recorder-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for mqtt_recorder-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 40143ef2bcd10631637fee9c5f2c399bfc65d4422f706fd458b161524a9c3d0e
MD5 5aaee6ef482e92e5febeb22c6355dc5d
BLAKE2b-256 2812c8184e44e9075fe0084cdff566a9c30c038076c2af279b96dd65bf5caf69

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page