timoschneider/homeassistant-jackery
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: update README.md to indicate beta stage and app version requirement

Browse Source 
- Added a warning about the integration being in beta testing phase for stability awareness.
- Included a requirement for the JackeryHome app version to be greater than 2.10.18 for proper functionality.
This commit is contained in:
不求圣剑
2025-12-08 11:32:07 +08:00
parent f34139003c
commit 12ed7103f5
1 changed files with 3 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -4,6 +4,8 @@
[![GitHub Release](https://img.shields.io/github/release/suyulin/jackery_home.svg)](https://github.com/suyulin/jackery_home/releases) [![GitHub Release](https://img.shields.io/github/release/suyulin/jackery_home.svg)](https://github.com/suyulin/jackery_home/releases)
[![License](https://img.shields.io/github/license/suyulin/jackery_home.svg)](LICENSE) [![License](https://img.shields.io/github/license/suyulin/jackery_home.svg)](LICENSE)
> **⚠️ Beta Stage**: This integration is currently in Beta testing phase and may be unstable. Please use with caution and report any issues.
JackeryHome is a **custom Home Assistant integration** that uses **MQTT** to monitor solar, grid, battery, EPS and home energy data from a Jackery energy system. JackeryHome is a **custom Home Assistant integration** that uses **MQTT** to monitor solar, grid, battery, EPS and home energy data from a Jackery energy system.
The integration is implemented in `custom_components/JackeryHome/sensor.py` and is built around a shared **coordinator** (`JackeryDataCoordinator`) that efficiently manages subscriptions and data requests for all sensors. The integration is implemented in `custom_components/JackeryHome/sensor.py` and is built around a shared **coordinator** (`JackeryDataCoordinator`) that efficiently manages subscriptions and data requests for all sensors.
@@ -34,6 +36,7 @@ Before the JackeryHome integration can receive any data, **two things must be in
2. **Device is configured from the JackeryHome app** 2. **Device is configured from the JackeryHome app**
- Use the vendor/JackeryHome mobile app to add the device/gateway and complete its initial setup. - Use the vendor/JackeryHome mobile app to add the device/gateway and complete its initial setup.
- **⚠️ APP Version Requirement**: JackeryHome APP version must be greater than **2.10.18** to support this integration.
- Make sure the device has network access and is configured so that it can connect to your MQTT/cloud backend. - Make sure the device has network access and is configured so that it can connect to your MQTT/cloud backend.
- In the Jackery Home app, long-press the app logo to open the configuration screen. - In the Jackery Home app, long-press the app logo to open the configuration screen.
- In the Jackery Home app configuration, **replace the IP with the address of your own MQTT server**. - In the Jackery Home app configuration, **replace the IP with the address of your own MQTT server**.