https://github.com/jedie/pysmartmeter
Collect data from Hitchi Smartmeter and expose it via MQTT
https://github.com/jedie/pysmartmeter
energy-consumption energy-monitor homeassistant mqtt python
Last synced: about 2 months ago
JSON representation
Collect data from Hitchi Smartmeter and expose it via MQTT
- Host: GitHub
- URL: https://github.com/jedie/pysmartmeter
- Owner: jedie
- License: gpl-3.0
- Created: 2022-11-10T17:07:22.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-05-06T17:02:59.000Z (about 2 months ago)
- Last Synced: 2025-05-06T17:50:52.045Z (about 2 months ago)
- Topics: energy-consumption, energy-monitor, homeassistant, mqtt, python
- Language: Python
- Homepage:
- Size: 408 KB
- Stars: 7
- Watchers: 2
- Forks: 1
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pysmartmeter
[](https://github.com/jedie/pysmartmeter/actions/workflows/tests.yml)
[](https://app.codecov.io/github/jedie/pysmartmeter)
[](https://pypi.org/project/pysmartmeter/)
[](https://github.com/jedie/pysmartmeter/blob/main/pyproject.toml)
[](https://github.com/jedie/pysmartmeter/blob/main/LICENSE)
Collect data from Hichi Smartmeter aka `volkszaehler.org` (USB Version) and expose it via MQTT.
Discussion: https://www.photovoltaikforum.com/thread/188160-pysmartmeter (de)
In the end it can looks like the following [Home Assistant](https://www.home-assistant.io/) dashboard screenshot, using [MQTT integration](https://www.home-assistant.io/integrations/mqtt):
With my "eBZ DD3" energy meter by eBZ GmbH the values update live every second ;)
Currently only energy meters that send [OBIS text protocol](https://wiki.volkszaehler.org/software/obis) are supported! (Test this with `./cli.py dump`)
TODO: [#37 - Add support for SML (Smart Message Language) binary protocol](https://github.com/jedie/pysmartmeter/issues/37)
## quickstart
### prepare
Install minimum requirements, e.g.:
```bash
~$ sudo apt install python3-venv
```
Note: If you using a Raspberry Pi: Check that https://www.piwheels.org/ are in use.
For this, just look into `etc/pip.conf` it should be looked like this:
```bash
~/pysmartmeter$ cat /etc/pip.conf
[global]
extra-index-url=https://www.piwheels.org/simple
```
### clone and start
Clone sources and install project:
```bash
~$ git clone https://github.com/jedie/pysmartmeter.git
~$ cd pysmartmeter
~/pysmartmeter$ ./cli.py --help
```
The output of `./cli.py --help` looks like:
[comment]: <> (✂✂✂ auto generated main help start ✂✂✂)
```
usage: ./cli.py [-h]
{debug-settings,edit-settings,publish-loop,systemd-debug,systemd-remove,systemd-setup,systemd-status,s
ystemd-stop,version}
╭─ options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ -h, --help show this help message and exit │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ {debug-settings,edit-settings,publish-loop,systemd-debug,systemd-remove,systemd-setup,systemd-status,systemd-stop, │
│ version} │
│ debug-settings │
│ Display (anonymized) MQTT server username and password │
│ edit-settings │
│ Edit the settings file. On first call: Create the default one. │
│ publish-loop Publish all values via MQTT to Home Assistant in a endless loop. │
│ systemd-debug │
│ Print Systemd service template + context + rendered file content. │
│ systemd-remove │
│ Stops the systemd service and removed the service file. (May need sudo) │
│ systemd-setup │
│ Write Systemd service file, enable it and (re-)start the service. (May need sudo) │
│ systemd-status │
│ Display status of systemd service. (May need sudo) │
│ systemd-stop Stops the systemd service. (May need sudo) │
│ version Print version and exit │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
[comment]: <> (✂✂✂ auto generated main help end ✂✂✂)
Test if you Hichi Smartmeter with CP2102 USB to UART Bridge Controller will be found, e.g.:
```bash
~/pysmartmeter$ ./cli.py detect-serial
```
Note: It's a good idea to use the `/dev/serial/by-id/{your-device-id}` path as serial port, instead of `/dev/ttyUSB1`
Call `udevadm info -n /dev/ttyUSB*` to get information about all USB serial devices and `ls -l /dev/serial/by-id/` to see the existing links.
Maybe you didn't have permissions to access the port, e.g.:
```bash
~/pysmartmeter$ ./cli.py dump
...
try: /dev/ttyUSB0 CP2102 USB to UART Bridge Controller - CP2102 USB to UART Bridge Controller USB VID:PID=10C4:EA60
/dev/ttyUSB0 file mode: 0o20660
/dev/ttyUSB0 user ID: 0
/dev/ttyUSB0 user group ID: 20
/dev/ttyUSB0 user group: 'dialout'
ERROR: [Errno 13] could not open port /dev/ttyUSB0: [Errno 13] Permission denied: '/dev/ttyUSB0'
...
```
Fix fiy by add the user to the group, e.g.:
```bash
sudo usermod -a -G dialout $USER
```
## publish smartmeter data via MQTT
You have to store your MQTT settings (host, port, username, password) one time, e.g.:
```bash
~/pysmartmeter$ ./cli.py store-settings
```
This will create a JSON file here: `~/.pysmartmeter`
You can test reading this settings file with:
```bash
~/pysmartmeter$ ./cli.py debug-settings
```
Test your MQTT settings with:
```bash
~/pysmartmeter$ ./cli.py test-mqtt-connection
```
Setup systemd service:
```bash
~/pysmartmeter$ sudo ./cli.py setup-systemd-service
```
This will create a systemd service that automaticly starts on every boot.
Note: Before you start the systemd service, check if everything works correctly with `./cli.py dump` and `./cli.py publish-loop`
Otherwise you may start a services that will just deal wie gabage (e.g.: your energy meters speaks no OBIS text protocol) and restarts on and on again ;)
Check if service is running:
```bash
~/pysmartmeter$ sudo ./cli.py systemd-status
```
If everything is fine: Go to your [Home Assistant and check the MQTT integration](https://www.home-assistant.io/integrations/mqtt/)
The device discovery will be made automaticly.
# Troubleshooting
If you have any trouble, try to recreate the Python Virtual Environment first.
For this, just delete it and start the CLI to recreate it, e.g.:
```bash
~/pysmartmeter$ rm -Rf .venv-app/
~/pysmartmeter$ ./cli.py
```
# Start hacking
```bash
~$ git clone https://github.com/jedie/pysmartmeter.git
~$ cd pysmartmeter
~/pysmartmeter$ ./dev-cli.py --help
```
[comment]: <> (✂✂✂ auto generated dev help start ✂✂✂)
```
usage: ./dev-cli.py [-h]
{check-code-style,coverage,fix-code-style,install,mypy,nox,pip-audit,publish,test,update,update-re
adme-history,update-test-snapshot-files,version}
╭─ options ──────────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ -h, --help show this help message and exit │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
╭─ subcommands ──────────────────────────────────────────────────────────────────────────────────────────────────────╮
│ {check-code-style,coverage,fix-code-style,install,mypy,nox,pip-audit,publish,test,update,update-readme-history,upd │
│ ate-test-snapshot-files,version} │
│ check-code-style │
│ Check code style by calling darker + flake8 │
│ coverage Run tests and show coverage report. │
│ fix-code-style │
│ Fix code style of all pysmartmeter source code files via darker │
│ install Install requirements and 'pysmartmeter' via pip as editable. │
│ mypy Run Mypy (configured in pyproject.toml) │
│ nox Run nox │
│ pip-audit Run pip-audit check against current requirements files │
│ publish Build and upload this project to PyPi │
│ test Run unittests │
│ update Update "requirements*.txt" dependencies files │
│ update-readme-history │
│ Update project history base on git commits/tags in README.md Will be exited with 1 if the │
│ README.md was updated otherwise with 0. │
│ │
│ Also, callable via e.g.: │
│ python -m cli_base update-readme-history -v │
│ update-test-snapshot-files │
│ Update all test snapshot files (by remove and recreate all snapshot files) │
│ version Print version and exit │
╰────────────────────────────────────────────────────────────────────────────────────────────────────────────────────╯
```
[comment]: <> (✂✂✂ auto generated dev help end ✂✂✂)
# various links
* Discussion: https://www.photovoltaikforum.com/thread/188160-pysmartmeter (de)
* https://github.com/pyserial/pyserial
* https://github.com/eclipse/paho.mqtt.python
* https://github.com/eclipse/mosquitto
* https://dewiki.de/Lexikon/OBIS-Kennzahlen (de) | https://www.promotic.eu/en/pmdoc/Subsystems/Comm/PmDrivers/IEC62056_OBIS.htm (en)
* https://www.photovoltaikforum.com/thread/145886-habe-lesk%C3%B6pfe-mit-usb-%C3%BCber/ (de)
* https://www.heise.de/tests/Ausprobiert-Guenstiger-IR-Lesekopf-fuer-Smart-Meter-mit-Tastmota-Firmware-7065559.html (de)
* https://www.home-assistant.io
# Backwards-incompatible changes
## v0.4.x -> v0.5.x
We split the CLI files into:
* `./cli.py` - Commands for end users
* `./dev-cli.py` - Commands for developers
## v0.2.x -> v0.3.x
Packages changes:
* We switched from `poetry` to `pip-tools`
* `Makefile` was removed
* "Renamed" `cli.sh` to `cli.py`
The `Makefile` is no longer needed, because "Bootstrapping" will be made, just by call `cli.py`
To migrate, just remove the existing `.venv` and create a fresh one, e.g.:
```bash
~$ cd pysmartmeter
~/pysmartmeter$ git pull origin main
~/pysmartmeter$ rm -Rf .venv
~/pysmartmeter$ ./cli.py --help
```
# History
[comment]: <> (✂✂✂ auto generated history start ✂✂✂)
* [v0.6.0](https://github.com/jedie/pysmartmeter/compare/v0.5.0...v0.6.0)
* 2025-04-25 - Modernize Project
* 2024-01-17 - +typeguard
* 2024-01-17 - +"flake8-bugbear"
* 2024-01-01 - Update README.md
* 2023-12-29 - +# Troubleshooting
* 2023-12-29 - Add a note about https://www.piwheels.org/
* [v0.5.0](https://github.com/jedie/pysmartmeter/compare/v0.4.1...v0.5.0)
* 2023-12-29 - cleanup pyproject.toml and cli scripts
* 2023-12-29 - Move BaseTestCase
* 2023-12-29 - Apply manageprojects updates
* 2023-06-05 - Update README.md
* 2023-05-27 - Split CLI into: cli.py and dev-cli.py
* [v0.4.1](https://github.com/jedie/pysmartmeter/compare/v0.4.0...v0.4.1)
* 2023-03-09 - Ignore empty input lines and add expand OBIS map
* [v0.4.0](https://github.com/jedie/pysmartmeter/compare/v0.3.4...v0.4.0)
* 2023-03-08 - mock version
* 2023-03-08 - update requirements
* 2023-03-08 - Bump version to 0.4.0
* 2023-03-07 - Fix#32 add "test-mqtt-connection" CLI command
Expand older history entries ...
* [v0.3.4](https://github.com/jedie/pysmartmeter/compare/v0.3.3...v0.3.4)
* 2023-02-26 - Update README.md
* 2023-02-26 - Set HA device class "voltage" for voltage entries
* 2023-02-26 - Add test with HomeAssistantMqtt + ObisParser
* 2023-02-26 - Add a test snapshot with the full RAW_TEST_DATA_BIG
* [v0.3.3](https://github.com/jedie/pysmartmeter/compare/v0.3.2...v0.3.3)
* 2023-02-26 - Enhance "detect-serial"
* 2023-02-26 - Update README.md
* [v0.3.2](https://github.com/jedie/pysmartmeter/compare/v0.3.1...v0.3.2)
* 2023-02-26 - Bugfix "publish-loop" CLI command and add tests for it
* 2023-02-26 - Display systemd config file, after create / before status
* [v0.3.1](https://github.com/jedie/pysmartmeter/compare/v0.3.0...v0.3.1)
* 2023-02-26 - Use publish_package() from manageprojects
* [v0.3.0](https://github.com/jedie/pysmartmeter/compare/v0.2.0...v0.3.0)
* 2023-02-26 - README: How to migrate from v0.2 to v0.3
* 2023-02-26 - Display systemd status after commands
* 2023-02-26 - unify systemd command error handling
* 2023-02-26 - Update README
* 2023-02-26 - Add "systemd-restart" to CLI
* 2023-02-26 - sudo info for systemd command
* 2023-02-24 - migrate form poetry to piptools via manageprojects
* 2023-02-26 - update tests
* 2023-02-25 - Update obis_map.py
* 2023-02-24 - Update README.md
* 2023-02-24 - +manageprojects
* 2023-02-24 - manageprojects updates
* 2023-02-24 - fix CI
* 2023-02-24 - Update requirements
* 2023-02-24 - Test credentials utilities
* 2023-02-24 - Bugfix Error store-settings #17
* [v0.2.0](https://github.com/jedie/pysmartmeter/compare/v0.1.0...v0.2.0)
* 2022-12-18 - Fix #13: "last_reset" is missing (for Home Assistant)
* 2022-12-20 - Snapshot a complete configs/data MQTT payload for Home Assistant
* [v0.1.0](https://github.com/jedie/pysmartmeter/compare/7d8631b...v0.1.0)
* 2022-12-10 - Update README.md
* 2022-11-24 - Fix #11 by disable logging in systemd daemon mode
* 2022-11-23 - fix typo: '1-0:76.7.0*255' is 'Momentane Leistung L3' ;)
* 2022-11-21 - Update README
* 2022-11-21 - Fix typo "Hitchi" -> "Hichi"
* 2022-11-18 - Hit about permission errors
* 2022-11-18 - fix publish to PyPi
* 2022-11-18 - CLI: Build and upload this project to PyPi
* 2022-11-18 - fix tests
* 2022-11-18 - Implement MQTT publishing via systemd service
* 2022-11-14 - test code style + mypy
* 2022-11-14 - fix code style
* 2022-11-14 - setup CI
* 2022-11-14 - Bugfix 'identifier'
* 2022-11-14 - Don't use poetry in cli.sh
* 2022-11-14 - Add a way to setup the project without poetry
* 2022-11-13 - Add cli.sh
* 2022-11-13 - switch to poetry
* 2022-11-13 - cleanup
* 2022-11-13 - Add OBIS Parser
* 2022-11-10 - make serial-dump
* 2022-11-10 - switch to https://github.com/jedie/cookiecutter_templates/tree/main/pipenv-python
* 2022-11-10 - Add a simple dump serial output script
* 2022-11-10 - update project
* 2022-11-10 - init project
* 2022-11-10 - Initial commit
[comment]: <> (✂✂✂ auto generated history end ✂✂✂)