YamBMS 1.6.0 - Updated README

This commit is contained in:
Sleeper85 committed 2025-12-01 23:12:10 +01:00
1 parent 942b7c6fbb
commit 93730d856d
4 files changed
+37 -12

No files matched your search

+13 -8
View File
@@ -60,6 +60,10 @@
![Image](images/YamBMS_Overview.png "YamBMS Overview")
## Home Assistant
![Image](images/YamBMS_HA_Dashboard.png "YamBMS HA Dashboard")
## Hardware highlighted
This project works with various `ESP32` variants and also with the `Raspberry Pi Pico (RP2040)`.
@@ -93,22 +97,22 @@ The BMS/Shunt are connected to other ESP32 nodes connected on a dedicated RS485
The theoretical limit is `256` modbus server (BMS/Shunt) per `RS485 bus` but in reality this will depend on the capabilities of `node1` (YamBMS) which will have to combine all the BMS/Shunt/Balancer together.
[You can find more information about creating your YAML in this How To.](documents/README/YamBMS_main_YAML_HowTo.md)
[You can find more information about creating your YAML in this How To.](documents/README/YamBMS_RP_YAML.md)
> [!TIP]
> If you have a lot of `BMS/Shunt/Balancer` to combine, using an `ESP32-S3` or `AtomS3` for `node1` is recommended.
![Image](images/YamBMS_multi-node_RS485_modbus.png "YamBMS multi-node RS485 modbus")
[@GHswitt](https://github.com/GHswitt) multi-node example :
![Image](images/YamBMS_multi-node_RS485_modbus_example.png "YamBMS multi-node RS485 modbus example")
> [!NOTE]
> Some boards with integrated `RS485 transceiver` have already a 120 Ohm resistor installed, for example the `LilyGo T-CAN485`, `LilyGo T-Connect` and `LilyGo T-Connect Pro`.
> If these devices are used in the middle, this resistor must be removed!
> Otherwise transmission errors can occur.
## Home Assistant
![Image](images/YamBMS_HA_Dashboard.png "YamBMS HA Dashboard")
## Try YamBMS with the DEMO firmware
You can simply test the application with a `generic ESP32` without compiling and connecting anything on your ESP32.
@@ -129,7 +133,7 @@ rx_pin: 22 # to CAN board CRX (with 4.7K resistor except for SN65HVD230)
## Requirements
* [ESPHome 2025.6.0 or higher](https://github.com/esphome/esphome/releases)
* [ESPHome 2025.11.0 or higher](https://github.com/esphome/esphome/releases)
* ESP32 MCU (buying a board with ≥8MB flash is advised if you intend to monitor multiple BMS)
* CAN transceiver (only with TJA1050/TJA1051 => 4.7K resistor for 5V to 3V3 level shifing)
* BMS JK, JBD, Seplos (other BMS brands already integrated with ESPhome can be added easily)
@@ -140,7 +144,7 @@ rx_pin: 22 # to CAN board CRX (with 4.7K resistor except for SN65HVD230)
## Data collection
> [!NOTE]
> For your information, in June 2025 there were `100` YamBMS users.
> For your information, in November 2025 there were `140` YamBMS users.
If the ESP32 has an internet connection, the following data is sent to [this script](http://script.opentel.be/yambms.post.php)
for statistics collection. Only [@Sleeper85](https://github.com/Sleeper85) have access to this information for the production of statistics, the support and the update service.
@@ -160,4 +164,5 @@ for statistics collection. Only [@Sleeper85](https://github.com/Sleeper85) have
* Thanks to [@syssi](https://github.com/syssi/esphome-jk-bms) for help and making many BMS components (JK, JBD, Seplos, Pace, etc.)
* Thanks to [@txubelaxu](https://github.com/txubelaxu/esphome-jk-bms) for help and making the `JK-PB RS485` component.
* Thanks to [@uksa007](https://www.patreon.com/Uksa007Codedevelopment) for making the original CANBUS code.
* Thanks to [@uksa007](https://www.patreon.com/Uksa007Codedevelopment) for making the first CANBUS code.
* Thanks to all the [contributors](https://github.com/Sleeper85/esphome-yambms/graphs/contributors).
+24 -4
View File
@@ -29,10 +29,21 @@
### 1. Enter your WiFi credentials in the `SECRETS` YAML in the top right corner
Copy, past and enter your credentials :
```YAML
# WiFi
wifi_ssid: YourSSID
wifi_password: YourPassword
domain : .local
domain: .local
# WiFi AP
wifi_ap_ssid: YamBMS
wifi_ap_password: Y4mBM$85
# Web Server
web_server_username: yambms
web_server_password: Y4mBM$85
```
### 2. Add your `ESP32` by clicking on `+ NEW DEVICE` at the bottom right
@@ -56,7 +67,7 @@ In Home Assistant under **" Settings > Devices and services > Add Intergration "
### 1. Install ESPHome on your computer
Before you can flash your ESP32 you need to install the [ESPHome 2025.6.0 or higher](https://github.com/esphome/esphome/releases) command line application.<br>
Before you can flash your ESP32 you need to install the [ESPHome 2025.11.0 or higher](https://github.com/esphome/esphome/releases) command line application.<br>
[Follow these instructions for installation on Windows, Mac or Linux.](https://esphome.io/guides/installing_esphome)
> [!TIP]
@@ -89,10 +100,19 @@ cd esphome-yambms
### 3. Enter your WiFi credentials in the `secrets.yaml` files
```yaml
```YAML
# WiFi
wifi_ssid: YourSSID
wifi_password: YourPassword
domain : .local
domain: .local
# WiFi AP
wifi_ap_ssid: YamBMS
wifi_ap_password: Y4mBM$85
# Web Server
web_server_username: yambms
web_server_password: Y4mBM$85
```
### 4. Install the `YamBMS.yaml` into your ESP32
Binary file not shown.

Before

Width:  |  Height:  |  Size: 265 KiB

After

Width:  |  Height:  |  Size: 157 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 725 KiB