Python based MQTT to SQLite3 logger
Project description
MQTT to SQLite Logger
Installation
pip install mqtt-logger
Example Usage
Recording MQTT Messages
This example records messages to the test/#
topic using a public MQTT broker. It will record for 10 seconds. If you are using a private broker, you may need to set the username
and password
parameters.
import mqtt_logger
import os
import time
# Initalise mqtt recorder object
rec = mqtt_logger.Recorder(
sqlite_database_path=os.path.join(os.path.dirname(__file__), "MQTT_log.db"),
topics=["test/#"],
broker_address="broker.hivemq.com",
verbose=True,
# username="username",
# password="password",
)
# Start the logger, wait 10 seconds and stop the logger
rec.start()
time.sleep(10)
rec.stop()
Playback Recorded MQTT Messages
This example plays back previously recorded MQTT messages from mqtt_logger.Recorder
. If you are using a private broker, you may need to set the username
and password
parameters.
import mqtt_logger
import os
# Initalise playback object
playback = mqtt_logger.Playback(
sqlite_database_path=os.path.join(os.path.dirname(__file__), "MQTT_log.db"),
broker_address="broker.hivemq.com",
verbose=True,
# username="username",
# password="password",
)
# Start playback at 2x speed (twice as fast)
playback.play(speed=2)
Unit Tests
# Run tests in poetry virtual environment
poetry run pytest
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
mqtt_logger-0.1.2.tar.gz
(5.3 kB
view hashes)
Built Distribution
Close
Hashes for mqtt_logger-0.1.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 018d5998dcb3c39feff8df4a76d3d8440bb11f7f1661e00a0ad784e930878d23 |
|
MD5 | 1050108e6418469fac7a8998a3d9a145 |
|
BLAKE2b-256 | efb5b3aac58a29d36d0048f01f130f046f521896302022e76ac147b85fe2e86e |