tim/bmspy
1
0
Fork 0
Code Issues Pull Requests Releases Activity

Simplify wording in the documentation

Browse Source 
Put each condition before its statement. Split long sentences. Use one term for each concept. Replace the description of possible checklist changes with a statement of the present behavior.
This commit is contained in:
tim
2026-10-10 10:12:35 +02:00
parent 82def5737f
commit ef7a6b5f92
3 changed files with 25 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files
README.md
+7 -7
View File
@@ -7,7 +7,7 @@ bmspy is a tool to get information from battery management systems and UPS devic
It can display the information as text, in JSON, or export the data continuously to InfluxDB or a Prometheus exporter.
Multiple devices can be connected at once. Each is identified by a name, and data from all of them (or just one) can be pushed to InfluxDB or Prometheus in the same connection, with each measurement tagged with the device name.
Multiple devices can be connected at once. Each is identified by a name. Data from all of them (or just one) can be pushed to InfluxDB or Prometheus in the same connection. Each measurement is tagged with the device name.
Install [uv](https://docs.astral.sh/uv/getting-started/installation/) and use Python 3.12 or later, below Python 4.
Then create the local environment:
@@ -43,7 +43,7 @@ Single JBD BMS device (defaults to `/dev/ttyUSB0`):
uv run bmspy-server
Multiple JBD BMS devices, with optional names (default name is derived from the device path, e.g. `ttyUSB0`):
Multiple JBD BMS devices, with optional names (default name is derived from the device path, for example `ttyUSB0`):
uv run bmspy-server -d network:/dev/ttyUSB0 -d nas:/dev/ttyUSB1
@@ -60,7 +60,7 @@ Get your EcoFlow account user ID:
uv run bmspy-ecoflow-login you@example.com
```
The command prompts for your password. Add `--region EU` or `--region US` if needed.
The command prompts for your password. If needed, add `--region EU` or `--region US`.
Use the diagnostic scan below to find device addresses and serial numbers.
Type 7 authentication also needs an external lookup table from
@@ -144,11 +144,11 @@ in their `info` fields. The references above describe names, units, and limits.
Before you start a service, install its dependencies in the service's working
directory with `uv sync --locked --no-dev`. Add `--extra ecoflow-bt` for Bluetooth,
`--extra influxdb` for InfluxDB, or both if needed.
`--extra influxdb` for InfluxDB, or both.
The service files use `uv run --no-sync`. This keeps services from changing
the shared environment when they start. Set the `uv` executable to an absolute
path if it is not on systemd's search path.
The service files use `uv run --no-sync`. With this option, a service does not
change the shared environment at startup. If the `uv` executable is not on
systemd's search path, set it to an absolute path.
Copy `bmspy-server.service` to `/etc/systemd/system`, adjust `WorkingDirectory` and the `ExecStart` line as needed, then enable and start it: