mirror of https://github.com/home-assistant/core
144 lines
4.9 KiB
Python
144 lines
4.9 KiB
Python
"""GoodWe PV inverter numeric settings entities."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from collections.abc import Awaitable, Callable
|
|
from dataclasses import dataclass
|
|
import logging
|
|
|
|
from goodwe import Inverter, InverterError
|
|
|
|
from homeassistant.components.number import (
|
|
NumberDeviceClass,
|
|
NumberEntity,
|
|
NumberEntityDescription,
|
|
)
|
|
from homeassistant.config_entries import ConfigEntry
|
|
from homeassistant.const import PERCENTAGE, EntityCategory, UnitOfPower
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers.device_registry import DeviceInfo
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
|
|
from .const import DOMAIN, KEY_DEVICE_INFO, KEY_INVERTER
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
|
|
@dataclass(frozen=True, kw_only=True)
|
|
class GoodweNumberEntityDescription(NumberEntityDescription):
|
|
"""Class describing Goodwe number entities."""
|
|
|
|
getter: Callable[[Inverter], Awaitable[int]]
|
|
setter: Callable[[Inverter, int], Awaitable[None]]
|
|
filter: Callable[[Inverter], bool]
|
|
|
|
|
|
def _get_setting_unit(inverter: Inverter, setting: str) -> str:
|
|
"""Return the unit of an inverter setting."""
|
|
return next((s.unit for s in inverter.settings() if s.id_ == setting), "")
|
|
|
|
|
|
NUMBERS = (
|
|
# Only one of the export limits are added.
|
|
# Availability is checked in the filter method.
|
|
# Export limit in W
|
|
GoodweNumberEntityDescription(
|
|
key="grid_export_limit",
|
|
translation_key="grid_export_limit",
|
|
entity_category=EntityCategory.CONFIG,
|
|
device_class=NumberDeviceClass.POWER,
|
|
native_unit_of_measurement=UnitOfPower.WATT,
|
|
native_step=100,
|
|
native_min_value=0,
|
|
native_max_value=10000,
|
|
getter=lambda inv: inv.get_grid_export_limit(),
|
|
setter=lambda inv, val: inv.set_grid_export_limit(val),
|
|
filter=lambda inv: _get_setting_unit(inv, "grid_export_limit") != "%",
|
|
),
|
|
# Export limit in %
|
|
GoodweNumberEntityDescription(
|
|
key="grid_export_limit",
|
|
translation_key="grid_export_limit",
|
|
entity_category=EntityCategory.CONFIG,
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
native_step=1,
|
|
native_min_value=0,
|
|
native_max_value=200,
|
|
getter=lambda inv: inv.get_grid_export_limit(),
|
|
setter=lambda inv, val: inv.set_grid_export_limit(val),
|
|
filter=lambda inv: _get_setting_unit(inv, "grid_export_limit") == "%",
|
|
),
|
|
GoodweNumberEntityDescription(
|
|
key="battery_discharge_depth",
|
|
translation_key="battery_discharge_depth",
|
|
icon="mdi:battery-arrow-down",
|
|
entity_category=EntityCategory.CONFIG,
|
|
native_unit_of_measurement=PERCENTAGE,
|
|
native_step=1,
|
|
native_min_value=0,
|
|
native_max_value=99,
|
|
getter=lambda inv: inv.get_ongrid_battery_dod(),
|
|
setter=lambda inv, val: inv.set_ongrid_battery_dod(val),
|
|
filter=lambda inv: True,
|
|
),
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
config_entry: ConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up the inverter select entities from a config entry."""
|
|
inverter = hass.data[DOMAIN][config_entry.entry_id][KEY_INVERTER]
|
|
device_info = hass.data[DOMAIN][config_entry.entry_id][KEY_DEVICE_INFO]
|
|
|
|
entities = []
|
|
|
|
for description in filter(lambda dsc: dsc.filter(inverter), NUMBERS):
|
|
try:
|
|
current_value = await description.getter(inverter)
|
|
except (InverterError, ValueError):
|
|
# Inverter model does not support this setting
|
|
_LOGGER.debug("Could not read inverter setting %s", description.key)
|
|
continue
|
|
|
|
entities.append(
|
|
InverterNumberEntity(device_info, description, inverter, current_value)
|
|
)
|
|
|
|
async_add_entities(entities)
|
|
|
|
|
|
class InverterNumberEntity(NumberEntity):
|
|
"""Inverter numeric setting entity."""
|
|
|
|
_attr_should_poll = False
|
|
_attr_has_entity_name = True
|
|
entity_description: GoodweNumberEntityDescription
|
|
|
|
def __init__(
|
|
self,
|
|
device_info: DeviceInfo,
|
|
description: GoodweNumberEntityDescription,
|
|
inverter: Inverter,
|
|
current_value: int,
|
|
) -> None:
|
|
"""Initialize the number inverter setting entity."""
|
|
self.entity_description = description
|
|
self._attr_unique_id = f"{DOMAIN}-{description.key}-{inverter.serial_number}"
|
|
self._attr_device_info = device_info
|
|
self._attr_native_value = float(current_value)
|
|
self._inverter: Inverter = inverter
|
|
|
|
async def async_update(self) -> None:
|
|
"""Get the current value from inverter."""
|
|
value = await self.entity_description.getter(self._inverter)
|
|
self._attr_native_value = float(value)
|
|
|
|
async def async_set_native_value(self, value: float) -> None:
|
|
"""Set new value."""
|
|
await self.entity_description.setter(self._inverter, int(value))
|
|
self._attr_native_value = value
|
|
self.async_write_ha_state()
|