home-assistant
/
core
mirror of https://github.com/home-assistant/core
0
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
core/homeassistant/components/xiaomi_miio/number.py

471 lines
16 KiB
Python
Raw Permalink Blame History

"""Motor speed support for Xiaomi Mi Air Humidifier."""
from __future__ import annotations
import dataclasses
from dataclasses import dataclass
from miio import Device
from homeassistant.components.number import (
DOMAIN as PLATFORM_DOMAIN,
NumberEntity,
NumberEntityDescription,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
CONF_DEVICE,
CONF_MODEL,
DEGREE,
REVOLUTIONS_PER_MINUTE,
EntityCategory,
UnitOfTime,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers import entity_registry as er
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import DataUpdateCoordinator
from .const import (
CONF_FLOW_TYPE,
DOMAIN,
FEATURE_FLAGS_AIRFRESH,
FEATURE_FLAGS_AIRFRESH_A1,
FEATURE_FLAGS_AIRFRESH_T2017,
FEATURE_FLAGS_AIRFRESH_VA4,
FEATURE_FLAGS_AIRHUMIDIFIER_CA4,
FEATURE_FLAGS_AIRHUMIDIFIER_CA_AND_CB,
FEATURE_FLAGS_AIRPURIFIER_2S,
FEATURE_FLAGS_AIRPURIFIER_3C,
FEATURE_FLAGS_AIRPURIFIER_4,
FEATURE_FLAGS_AIRPURIFIER_4_LITE,
FEATURE_FLAGS_AIRPURIFIER_MIIO,
FEATURE_FLAGS_AIRPURIFIER_MIOT,
FEATURE_FLAGS_AIRPURIFIER_PRO,
FEATURE_FLAGS_AIRPURIFIER_PRO_V7,
FEATURE_FLAGS_AIRPURIFIER_V1,
FEATURE_FLAGS_AIRPURIFIER_V3,
FEATURE_FLAGS_AIRPURIFIER_ZA1,
FEATURE_FLAGS_FAN,
FEATURE_FLAGS_FAN_1C,
FEATURE_FLAGS_FAN_P5,
FEATURE_FLAGS_FAN_P9,
FEATURE_FLAGS_FAN_P10_P11_P18,
FEATURE_FLAGS_FAN_ZA5,
FEATURE_SET_DELAY_OFF_COUNTDOWN,
FEATURE_SET_FAN_LEVEL,
FEATURE_SET_FAVORITE_LEVEL,
FEATURE_SET_FAVORITE_RPM,
FEATURE_SET_LED_BRIGHTNESS,
FEATURE_SET_LED_BRIGHTNESS_LEVEL,
FEATURE_SET_MOTOR_SPEED,
FEATURE_SET_OSCILLATION_ANGLE,
FEATURE_SET_VOLUME,
KEY_COORDINATOR,
KEY_DEVICE,
MODEL_AIRFRESH_A1,
MODEL_AIRFRESH_T2017,
MODEL_AIRFRESH_VA2,
MODEL_AIRFRESH_VA4,
MODEL_AIRHUMIDIFIER_CA1,
MODEL_AIRHUMIDIFIER_CA4,
MODEL_AIRHUMIDIFIER_CB1,
MODEL_AIRPURIFIER_2S,
MODEL_AIRPURIFIER_3C,
MODEL_AIRPURIFIER_3C_REV_A,
MODEL_AIRPURIFIER_4,
MODEL_AIRPURIFIER_4_LITE_RMA1,
MODEL_AIRPURIFIER_4_LITE_RMB1,
MODEL_AIRPURIFIER_4_PRO,
MODEL_AIRPURIFIER_PRO,
MODEL_AIRPURIFIER_PRO_V7,
MODEL_AIRPURIFIER_V1,
MODEL_AIRPURIFIER_V3,
MODEL_AIRPURIFIER_ZA1,
MODEL_FAN_1C,
MODEL_FAN_P5,
MODEL_FAN_P9,
MODEL_FAN_P10,
MODEL_FAN_P11,
MODEL_FAN_P18,
MODEL_FAN_SA1,
MODEL_FAN_V2,
MODEL_FAN_V3,
MODEL_FAN_ZA1,
MODEL_FAN_ZA3,
MODEL_FAN_ZA4,
MODEL_FAN_ZA5,
MODELS_PURIFIER_MIIO,
MODELS_PURIFIER_MIOT,
)
from .entity import XiaomiCoordinatedMiioEntity
ATTR_DELAY_OFF_COUNTDOWN = "delay_off_countdown"
ATTR_FAN_LEVEL = "fan_level"
ATTR_FAVORITE_LEVEL = "favorite_level"
ATTR_FAVORITE_RPM = "favorite_rpm"
ATTR_LED_BRIGHTNESS = "led_brightness"
ATTR_LED_BRIGHTNESS_LEVEL = "led_brightness_level"
ATTR_MOTOR_SPEED = "motor_speed"
ATTR_OSCILLATION_ANGLE = "angle"
ATTR_VOLUME = "volume"
@dataclass(frozen=True, kw_only=True)
class XiaomiMiioNumberDescription(NumberEntityDescription):
"""A class that describes number entities."""
method: str
available_with_device_off: bool = True
@dataclass
class OscillationAngleValues:
"""A class that describes oscillation angle values."""
max_value: float | None = None
min_value: float | None = None
step: float | None = None
@dataclass
class FavoriteLevelValues:
"""A class that describes favorite level values."""
max_value: float | None = None
min_value: float | None = None
step: float | None = None
NUMBER_TYPES = {
FEATURE_SET_MOTOR_SPEED: XiaomiMiioNumberDescription(
key=ATTR_MOTOR_SPEED,
translation_key=ATTR_MOTOR_SPEED,
icon="mdi:fast-forward-outline",
native_unit_of_measurement=REVOLUTIONS_PER_MINUTE,
native_min_value=200,
native_max_value=2000,
native_step=10,
available_with_device_off=False,
method="async_set_motor_speed",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_FAVORITE_LEVEL: XiaomiMiioNumberDescription(
key=ATTR_FAVORITE_LEVEL,
translation_key=ATTR_FAVORITE_LEVEL,
icon="mdi:star-cog",
native_min_value=0,
native_max_value=17,
native_step=1,
method="async_set_favorite_level",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_FAN_LEVEL: XiaomiMiioNumberDescription(
key=ATTR_FAN_LEVEL,
translation_key=ATTR_FAN_LEVEL,
icon="mdi:fan",
native_min_value=1,
native_max_value=3,
native_step=1,
method="async_set_fan_level",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_VOLUME: XiaomiMiioNumberDescription(
key=ATTR_VOLUME,
translation_key=ATTR_VOLUME,
icon="mdi:volume-high",
native_min_value=0,
native_max_value=100,
native_step=1,
method="async_set_volume",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_OSCILLATION_ANGLE: XiaomiMiioNumberDescription(
key=ATTR_OSCILLATION_ANGLE,
translation_key=ATTR_OSCILLATION_ANGLE,
icon="mdi:angle-acute",
native_unit_of_measurement=DEGREE,
native_min_value=1,
native_max_value=120,
native_step=1,
method="async_set_oscillation_angle",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_DELAY_OFF_COUNTDOWN: XiaomiMiioNumberDescription(
key=ATTR_DELAY_OFF_COUNTDOWN,
translation_key=ATTR_DELAY_OFF_COUNTDOWN,
icon="mdi:fan-off",
native_unit_of_measurement=UnitOfTime.MINUTES,
native_min_value=0,
native_max_value=480,
native_step=1,
method="async_set_delay_off_countdown",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_LED_BRIGHTNESS: XiaomiMiioNumberDescription(
key=ATTR_LED_BRIGHTNESS,
translation_key=ATTR_LED_BRIGHTNESS,
icon="mdi:brightness-6",
native_min_value=0,
native_max_value=100,
native_step=1,
method="async_set_led_brightness",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_LED_BRIGHTNESS_LEVEL: XiaomiMiioNumberDescription(
key=ATTR_LED_BRIGHTNESS_LEVEL,
translation_key=ATTR_LED_BRIGHTNESS_LEVEL,
icon="mdi:brightness-6",
native_min_value=0,
native_max_value=8,
native_step=1,
method="async_set_led_brightness_level",
entity_category=EntityCategory.CONFIG,
),
FEATURE_SET_FAVORITE_RPM: XiaomiMiioNumberDescription(
key=ATTR_FAVORITE_RPM,
translation_key=ATTR_FAVORITE_RPM,
icon="mdi:star-cog",
native_unit_of_measurement=REVOLUTIONS_PER_MINUTE,
native_min_value=300,
native_max_value=2200,
native_step=10,
method="async_set_favorite_rpm",
entity_category=EntityCategory.CONFIG,
),
}
MODEL_TO_FEATURES_MAP = {
MODEL_AIRFRESH_A1: FEATURE_FLAGS_AIRFRESH_A1,
MODEL_AIRFRESH_VA2: FEATURE_FLAGS_AIRFRESH,
MODEL_AIRFRESH_VA4: FEATURE_FLAGS_AIRFRESH_VA4,
MODEL_AIRFRESH_T2017: FEATURE_FLAGS_AIRFRESH_T2017,
MODEL_AIRHUMIDIFIER_CA1: FEATURE_FLAGS_AIRHUMIDIFIER_CA_AND_CB,
MODEL_AIRHUMIDIFIER_CA4: FEATURE_FLAGS_AIRHUMIDIFIER_CA4,
MODEL_AIRHUMIDIFIER_CB1: FEATURE_FLAGS_AIRHUMIDIFIER_CA_AND_CB,
MODEL_AIRPURIFIER_2S: FEATURE_FLAGS_AIRPURIFIER_2S,
MODEL_AIRPURIFIER_3C: FEATURE_FLAGS_AIRPURIFIER_3C,
MODEL_AIRPURIFIER_3C_REV_A: FEATURE_FLAGS_AIRPURIFIER_3C,
MODEL_AIRPURIFIER_PRO: FEATURE_FLAGS_AIRPURIFIER_PRO,
MODEL_AIRPURIFIER_PRO_V7: FEATURE_FLAGS_AIRPURIFIER_PRO_V7,
MODEL_AIRPURIFIER_V1: FEATURE_FLAGS_AIRPURIFIER_V1,
MODEL_AIRPURIFIER_V3: FEATURE_FLAGS_AIRPURIFIER_V3,
MODEL_AIRPURIFIER_4_LITE_RMA1: FEATURE_FLAGS_AIRPURIFIER_4_LITE,
MODEL_AIRPURIFIER_4_LITE_RMB1: FEATURE_FLAGS_AIRPURIFIER_4_LITE,
MODEL_AIRPURIFIER_4: FEATURE_FLAGS_AIRPURIFIER_4,
MODEL_AIRPURIFIER_4_PRO: FEATURE_FLAGS_AIRPURIFIER_4,
MODEL_AIRPURIFIER_ZA1: FEATURE_FLAGS_AIRPURIFIER_ZA1,
MODEL_FAN_1C: FEATURE_FLAGS_FAN_1C,
MODEL_FAN_P10: FEATURE_FLAGS_FAN_P10_P11_P18,
MODEL_FAN_P11: FEATURE_FLAGS_FAN_P10_P11_P18,
MODEL_FAN_P18: FEATURE_FLAGS_FAN_P10_P11_P18,
MODEL_FAN_P5: FEATURE_FLAGS_FAN_P5,
MODEL_FAN_P9: FEATURE_FLAGS_FAN_P9,
MODEL_FAN_SA1: FEATURE_FLAGS_FAN,
MODEL_FAN_V2: FEATURE_FLAGS_FAN,
MODEL_FAN_V3: FEATURE_FLAGS_FAN,
MODEL_FAN_ZA1: FEATURE_FLAGS_FAN,
MODEL_FAN_ZA3: FEATURE_FLAGS_FAN,
MODEL_FAN_ZA4: FEATURE_FLAGS_FAN,
MODEL_FAN_ZA5: FEATURE_FLAGS_FAN_ZA5,
}
OSCILLATION_ANGLE_VALUES = {
MODEL_FAN_P5: OscillationAngleValues(max_value=140, min_value=30, step=30),
MODEL_FAN_ZA5: OscillationAngleValues(max_value=120, min_value=30, step=30),
MODEL_FAN_P9: OscillationAngleValues(max_value=150, min_value=30, step=30),
MODEL_FAN_P10: OscillationAngleValues(max_value=140, min_value=30, step=30),
MODEL_FAN_P11: OscillationAngleValues(max_value=140, min_value=30, step=30),
MODEL_FAN_P18: OscillationAngleValues(max_value=140, min_value=30, step=30),
}
FAVORITE_LEVEL_VALUES = {
tuple(MODELS_PURIFIER_MIIO): FavoriteLevelValues(max_value=17, min_value=0, step=1),
tuple(MODELS_PURIFIER_MIOT): FavoriteLevelValues(max_value=14, min_value=0, step=1),
}
async def async_setup_entry(
hass: HomeAssistant,
config_entry: ConfigEntry,
async_add_entities: AddEntitiesCallback,
) -> None:
"""Set up the Selectors from a config entry."""
entities = []
if config_entry.data[CONF_FLOW_TYPE] != CONF_DEVICE:
return
model = config_entry.data[CONF_MODEL]
device = hass.data[DOMAIN][config_entry.entry_id][KEY_DEVICE]
if model in MODEL_TO_FEATURES_MAP:
features = MODEL_TO_FEATURES_MAP[model]
elif model in MODELS_PURIFIER_MIIO:
features = FEATURE_FLAGS_AIRPURIFIER_MIIO
elif model in MODELS_PURIFIER_MIOT:
features = FEATURE_FLAGS_AIRPURIFIER_MIOT
else:
return
for feature, description in NUMBER_TYPES.items():
if feature == FEATURE_SET_LED_BRIGHTNESS and model != MODEL_FAN_ZA5:
# Delete LED bightness entity created by mistake if it exists
entity_reg = er.async_get(hass)
entity_id = entity_reg.async_get_entity_id(
PLATFORM_DOMAIN, DOMAIN, f"{description.key}_{config_entry.unique_id}"
)
if entity_id:
entity_reg.async_remove(entity_id)
continue
if feature & features:
if (
description.key == ATTR_OSCILLATION_ANGLE
and model in OSCILLATION_ANGLE_VALUES
):
description = dataclasses.replace(
description,
native_max_value=OSCILLATION_ANGLE_VALUES[model].max_value,
native_min_value=OSCILLATION_ANGLE_VALUES[model].min_value,
native_step=OSCILLATION_ANGLE_VALUES[model].step,
)
elif description.key == ATTR_FAVORITE_LEVEL:
for list_models, favorite_level_value in FAVORITE_LEVEL_VALUES.items():
if model in list_models:
description = dataclasses.replace(
description,
native_max_value=favorite_level_value.max_value,
native_min_value=favorite_level_value.min_value,
native_step=favorite_level_value.step,
)
entities.append(
XiaomiNumberEntity(
device,
config_entry,
f"{description.key}_{config_entry.unique_id}",
hass.data[DOMAIN][config_entry.entry_id][KEY_COORDINATOR],
description,
)
)
async_add_entities(entities)
class XiaomiNumberEntity(XiaomiCoordinatedMiioEntity, NumberEntity):
"""Representation of a generic Xiaomi attribute selector."""
entity_description: XiaomiMiioNumberDescription
def __init__(
self,
device: Device,
entry: ConfigEntry,
unique_id: str,
coordinator: DataUpdateCoordinator,
description: XiaomiMiioNumberDescription,
) -> None:
"""Initialize the generic Xiaomi attribute selector."""
super().__init__(device, entry, unique_id, coordinator)
self._attr_native_value = self._extract_value_from_attribute(
coordinator.data, description.key
)
self.entity_description = description
@property
def available(self) -> bool:
"""Return the number controller availability."""
if (
super().available
and not self.coordinator.data.is_on
and not self.entity_description.available_with_device_off
):
return False
return super().available
async def async_set_native_value(self, value: float) -> None:
"""Set an option of the miio device."""
method = getattr(self, self.entity_description.method)
if await method(int(value)):
self._attr_native_value = value
self.async_write_ha_state()
@callback
def _handle_coordinator_update(self) -> None:
"""Fetch state from the device."""
# On state change the device doesn't provide the new state immediately.
self._attr_native_value = self._extract_value_from_attribute(
self.coordinator.data, self.entity_description.key
)
self.async_write_ha_state()
async def async_set_motor_speed(self, motor_speed: int = 400) -> bool:
"""Set the target motor speed."""
return await self._try_command(
"Setting the target motor speed of the miio device failed.",
self._device.set_speed,
motor_speed,
)
async def async_set_favorite_level(self, level: int = 1) -> bool:
"""Set the favorite level."""
return await self._try_command(
"Setting the favorite level of the miio device failed.",
self._device.set_favorite_level,
level,
)
async def async_set_fan_level(self, level: int = 1) -> bool:
"""Set the fan level."""
return await self._try_command(
"Setting the fan level of the miio device failed.",
self._device.set_fan_level,
level,
)
async def async_set_volume(self, volume: int = 50) -> bool:
"""Set the volume."""
return await self._try_command(
"Setting the volume of the miio device failed.",
self._device.set_volume,
volume,
)
async def async_set_oscillation_angle(self, angle: int) -> bool:
"""Set the volume."""
return await self._try_command(
"Setting angle of the miio device failed.", self._device.set_angle, angle
)
async def async_set_delay_off_countdown(self, delay_off_countdown: int) -> bool:
"""Set the delay off countdown."""
return await self._try_command(
"Setting delay off miio device failed.",
self._device.delay_off,
delay_off_countdown,
)
async def async_set_led_brightness_level(self, level: int) -> bool:
"""Set the led brightness level."""
return await self._try_command(
"Setting the led brightness level of the miio device failed.",
self._device.set_led_brightness_level,
level,
)
async def async_set_led_brightness(self, level: int) -> bool:
"""Set the led brightness level."""
return await self._try_command(
"Setting the led brightness level of the miio device failed.",
self._device.set_led_brightness,
level,
)
async def async_set_favorite_rpm(self, rpm: int) -> bool:
"""Set the target motor speed."""
return await self._try_command(
"Setting the favorite rpm of the miio device failed.",
self._device.set_favorite_rpm,
rpm,
)
Reference in New Issue View Git Blame Copy Permalink