From 59b0d2611cdc29fa82e0c1528a77659b49cd780f Mon Sep 17 00:00:00 2001 From: Txubelaxu <156140720+txubelaxu@users.noreply.github.com> Date: Tue, 19 Mar 2024 10:50:34 +0100 Subject: [PATCH] Update README.md new README file --- README.md | 235 +++--------------------------------------------------- 1 file changed, 10 insertions(+), 225 deletions(-) diff --git a/README.md b/README.md index d62a7e62..b714889f 100644 --- a/README.md +++ b/README.md @@ -4,240 +4,25 @@ ![GitHub stars](https://img.shields.io/github/stars/syssi/esphome-jk-bms) ![GitHub forks](https://img.shields.io/github/forks/syssi/esphome-jk-bms) ![GitHub watchers](https://img.shields.io/github/watchers/syssi/esphome-jk-bms) -[!["Buy Me A Coffee"](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://www.buymeacoffee.com/syssi) +[!["Buy Me A Coffee"](https://img.shields.io/badge/buy%20me%20a%20coffee-donate-yellow.svg)](https://www.buymeacoffee.com/txubelaxu) -ESPHome component to monitor a Jikong Battery Management System (JK-BMS) via UART-TTL or BLE +ESPHome components to monitor Jikong Battery Management Systems (JK-BMS) via UART-TTL, BLE, and RS-485. -NEW: monitor your new JK-PBx BMSs via internal RS485 network using 1 only ESP. -Click here https://github.com/txubelaxu/esphome-jk-bms/blob/main/components/jk_rs485_bms/README.md for more info. +**NEW:** monitor your new JK-PBx BMSs via internal RS485 network using 1 only ESP. [Click here](https://github.com/txubelaxu/esphome-jk-bms/blob/main/components/jk_rs485_bms/README.md) for more info. Home Assistant dashboards inside as well. -![Lovelace entities card](lovelace-entities-card.png "Lovelace entities card") +Last news: new parameters added and new dashboards +![image](https://github.com/txubelaxu/esphome-jk-bms/assets/156140720/9c3f7466-5e62-4667-bb70-c573c3a344e2) +![image](https://github.com/txubelaxu/esphome-jk-bms/assets/156140720/a02e1d83-54c4-4057-bf0d-d159917e52c8) +![image](https://github.com/txubelaxu/esphome-jk-bms/assets/156140720/5187ac3f-950a-40f9-ba00-097275ffe9bf) -## Supported devices -All JK-BMS models with software version `>=6.0` are using the implemented protocol and should be supported. -* JK-BD4A8S4P, hw 11.xw, sw 11.24, using `JK02_32S` (reported by [@austin202220](https://github.com/syssi/esphome-jk-bms/issues/297)) -* JK-BD6A17S6P, hw 7.2, sw 7.1.0H -* JK-BD6A17S8P, hw 9.x, sw 9.01G (reported by [@jonadis](https://github.com/syssi/esphome-jk-bms/issues/35#issuecomment-1035312712)) -* JK-BD6A20S10P, hw 10.XW, sw 10.07 (reported by [@adadrag](https://github.com/syssi/esphome-jk-bms/issues/123)) -* JK-BD6A20S12P, hw 11.XW, sw 11.281, using UART-TTL (reported by [@asiridissa](https://github.com/syssi/esphome-jk-bms/discussions/339)) -* JK-BD6A24S6P, hw 6.x, sw 6.10S (reported by [@ziporah](https://github.com/syssi/esphome-jk-bms/issues/41)) -* JK-BD6A24S10P, hw 8.x, sw 8.0.6G (reported by [@spoonwzd](https://github.com/syssi/esphome-jk-bms/issues/67#issuecomment-1093844076)) -* JK-BD6A24S10P, hw 10.xw, sw 10.09 (reported by [@PMPoulsen](https://github.com/syssi/esphome-jk-bms/discussions/261#discussioncomment-5091812)) -* JK-BD4A17S4P, hw 11.xw, sw 11.01 (reported by [@Condor-XYZ](https://github.com/syssi/esphome-jk-bms/issues/221)) -* JK-BD4A17S4P, hw 11.xw, sw 11.27, using `JK02_32S` and/or UART-TTL (reported by [@hemskgren](https://github.com/syssi/esphome-jk-bms/issues/359)) -* JK-B1A8S10P, hw 11.XW, sw 11.261, using `JK02_32S` (reported by [@Chickenbreast0](https://github.com/syssi/esphome-jk-bms/issues/346)) -* JK-B1A24S15P, hw 8.x, sw 8.1.0H (reported by [@killee](https://github.com/syssi/esphome-jk-bms/discussions/4)) -* JK-B1A20S15P, hw 8.x, sw 8.14U (reported by [@trippfam07](https://github.com/syssi/esphome-jk-bms/issues/31)) -* JK-B1A20S15P, hw 10.xw, sw 10.07 (reported by [@romeox44](https://github.com/syssi/esphome-jk-bms/discussions/125)) -* JK-B1A20S15P, hw 10.xw, sw 10.10, using `JK02_24S` (reported by [@austin202220](https://github.com/syssi/esphome-jk-bms/issues/297#issuecomment-1510685683)) -* JK-B1A20S15P, hw 11.xw, sw 11.26, using UART-TTL (reported by [@Tesla72PL](https://github.com/syssi/esphome-jk-bms/issues/309)) -* JK-B2A24S15P, hw 6.x, sw 6.1.3S (reported by [@miguel300477](https://github.com/syssi/esphome-jk-bms/issues/57)) -* JK-B2A24S15P, hw 8.x, sw 8.21W (reported by [@mariusvaida](https://github.com/syssi/esphome-jk-bms/issues/120)) -* JK-B2A24S15P, hw 10.xw, sw 10.07 -* JK-B2A24S15P, hw 10.xw, sw 10.08 (reported by [@meccip](https://github.com/syssi/esphome-jk-bms/discussions/175#discussioncomment-3687287)) -* JK-B2A24S150P, hw 10.xw, sw 10.10 (reported by [@nayias](https://github.com/syssi/esphome-jk-bms/discussions/257#discussioncomment-5062807)) -* JK-B2A24S20P, hw 8.x, sw 8.1.2H (reported by [@KlausLi](https://github.com/syssi/esphome-jk-bms/issues/15#issuecomment-961447064)) -* JK-B2A24S20P, hw 8.x, sw 8.20G (reported by [@rob-oravec](https://github.com/syssi/esphome-jk-bms/discussions/46)) -* JK-B2A24S20P, hw 10.X-W, sw 10.02 (reported by [@SeByDocKy](https://github.com/syssi/esphome-jk-bms/issues/37#issuecomment-1040569576)) -* JK-B2A24S20P, hw 10.XG, sw 10.07D30 (reported by [@TheSmartGerman](https://github.com/syssi/esphome-jk-bms/discussions/122)) -* JK-B2A24S20P, hw 10.XW, sw 10.07 (reported by [@amagr0](https://github.com/syssi/esphome-jk-bms/issues/124#issuecomment-1166366196)) -* JK-B2A8S20P, hw 9.x, sw 9.01M3, using `JK02_24S` (reported by [@EasilyBoredEngineer](https://github.com/syssi/esphome-jk-bms/discussions/110)) -* JK-B2A8S20P, hw 9.x, sw 9.08W (reported by [@vrabi-cv](https://github.com/syssi/esphome-jk-bms/discussions/144#discussioncomment-3285901)) -* JK-B2A8S20P, hw 11.XW, sw 11.17, using `JK02_32S` (reported by [@senfkorn](https://github.com/syssi/esphome-jk-bms/issues/147)) -* JK-B2A8S20P, hw 11.XW, sw 11.26, using `JK02_32S` (reported by [@riker65](https://github.com/syssi/esphome-jk-bms/issues/276)) -* JK-B2A20S20P, hw 10.XW, sw 10.09 (reported by [@markusgg84](https://github.com/syssi/esphome-jk-bms/discussions/173)) -* JK-B2A20S20P, hw 10.XW, sw 11.21h, using `JK02_32S` (reported by [@Salve87](https://github.com/syssi/esphome-jk-bms/issues/308#issuecomment-1505614325)) -* JK-B2A20S20P, hw 11.XW, sw 11.24H, using `JK02_32S` (reported by [@austin202220](https://github.com/syssi/esphome-jk-bms/discussions/232)) -* JK-B2A20S20P, hw 11.XW, sw 11.25H, using `JK02_32S` (reported by [@iovcharyk](https://github.com/syssi/esphome-jk-bms/issues/249)) -* JK-B5A24S, hw 8.x, sw 8.0.3M, using `JK04` (reported by [@JSladen](https://github.com/syssi/esphome-jk-bms/issues/213)) -* JK-B2A16S, hw 3.0, sw 3.3.0, using `JK04` (reported by [@magnetus26](https://github.com/syssi/esphome-jk-bms/discussions/48)) -* GW-24S4EB (NEEY/Heltec 4A Smart Active Balancer), hw HW-2.8.0, sw ZH-1.2.3 (reported by [@cristi2005](https://github.com/syssi/esphome-jk-bms/issues/109)) -* GW-24S4EB (NEEY 4A Smart Active Balancer 4th generation), hw HW-3.2.0, sw ZH-1.2.4 (reported by [@fabhund](https://github.com/syssi/esphome-jk-bms/issues/310)) +ESPHome component to control and monitor a Jikong Battery Management System (JK-BMS) via UART-TTL or BLE [Click here](https://github.com/txubelaxu/esphome-jk-bms/README_uart_ble.md) for more info. -## Untested devices - -* JK-BD6A20S6P - -## Requirements - -* [ESPHome 2022.11.0 or higher](https://github.com/esphome/esphome/releases). -* Generic ESP32 or ESP8266 board - -## Schematics - - - - - - -``` - UART-TTL -┌──────────┐ ┌─────────┐ -│ │<----- RX ----->│ │ -│ JK-BMS │<----- TX ----->│ ESP32/ │ -│ │<----- GND ---->│ ESP8266 │<-- 3.3V -│ │ │ │<-- GND -└──────────┘ └─────────┘ - -# UART-TTL socket (4 Pin, JST 1.25mm pitch) -┌─── ─────── ────┐ -│ │ -│ O O O O │ -│GND RX TX VBAT│ -└────────────────┘ - │ │ │ - │ │ └─── GPIO17 (`rx_pin`) - │ └─────── GPIO16 (`tx_pin`) - └─────────── GND -``` - - -The UART-TTL (labeled as `RS485`) socket of the BMS can be attached to any UART pins of the ESP. A hardware UART should be preferred because of the high baudrate (115200 baud). The connector is called 4 Pin JST with 1.25mm pitch. - -## Installation - -You can install this component with [ESPHome external components feature](https://esphome.io/components/external_components.html) like this: -```yaml -external_components: - - source: github://syssi/esphome-jk-bms@main -``` - -or just use the `esp32-example.yaml` as proof of concept: - -```bash -# Install esphome -pip3 install esphome - -# Clone this external component -git clone https://github.com/syssi/esphome-jk-bms.git -cd esphome-jk-bms - -# Create a secrets.yaml containing some setup specific secrets -cat > secrets.yaml <