Skip to content

SunEnergyXT/SunEnergyXT-BK

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

5 Commits
 
 
 
 
 
 

Repository files navigation

SunEnergyXT-BK

SunEnergyXT-BK is a Home Assistant custom integration for SunEnergyXT BK battery local monitoring and control.

Installation

Install this repository as a custom Home Assistant integration, for example with HACS as a custom repository.

The integration files must be available under:

custom_components/sunEnergyXT/

Restart Home Assistant after installation, then add the integration from:

Settings > Devices & services > Add integration > SunEnergyXT-BK

Prerequisites

  • The battery must be reachable from Home Assistant on the local network.
  • Local communication must already be available on the device.
  • If automatic discovery does not find the device, use manual configuration with the device host, port, serial number, software version, and hardware version.

Entities

The integration creates sensor, switch, number, and diagnostic entities for the BK device.

See ENTITY_LIST_EN.md for the full English entity list and API field mapping.

Some diagnostic entities are intended for troubleshooting only. In particular, wifi_update_time can update very frequently and is disabled by default for new installations to avoid unnecessary Home Assistant recorder and logbook entries. It can still be enabled manually from the entity registry when needed.

Known Limitations

  • Switching from cloud mode to local mode cannot be completed through this local TCP integration when the device is not already reachable locally.
  • The integration exposes the entities defined by the current local protocol. Device variants and extension modules may report unsupported values as unavailable.
  • The current integration domain is sunEnergyXT. Renaming the domain would be a breaking change for existing installations.

Issues

Report bugs or feature requests on GitHub:

https://github.com/SunEnergyXT/SunEnergyXT-BK/issues

About

[SunEnergyXT] Battery local control plugin for Home Assistant

Resources

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages