A HomeKit integration for home batteries.
Sadly, Apple does not provide fitting Services and Characteristics for home batteries and energy management systems yet. However, integrating these systems with HomeKit does make a lot of sense, especially for usage in Automations. Thus, I decided to write an integration.
git clone https://github.com/theMomax/homekit-battery-integration.gitcd homekit-battery-integrationnpm installnpm run buildDEBUG="*" npm run start
See Integrations for information on how to configure each integration.
npm i -g homekit-battery-integrationDEBUG="*,-*:debug" homekit-battery-integration
Again, see Integrations for information on how to configure each integration.
I've started working on an iOS app (Home Batteries) that offers an overview for this project's custom services. It also provides an UI for creating automations. Check out the link for more details. The Eve App also supports all of the custom Services/Characteristics defined below.
OpenEMS is the only integration to date. I do not have access to any other system currently, however, I would be happy to accept PRs with other integrations!
A list of supported hardware can he found here.
Run npm run start -- -oa <OpenEMS-IP>. The program will automatically scan the configuration of your OpenEMS installation and create the according Accessories. Note that each edge is hosted as a separate Bridge. You can configure the OpenEMS password as well as the HomeKit pincode and port. Run npm run start -- --help for more information on that.
_sumcomponent: System State, Total Battery Level, Total Production, Consumption, Charge/Discharge, Grid Sell/Buy, Excess := Sell+Charge- all
esscomponents: All installed batteries along with their current Charge/Discharge and State - all
metercomponents: All installed electricity meters along with their current active power and their State _metacomponent: OpenEMS Version from the is exposed in theBridge'sAccessoryInformation
| Property | Value |
|---|---|
| UUID | 00000001-0000-1000-8000-0036AC324978 |
| Required Characteristics | StatusFault |
| Optional Characteristics | Name |
| Property | Value |
|---|---|
| UUID | 00000002-0000-1000-8000-0036AC324978 |
| Required Characteristics | CurrentPower |
| Optional Characteristics | CurrentPowerL1 CurrentPowerL2 CurrentPowerL3 Name ElectricityMeterType |
| Property | Value |
|---|---|
| UUID | 00000003-0000-1000-8000-0036AC324978 |
| Required Characteristics | BatteryLevel ChargingState StatusLowBattery |
| Optional Characteristics | EnergyCapacity Name |
| Property | Value |
|---|---|
| UUID | 00000001-0001-1000-8000-0036AC324978 |
| Permissions | Paired Read, Notify |
| Format | float |
| Unit | watt |
| Property | Value |
|---|---|
| UUID | 00000002-0001-1000-8000-0036AC324978 |
| Permissions | Paired Read, Notify |
| Format | float |
| Unit | watt |
| Property | Value |
|---|---|
| UUID | 00000003-0001-1000-8000-0036AC324978 |
| Permissions | Paired Read, Notify |
| Format | float |
| Unit | watt |
| Property | Value |
|---|---|
| UUID | 00000004-0001-1000-8000-0036AC324978 |
| Permissions | Paired Read, Notify |
| Format | float |
| Unit | watt |
| Property | Value |
|---|---|
| UUID | 00000005-0001-1000-8000-0036AC324978 |
| Permissions | Paired Read, Notify |
| Format | float |
| Minimum Value | 0 |
| Unit | kilowatthours |
This characteristic helps the frontend to provide a more suitable visualization for the meter. Implementations should conform to the following rules:
- A meter without this type characteristic is assumed to be of type OTHER
- The meaning of a positive/negative CurrentPower depends on the type:
- PRODUCTION, CONSUMPTION, OTHER: a positive value has a good connotation for the user
- STORAGE, GRID: a negative value has a bad connotation for the user E.g.: A negative current power at the mains connection means the user is currently selling energy and thus earning money, which is considered positive.
| Property | Value |
|---|---|
| UUID | 00000006-0001-1000-8000-0036AC324978 |
| Permissions | Paired Read |
| Format | uint8 |
| Minimum Value | 0 |
| Maximum Value | 5 |
| Valid Values | 0 "other" 1 "production" 2 "consumption" 3 "storage" 4 "grid" 5 "excess" |
