mirror of
https://github.com/home-assistant/core.git
synced 2025-07-16 17:57:11 +00:00
Add initial sensors for Enphase Encharge batteries (#97946)
This commit is contained in:
parent
7ea2998b55
commit
128dadafae
@ -6,7 +6,7 @@
|
|||||||
"documentation": "https://www.home-assistant.io/integrations/enphase_envoy",
|
"documentation": "https://www.home-assistant.io/integrations/enphase_envoy",
|
||||||
"iot_class": "local_polling",
|
"iot_class": "local_polling",
|
||||||
"loggers": ["pyenphase"],
|
"loggers": ["pyenphase"],
|
||||||
"requirements": ["pyenphase==0.14.1"],
|
"requirements": ["pyenphase==0.15.1"],
|
||||||
"zeroconf": [
|
"zeroconf": [
|
||||||
{
|
{
|
||||||
"type": "_enphase-envoy._tcp.local."
|
"type": "_enphase-envoy._tcp.local."
|
||||||
|
@ -6,7 +6,13 @@ from dataclasses import dataclass
|
|||||||
import datetime
|
import datetime
|
||||||
import logging
|
import logging
|
||||||
|
|
||||||
from pyenphase import EnvoyInverter, EnvoySystemConsumption, EnvoySystemProduction
|
from pyenphase import (
|
||||||
|
EnvoyEncharge,
|
||||||
|
EnvoyEnchargePower,
|
||||||
|
EnvoyInverter,
|
||||||
|
EnvoySystemConsumption,
|
||||||
|
EnvoySystemProduction,
|
||||||
|
)
|
||||||
|
|
||||||
from homeassistant.components.sensor import (
|
from homeassistant.components.sensor import (
|
||||||
SensorDeviceClass,
|
SensorDeviceClass,
|
||||||
@ -15,7 +21,13 @@ from homeassistant.components.sensor import (
|
|||||||
SensorStateClass,
|
SensorStateClass,
|
||||||
)
|
)
|
||||||
from homeassistant.config_entries import ConfigEntry
|
from homeassistant.config_entries import ConfigEntry
|
||||||
from homeassistant.const import UnitOfEnergy, UnitOfPower
|
from homeassistant.const import (
|
||||||
|
PERCENTAGE,
|
||||||
|
UnitOfApparentPower,
|
||||||
|
UnitOfEnergy,
|
||||||
|
UnitOfPower,
|
||||||
|
UnitOfTemperature,
|
||||||
|
)
|
||||||
from homeassistant.core import HomeAssistant
|
from homeassistant.core import HomeAssistant
|
||||||
from homeassistant.helpers.entity import DeviceInfo, Entity
|
from homeassistant.helpers.entity import DeviceInfo, Entity
|
||||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||||
@ -181,6 +193,71 @@ CONSUMPTION_SENSORS = (
|
|||||||
)
|
)
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class EnvoyEnchargeRequiredKeysMixin:
|
||||||
|
"""Mixin for required keys."""
|
||||||
|
|
||||||
|
value_fn: Callable[[EnvoyEncharge], datetime.datetime | int | float]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class EnvoyEnchargeSensorEntityDescription(
|
||||||
|
SensorEntityDescription, EnvoyEnchargeRequiredKeysMixin
|
||||||
|
):
|
||||||
|
"""Describes an Envoy Encharge sensor entity."""
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class EnvoyEnchargePowerRequiredKeysMixin:
|
||||||
|
"""Mixin for required keys."""
|
||||||
|
|
||||||
|
value_fn: Callable[[EnvoyEnchargePower], int | float]
|
||||||
|
|
||||||
|
|
||||||
|
@dataclass
|
||||||
|
class EnvoyEnchargePowerSensorEntityDescription(
|
||||||
|
SensorEntityDescription, EnvoyEnchargePowerRequiredKeysMixin
|
||||||
|
):
|
||||||
|
"""Describes an Envoy Encharge sensor entity."""
|
||||||
|
|
||||||
|
|
||||||
|
ENCHARGE_INVENTORY_SENSORS = (
|
||||||
|
EnvoyEnchargeSensorEntityDescription(
|
||||||
|
key="temperature",
|
||||||
|
native_unit_of_measurement=UnitOfTemperature.CELSIUS,
|
||||||
|
device_class=SensorDeviceClass.TEMPERATURE,
|
||||||
|
value_fn=lambda encharge: encharge.temperature,
|
||||||
|
),
|
||||||
|
EnvoyEnchargeSensorEntityDescription(
|
||||||
|
key=LAST_REPORTED_KEY,
|
||||||
|
translation_key=LAST_REPORTED_KEY,
|
||||||
|
native_unit_of_measurement=None,
|
||||||
|
device_class=SensorDeviceClass.TIMESTAMP,
|
||||||
|
value_fn=lambda encharge: dt_util.utc_from_timestamp(encharge.last_report_date),
|
||||||
|
),
|
||||||
|
)
|
||||||
|
ENCHARGE_POWER_SENSORS = (
|
||||||
|
EnvoyEnchargePowerSensorEntityDescription(
|
||||||
|
key="soc",
|
||||||
|
native_unit_of_measurement=PERCENTAGE,
|
||||||
|
device_class=SensorDeviceClass.BATTERY,
|
||||||
|
value_fn=lambda encharge: encharge.soc,
|
||||||
|
),
|
||||||
|
EnvoyEnchargePowerSensorEntityDescription(
|
||||||
|
key="apparent_power_mva",
|
||||||
|
native_unit_of_measurement=UnitOfApparentPower.VOLT_AMPERE,
|
||||||
|
device_class=SensorDeviceClass.APPARENT_POWER,
|
||||||
|
value_fn=lambda encharge: encharge.apparent_power_mva * 0.001,
|
||||||
|
),
|
||||||
|
EnvoyEnchargePowerSensorEntityDescription(
|
||||||
|
key="real_power_mw",
|
||||||
|
native_unit_of_measurement=UnitOfPower.WATT,
|
||||||
|
device_class=SensorDeviceClass.POWER,
|
||||||
|
value_fn=lambda encharge: encharge.real_power_mw * 0.001,
|
||||||
|
),
|
||||||
|
)
|
||||||
|
|
||||||
|
|
||||||
async def async_setup_entry(
|
async def async_setup_entry(
|
||||||
hass: HomeAssistant,
|
hass: HomeAssistant,
|
||||||
config_entry: ConfigEntry,
|
config_entry: ConfigEntry,
|
||||||
@ -210,6 +287,19 @@ async def async_setup_entry(
|
|||||||
for inverter in envoy_data.inverters
|
for inverter in envoy_data.inverters
|
||||||
)
|
)
|
||||||
|
|
||||||
|
if envoy_data.encharge_inventory:
|
||||||
|
entities.extend(
|
||||||
|
EnvoyEnchargeInventoryEntity(coordinator, description, encharge)
|
||||||
|
for description in ENCHARGE_INVENTORY_SENSORS
|
||||||
|
for encharge in envoy_data.encharge_inventory
|
||||||
|
)
|
||||||
|
if envoy_data.encharge_power:
|
||||||
|
entities.extend(
|
||||||
|
EnvoyEnchargePowerEntity(coordinator, description, encharge)
|
||||||
|
for description in ENCHARGE_POWER_SENSORS
|
||||||
|
for encharge in envoy_data.encharge_power
|
||||||
|
)
|
||||||
|
|
||||||
async_add_entities(entities)
|
async_add_entities(entities)
|
||||||
|
|
||||||
|
|
||||||
@ -314,3 +404,66 @@ class EnvoyInverterEntity(CoordinatorEntity[EnphaseUpdateCoordinator], SensorEnt
|
|||||||
assert envoy.data.inverters is not None
|
assert envoy.data.inverters is not None
|
||||||
inverter = envoy.data.inverters[self._serial_number]
|
inverter = envoy.data.inverters[self._serial_number]
|
||||||
return self.entity_description.value_fn(inverter)
|
return self.entity_description.value_fn(inverter)
|
||||||
|
|
||||||
|
|
||||||
|
class EnvoyEnchargeEntity(CoordinatorEntity[EnphaseUpdateCoordinator], SensorEntity):
|
||||||
|
"""Envoy Encharge sensor entity."""
|
||||||
|
|
||||||
|
entity_description: EnvoyEnchargeSensorEntityDescription | EnvoyEnchargePowerSensorEntityDescription
|
||||||
|
_attr_has_entity_name = True
|
||||||
|
|
||||||
|
def __init__(
|
||||||
|
self,
|
||||||
|
coordinator: EnphaseUpdateCoordinator,
|
||||||
|
description: EnvoyEnchargeSensorEntityDescription
|
||||||
|
| EnvoyEnchargePowerSensorEntityDescription,
|
||||||
|
serial_number: str,
|
||||||
|
) -> None:
|
||||||
|
"""Initialize Encharge entity."""
|
||||||
|
self.entity_description = description
|
||||||
|
self._serial_number = serial_number
|
||||||
|
envoy_serial_num = coordinator.envoy.serial_number
|
||||||
|
assert envoy_serial_num is not None
|
||||||
|
self._attr_unique_id = f"{serial_number}_{description.key}"
|
||||||
|
assert coordinator.envoy.data is not None
|
||||||
|
assert coordinator.envoy.data.encharge_inventory is not None
|
||||||
|
encharge = coordinator.envoy.data.encharge_inventory[self._serial_number]
|
||||||
|
self._attr_device_info = DeviceInfo(
|
||||||
|
identifiers={(DOMAIN, serial_number)},
|
||||||
|
manufacturer="Enphase",
|
||||||
|
model="Encharge",
|
||||||
|
name=f"Encharge {serial_number}",
|
||||||
|
sw_version=str(encharge.firmware_version),
|
||||||
|
via_device=(DOMAIN, envoy_serial_num),
|
||||||
|
)
|
||||||
|
super().__init__(coordinator)
|
||||||
|
|
||||||
|
|
||||||
|
class EnvoyEnchargeInventoryEntity(EnvoyEnchargeEntity):
|
||||||
|
"""Envoy Encharge inventory entity."""
|
||||||
|
|
||||||
|
entity_description: EnvoyEnchargeSensorEntityDescription
|
||||||
|
|
||||||
|
@property
|
||||||
|
def native_value(self) -> int | float | datetime.datetime | None:
|
||||||
|
"""Return the state of the inventory sensors."""
|
||||||
|
envoy = self.coordinator.envoy
|
||||||
|
assert envoy.data is not None
|
||||||
|
assert envoy.data.encharge_inventory is not None
|
||||||
|
encharge = envoy.data.encharge_inventory[self._serial_number]
|
||||||
|
return self.entity_description.value_fn(encharge)
|
||||||
|
|
||||||
|
|
||||||
|
class EnvoyEnchargePowerEntity(EnvoyEnchargeEntity):
|
||||||
|
"""Envoy Encharge power entity."""
|
||||||
|
|
||||||
|
entity_description: EnvoyEnchargePowerSensorEntityDescription
|
||||||
|
|
||||||
|
@property
|
||||||
|
def native_value(self) -> int | float | None:
|
||||||
|
"""Return the state of the power sensors."""
|
||||||
|
envoy = self.coordinator.envoy
|
||||||
|
assert envoy.data is not None
|
||||||
|
assert envoy.data.encharge_power is not None
|
||||||
|
encharge = envoy.data.encharge_power[self._serial_number]
|
||||||
|
return self.entity_description.value_fn(encharge)
|
||||||
|
@ -1662,7 +1662,7 @@ pyedimax==0.2.1
|
|||||||
pyefergy==22.1.1
|
pyefergy==22.1.1
|
||||||
|
|
||||||
# homeassistant.components.enphase_envoy
|
# homeassistant.components.enphase_envoy
|
||||||
pyenphase==0.14.1
|
pyenphase==0.15.1
|
||||||
|
|
||||||
# homeassistant.components.envisalink
|
# homeassistant.components.envisalink
|
||||||
pyenvisalink==4.6
|
pyenvisalink==4.6
|
||||||
|
@ -1229,7 +1229,7 @@ pyeconet==0.1.20
|
|||||||
pyefergy==22.1.1
|
pyefergy==22.1.1
|
||||||
|
|
||||||
# homeassistant.components.enphase_envoy
|
# homeassistant.components.enphase_envoy
|
||||||
pyenphase==0.14.1
|
pyenphase==0.15.1
|
||||||
|
|
||||||
# homeassistant.components.everlights
|
# homeassistant.components.everlights
|
||||||
pyeverlights==0.1.0
|
pyeverlights==0.1.0
|
||||||
|
Loading…
x
Reference in New Issue
Block a user