core/homeassistant/components/flexit_bacnet/number.py

262 lines
11 KiB
Python

"""The Flexit Nordic (BACnet) integration."""
import asyncio.exceptions
from collections.abc import Awaitable, Callable
from dataclasses import dataclass
from flexit_bacnet import FlexitBACnet
from flexit_bacnet.bacnet import DecodingError
from homeassistant.components.number import (
NumberDeviceClass,
NumberEntity,
NumberEntityDescription,
NumberMode,
)
from homeassistant.const import PERCENTAGE, UnitOfTime
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddConfigEntryEntitiesCallback
from .const import DOMAIN
from .coordinator import FlexitConfigEntry, FlexitCoordinator
from .entity import FlexitEntity
_MAX_FAN_SETPOINT = 100
_MIN_FAN_SETPOINT = 30
_MAX_RUNTIME_DURATION = 360
_MIN_RUNTIME_DURATION = 1
@dataclass(kw_only=True, frozen=True)
class FlexitNumberEntityDescription(NumberEntityDescription):
"""Describes a Flexit number entity."""
native_value_fn: Callable[[FlexitBACnet], float]
native_max_value_fn: Callable[[FlexitBACnet], int]
native_min_value_fn: Callable[[FlexitBACnet], int]
set_native_value_fn: Callable[[FlexitBACnet], Callable[[int], Awaitable[None]]]
# Setpoints for Away, Home and High are dependent of each other. Fireplace and Cooker Hood
# have setpoints between 0 (MIN_FAN_SETPOINT) and 100 (MAX_FAN_SETPOINT).
# See the table below for all the setpoints.
#
# | Mode | Setpoint | Min | Max |
# |:------------|----------|:----------------------|:----------------------|
# | HOME | Supply | AWAY Supply setpoint | 100 |
# | HOME | Extract | AWAY Extract setpoint | 100 |
# | AWAY | Supply | 30 | HOME Supply setpoint |
# | AWAY | Extract | 30 | HOME Extract setpoint |
# | HIGH | Supply | HOME Supply setpoint | 100 |
# | HIGH | Extract | HOME Extract setpoint | 100 |
# | COOKER_HOOD | Supply | 30 | 100 |
# | COOKER_HOOD | Extract | 30 | 100 |
# | FIREPLACE | Supply | 30 | 100 |
# | FIREPLACE | Extract | 30 | 100 |
NUMBERS: tuple[FlexitNumberEntityDescription, ...] = (
FlexitNumberEntityDescription(
key="away_extract_fan_setpoint",
translation_key="away_extract_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_extract_air_away,
set_native_value_fn=lambda device: device.set_fan_setpoint_extract_air_away,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda device: int(device.fan_setpoint_extract_air_home),
native_min_value_fn=lambda _: _MIN_FAN_SETPOINT,
),
FlexitNumberEntityDescription(
key="away_supply_fan_setpoint",
translation_key="away_supply_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_supply_air_away,
set_native_value_fn=lambda device: device.set_fan_setpoint_supply_air_away,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda device: int(device.fan_setpoint_supply_air_home),
native_min_value_fn=lambda _: _MIN_FAN_SETPOINT,
),
FlexitNumberEntityDescription(
key="cooker_hood_extract_fan_setpoint",
translation_key="cooker_hood_extract_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_extract_air_cooker,
set_native_value_fn=lambda device: device.set_fan_setpoint_extract_air_cooker,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda _: _MIN_FAN_SETPOINT,
),
FlexitNumberEntityDescription(
key="cooker_hood_supply_fan_setpoint",
translation_key="cooker_hood_supply_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_supply_air_cooker,
set_native_value_fn=lambda device: device.set_fan_setpoint_supply_air_cooker,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda _: _MIN_FAN_SETPOINT,
),
FlexitNumberEntityDescription(
key="fireplace_extract_fan_setpoint",
translation_key="fireplace_extract_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_extract_air_fire,
set_native_value_fn=lambda device: device.set_fan_setpoint_extract_air_fire,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda _: _MIN_FAN_SETPOINT,
),
FlexitNumberEntityDescription(
key="fireplace_supply_fan_setpoint",
translation_key="fireplace_supply_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_supply_air_fire,
set_native_value_fn=lambda device: device.set_fan_setpoint_supply_air_fire,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda _: _MIN_FAN_SETPOINT,
),
FlexitNumberEntityDescription(
key="high_extract_fan_setpoint",
translation_key="high_extract_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_extract_air_high,
set_native_value_fn=lambda device: device.set_fan_setpoint_extract_air_high,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda device: int(device.fan_setpoint_extract_air_home),
),
FlexitNumberEntityDescription(
key="high_supply_fan_setpoint",
translation_key="high_supply_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_supply_air_high,
set_native_value_fn=lambda device: device.set_fan_setpoint_supply_air_high,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda device: int(device.fan_setpoint_supply_air_home),
),
FlexitNumberEntityDescription(
key="home_extract_fan_setpoint",
translation_key="home_extract_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_extract_air_home,
set_native_value_fn=lambda device: device.set_fan_setpoint_extract_air_home,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda device: int(device.fan_setpoint_extract_air_away),
),
FlexitNumberEntityDescription(
key="home_supply_fan_setpoint",
translation_key="home_supply_fan_setpoint",
device_class=NumberDeviceClass.POWER_FACTOR,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fan_setpoint_supply_air_home,
set_native_value_fn=lambda device: device.set_fan_setpoint_supply_air_home,
native_unit_of_measurement=PERCENTAGE,
native_max_value_fn=lambda _: _MAX_FAN_SETPOINT,
native_min_value_fn=lambda device: int(device.fan_setpoint_supply_air_away),
),
FlexitNumberEntityDescription(
key="fireplace_mode_runtime",
translation_key="fireplace_mode_runtime",
device_class=NumberDeviceClass.DURATION,
native_step=1,
mode=NumberMode.SLIDER,
native_value_fn=lambda device: device.fireplace_mode_runtime,
set_native_value_fn=lambda device: device.set_fireplace_mode_runtime,
native_unit_of_measurement=UnitOfTime.MINUTES,
native_max_value_fn=lambda _: _MAX_RUNTIME_DURATION,
native_min_value_fn=lambda _: _MIN_RUNTIME_DURATION,
),
)
async def async_setup_entry(
hass: HomeAssistant,
config_entry: FlexitConfigEntry,
async_add_entities: AddConfigEntryEntitiesCallback,
) -> None:
"""Set up Flexit (bacnet) number from a config entry."""
coordinator = config_entry.runtime_data
async_add_entities(
FlexitNumber(coordinator, description) for description in NUMBERS
)
PARALLEL_UPDATES = 1
class FlexitNumber(FlexitEntity, NumberEntity):
"""Representation of a Flexit Number."""
entity_description: FlexitNumberEntityDescription
def __init__(
self,
coordinator: FlexitCoordinator,
entity_description: FlexitNumberEntityDescription,
) -> None:
"""Initialize Flexit (bacnet) number."""
super().__init__(coordinator)
self.entity_description = entity_description
self._attr_unique_id = (
f"{coordinator.device.serial_number}-{entity_description.key}"
)
@property
def native_value(self) -> float:
"""Return the state of the number."""
return self.entity_description.native_value_fn(self.coordinator.device)
@property
def native_max_value(self) -> float:
"""Return the native max value of the number."""
return self.entity_description.native_max_value_fn(self.coordinator.device)
@property
def native_min_value(self) -> float:
"""Return the native min value of the number."""
return self.entity_description.native_min_value_fn(self.coordinator.device)
async def async_set_native_value(self, value: float) -> None:
"""Update the current value."""
set_native_value_fn = self.entity_description.set_native_value_fn(
self.coordinator.device
)
try:
await set_native_value_fn(int(value))
except (asyncio.exceptions.TimeoutError, ConnectionError, DecodingError) as exc:
raise HomeAssistantError(
translation_domain=DOMAIN,
translation_key="set_value_error",
translation_placeholders={
"value": str(value),
},
) from exc
finally:
await self.coordinator.async_refresh()