tim/bmspy

bmspy can be used to get information from a xiaoxiang-type BMS system.

Go to file

Timothy Allen cae4d1b0a4 Use JSON for serialising requests/responses, rather than pickle, to make C integration easier		2024-05-09 09:42:59 +02:00
bmspy	Use JSON for serialising requests/responses, rather than pickle, to make C integration easier	2024-05-09 09:42:59 +02:00
bmspy-influxdb.service	Refactor into a client/server model, to enable multiple clients to access the BMS data	2024-04-30 17:28:14 +02:00
bmspy-server.service	Refactor into a client/server model, to enable multiple clients to access the BMS data	2024-04-30 17:28:14 +02:00
LICENSE	Initial commit	2021-02-03 11:19:58 +00:00
poetry.lock	Convert to using poetry to run bmspy	2024-03-19 22:28:39 +02:00
pyproject.toml	Use JSON for serialising requests/responses, rather than pickle, to make C integration easier	2024-05-09 09:42:59 +02:00
README.md	Refactor into a client/server model, to enable multiple clients to access the BMS data	2024-04-30 17:28:14 +02:00

README.md

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

Or to run via systemd, copy bmspyd.service to /etc/systemd/system, adjust WorkingDirectory to point to the installation location, and enable and start the service: cp bmspy-server.service /etc/systemd/system $EDITOR /etc/systemd/system/bmspy-server.service systemctl daemon-reload systemctl enable bmspy-server systemctl start bmspy-server

To run a client to get the data, choose one of the following options: poetry run bmspy poetry run bmspy-influxdb --url ...