bmspy/README.md

17 lines
439 B
Markdown

# bmspy
bmspy is a tool to get information from a xiaoxiang-type BMS system, using some sort of serial connection.
It can display the information as text, in JSON, or export the data continuously to a Prometheus exporter.
To install:
git clone https://git.treehouse.org.za/tim/bmspy
cd bmspy
poetry install
Or, to install with influxdb and/or prometheus support:
poetry install -E influxdb -E prometheus
To run:
poetry run bmspy