Collect data from Hitchi Smartmeter and expose it via MQTT
Project description
pysmartmeter
Collect data from Hitchi Smartmeter (USB Version) and expose it via MQTT.
quickstart
~$ git clone https://github.com/jedie/pysmartmeter.git
~$ cd pysmartmeter
~/pysmartmeter$ make install-poetry
~/pysmartmeter$ make install
~/pysmartmeter$ ./cli.sh --help
+ exec .venv/bin/python -m pysmartmeter --help
PySmartMeter v0.1.0
Usage: python -m pysmartmeter [OPTIONS] COMMAND [ARGS]...
╭─ Options ─────────────────────────────────────────────────────────────────────────────────────────╮
│ --install-completion [bash|zsh|fish|powershell|pwsh] Install completion for the specified │
│ shell. │
│ [default: None] │
│ --show-completion [bash|zsh|fish|powershell|pwsh] Show completion for the specified │
│ shell, to copy it or customize the │
│ installation. │
│ [default: None] │
│ --help Show this message and exit. │
╰───────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ────────────────────────────────────────────────────────────────────────────────────────╮
│ check-code-style │
│ coverage Run and show coverage. │
│ debug-settings Display (anonymized) MQTT server username and password │
│ debug-systemd-service Just print the systemd service file content │
│ detect-serial Just print the detected serial port instance │
│ dump Just dump serial output │
│ fix-code-style Fix code style via darker │
│ mypy Run Mypy (configured in pyproject.toml) │
│ publish-loop Publish current data via MQTT (endless loop) │
│ setup-systemd-service Setup PySmartMeter systemd services and starts it. │
│ store-settings Store MQTT server settings. │
│ systemd-status Call systemd status of PySmartMeter services │
│ systemd-stop Stop PySmartMeter systemd services │
│ test Run unittests │
╰───────────────────────────────────────────────────────────────────────────────────────────────────╯
Test if you Hitchi Smartmeter with CP2102 USB to UART Bridge Controller works, e.g.:
~/pysmartmeter $ ./cli.sh dump
Maybe you have to setup permissions, e.g.:
sudo chmod +r /dev/ttyUSB0
publish smartmeter data via MQTT
You have to store your MQTT settings (host, port, username, password) one time, e.g.:
~/pysmartmeter$ ./cli.sh store-settings
Setup systemd service:
~/pysmartmeter$ sudo ./cli.sh setup-systemd-service
various links
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
pysmartmeter-0.1.0.tar.gz
(29.8 kB
view hashes)
Built Distribution
Close
Hashes for pysmartmeter-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c50968824905de9a3c237f303caaf6224c7822a3208ad48f2c6f7b005d61fdf8 |
|
MD5 | 3070e3e60211527b073265b92dfd6895 |
|
BLAKE2b-256 | 5388188b9b0443a678cf10593f2613a298bca2a2c2ed231f51af74ba5986253f |