|
1 | 1 | # dbus-serialbattery |
2 | | -This is a driver for VenusOS devices (any GX device sold by Victron or a Raspberry Pi running the VenusOS image). |
| 2 | +This is a driver for Venus OS devices (any GX device sold by Victron or a Raspberry Pi running the Venus OS image). |
3 | 3 |
|
4 | | -The driver will communicate with a Battery Management System (BMS) that support serial communication (RS232, RS485 or TTL UART) and publish this data to the VenusOS system. The main purpose is to act as a Battery Monitor in your GX and supply State of Charge (SoC) and other values to the inverter. |
| 4 | +The driver will communicate with a Battery Management System (BMS) that support serial communication (RS232, RS485 or TTL UART) and publish this data to the Venus OS system. The main purpose is to act as a Battery Monitor in your GX and supply State Of Charge (SOC) and other values to the inverter. |
5 | 5 |
|
6 | | -## Documentation |
7 | | -Check the documenation for more informations. |
8 | | -* [Introduction](https://louisvdw.github.io/dbus-serialbattery/) |
9 | | - * [Features](https://louisvdw.github.io/dbus-serialbattery/general/features) |
10 | | - * [Supported BMS](https://louisvdw.github.io/dbus-serialbattery/general/supported-bms) |
11 | | - * [How to install](https://louisvdw.github.io/dbus-serialbattery/general/install) |
12 | | -* [Troubleshoot](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/) |
13 | | - * [FAQ (Frequently Asked Questions)](https://louisvdw.github.io/dbus-serialbattery/troubleshoot/faq) |
| 6 | + * [BMS Types supported](https://github.com/Louisvdw/dbus-serialbattery/wiki/BMS-types-supported) |
| 7 | + * [FAQ](https://github.com/Louisvdw/dbus-serialbattery/wiki/FAQ) |
| 8 | + * [Features](https://github.com/Louisvdw/dbus-serialbattery/wiki/Features) |
| 9 | + * [How to install](https://github.com/Louisvdw/dbus-serialbattery/wiki/How-to-install) |
| 10 | + * [Troubleshoot](https://github.com/Louisvdw/dbus-serialbattery/wiki/Troubleshoot) |
14 | 11 |
|
15 | | -## Supporting this project: |
| 12 | +### Supporting this project: |
16 | 13 | If you find this driver helpful please considder supporting this project. You can buy me a Ko-Fi or get in contact if you would like to donate hardware. |
17 | 14 |
|
18 | 15 | [](https://ko-fi.com/Z8Z73LCW1) or using [Paypal.me](https://paypal.me/innernet) |
19 | 16 |
|
20 | | -## Developer Remarks |
| 17 | +### Developer Remarks |
21 | 18 | To develop this project, install the requirements. This project makes use of velib_python which is pre-installed on |
22 | | -Venus OS Devices under `/opt/victronenergy/dbus-systemcalc-py/ext/velib_python`. To use the python files locally, |
| 19 | +Venus-OS Devices under `/opt/victronenergy/dbus-systemcalc-py/ext/velib_python`. To use the python files locally, |
23 | 20 | `git clone` the [velib_python](https://github.com/victronenergy/velib_python) project to velib_python and add |
24 | 21 | velib_python to the `PYTHONPATH` environment variable. |
25 | 22 |
|
26 | | -## How it works |
| 23 | +#### How it works |
27 | 24 | * Each supported BMS needs to implement the abstract base class `Battery` from `battery.py`. |
28 | 25 | * `dbus-serialbattery.py` tries to figure out the correct connected BMS by looping through all known implementations of |
29 | 26 | `Battery` and executing its `test_connection()`. If this returns true, `dbus-serialbattery.py` sticks with this battery |
30 | | -and then periodically executes `dbushelper.publish_battery()`. `publish_battery()` executes `Battery.refresh_data()` which |
| 27 | +and then periodically executes `dbushelpert.publish_battery()`. `publish_battery()` executes `Battery.refresh_data()` which |
31 | 28 | updates the fields of Battery. It then publishes those fields to dbus using `dbushelper.publish_dbus()` |
32 | 29 | * The Victron Device will be "controlled" by the values published on `/Info/` - namely: |
33 | 30 | * `/Info/MaxChargeCurrent ` |
34 | 31 | * `/Info/MaxDischargeCurrent` |
35 | 32 | * `/Info/MaxChargeVoltage` |
36 | | - * `/Info/BatteryLowVoltage` (note that Low Voltage is ignored by the system) |
| 33 | + * `/Info/BatteryLowVoltage` |
37 | 34 | * `/Info/ChargeRequest` (not implemented in dbus-serialbattery) |
38 | 35 |
|
39 | | -For more details on the Victron dbus interface see [the official Victron dbus documentation](https://github.com/victronenergy/venus/wiki/dbus). |
| 36 | +For more details on the victron dbus interface see [the official victron dbus documentation](https://github.com/victronenergy/venus/wiki/dbus) |
| 37 | + |
| 38 | +## Screenshots |
| 39 | + |
| 40 | +### Venus OS |
| 41 | + |
| 42 | + |
| 43 | + |
| 44 | + |
| 45 | + |
| 46 | + |
| 47 | + |
| 48 | + |
| 49 | + |
| 50 | + |
| 51 | + |
| 52 | + |
| 53 | + |
| 54 | + |
| 55 | + |
| 56 | +### VRM Portal |
| 57 | + |
| 58 | + |
| 59 | + |
| 60 | + |
| 61 | + |
| 62 | + |
| 63 | + |
| 64 | + |
| 65 | + |
| 66 | + |
0 commit comments