fan.py

Go to the documentation of this file.

"""Support for VeSync fans."""
 
from __future__ import annotations
 
import logging
import math
from typing import Any
 
from homeassistant.components.fan import FanEntity, FanEntityFeature
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.dispatcher import async_dispatcher_connect
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util.percentage import (
    percentage_to_ranged_value,
    ranged_value_to_percentage,
)
from homeassistant.util.scaling import int_states_in_range
 
from .const import DEV_TYPE_TO_HA, DOMAIN, SKU_TO_BASE_DEVICE, VS_DISCOVERY, VS_FANS
from .entity import VeSyncDevice
 
_LOGGER = logging.getLogger(__name__)
 
FAN_MODE_AUTO = "auto"
FAN_MODE_SLEEP = "sleep"
FAN_MODE_PET = "pet"
FAN_MODE_TURBO = "turbo"
 
PRESET_MODES = {
    "LV-PUR131S": [FAN_MODE_AUTO, FAN_MODE_SLEEP],
    "Core200S": [FAN_MODE_SLEEP],
    "Core300S": [FAN_MODE_AUTO, FAN_MODE_SLEEP],
    "Core400S": [FAN_MODE_AUTO, FAN_MODE_SLEEP],
    "Core600S": [FAN_MODE_AUTO, FAN_MODE_SLEEP],
    "EverestAir": [FAN_MODE_AUTO, FAN_MODE_SLEEP, FAN_MODE_TURBO],
    "Vital200S": [FAN_MODE_AUTO, FAN_MODE_SLEEP, FAN_MODE_PET],
    "Vital100S": [FAN_MODE_AUTO, FAN_MODE_SLEEP, FAN_MODE_PET],
}
SPEED_RANGE = {  # off is not included
    "LV-PUR131S": (1, 3),
    "Core200S": (1, 3),
    "Core300S": (1, 3),
    "Core400S": (1, 4),
    "Core600S": (1, 4),
    "EverestAir": (1, 3),
    "Vital200S": (1, 4),
    "Vital100S": (1, 4),
}
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the VeSync fan platform."""
 
    @callback
    def discover(devices):
        """Add new devices to platform."""
        _setup_entities(devices, async_add_entities)
 
    config_entry.async_on_unload(
        async_dispatcher_connect(hass, VS_DISCOVERY.format(VS_FANS), discover)
    )
 
    _setup_entities(hass.data[DOMAIN][VS_FANS], async_add_entities)
 
 
@callback
def _setup_entities(devices, async_add_entities):
    """Check if device is online and add entity."""
    entities = []
    for dev in devices:
        if DEV_TYPE_TO_HA.get(SKU_TO_BASE_DEVICE.get(dev.device_type)) == "fan":
            entities.append(VeSyncFanHA(dev))
        else:
            _LOGGER.warning(
                "%s - Unknown device type - %s", dev.device_name, dev.device_type
            )
            continue
 
    async_add_entities(entities, update_before_add=True)
 
 
class VeSyncFanHA(VeSyncDevice, FanEntity):
    """Representation of a VeSync fan."""
 
    _attr_supported_features = (
        FanEntityFeature.SET_SPEED
        | FanEntityFeature.PRESET_MODE
        | FanEntityFeature.TURN_OFF
        | FanEntityFeature.TURN_ON
    )
    _attr_name = None
    _attr_translation_key = "vesync"
    _enable_turn_on_off_backwards_compatibility = False
 
    def __init__(self, fan) -> None:
        """Initialize the VeSync fan device."""
        super().__init__(fan)
        self.smartfansmartfan = fan
 
    @property
    def percentage(self) -> int | None:
        """Return the current speed."""
        if (
            self.smartfansmartfan.mode == "manual"
            and (current_level := self.smartfansmartfan.fan_level) is not None
        ):
            return ranged_value_to_percentage(
                SPEED_RANGE[SKU_TO_BASE_DEVICE[self.devicedevice.device_type]], current_level
            )
        return None
 
    @property
    def speed_count(self) -> int:
        """Return the number of speeds the fan supports."""
        return int_states_in_range(
            SPEED_RANGE[SKU_TO_BASE_DEVICE[self.devicedevice.device_type]]
        )
 
    @property
    def preset_modes(self) -> list[str]:
        """Get the list of available preset modes."""
        return PRESET_MODES[SKU_TO_BASE_DEVICE[self.devicedevice.device_type]]
 
    @property
    def preset_mode(self) -> str | None:
        """Get the current preset mode."""
        if self.smartfansmartfan.mode in (FAN_MODE_AUTO, FAN_MODE_SLEEP, FAN_MODE_TURBO):
            return self.smartfansmartfan.mode
        return None
 
    @property
    def unique_info(self):
        """Return the ID of this fan."""
        return self.smartfansmartfan.uuid
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return the state attributes of the fan."""
        attr = {}
 
        if hasattr(self.smartfansmartfan, "active_time"):
            attr["active_time"] = self.smartfansmartfan.active_time
 
        if hasattr(self.smartfansmartfan, "screen_status"):
            attr["screen_status"] = self.smartfansmartfan.screen_status
 
        if hasattr(self.smartfansmartfan, "child_lock"):
            attr["child_lock"] = self.smartfansmartfan.child_lock
 
        if hasattr(self.smartfansmartfan, "night_light"):
            attr["night_light"] = self.smartfansmartfan.night_light
 
        if hasattr(self.smartfansmartfan, "mode"):
            attr["mode"] = self.smartfansmartfan.mode
 
        return attr
 
    def set_percentage(self, percentage: int) -> None:
        """Set the speed of the device."""
        if percentage == 0:
            self.smartfansmartfan.turn_off()
            return
 
        if not self.smartfansmartfan.is_on:
            self.smartfansmartfan.turn_on()
 
        self.smartfansmartfan.manual_mode()
        self.smartfansmartfan.change_fan_speed(
            math.ceil(
                percentage_to_ranged_value(
                    SPEED_RANGE[SKU_TO_BASE_DEVICE[self.devicedevice.device_type]], percentage
                )
            )
        )
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def set_preset_mode(self, preset_mode: str) -> None:
        """Set the preset mode of device."""
        if preset_mode not in self.preset_modespreset_modespreset_modes:
            raise ValueError(
                f"{preset_mode} is not one of the valid preset modes: "
                f"{self.preset_modes}"
            )
 
        if not self.smartfansmartfan.is_on:
            self.smartfansmartfan.turn_on()
 
        if preset_mode == FAN_MODE_AUTO:
            self.smartfansmartfan.auto_mode()
        elif preset_mode == FAN_MODE_SLEEP:
            self.smartfansmartfan.sleep_mode()
        elif preset_mode == FAN_MODE_PET:
            self.smartfansmartfan.pet_mode()
        elif preset_mode == FAN_MODE_TURBO:
            self.smartfansmartfan.turbo_mode()
 
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def turn_on(
        self,
        percentage: int | None = None,
        preset_mode: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Turn the device on."""
        if preset_mode:
            self.set_preset_modeset_preset_modeset_preset_mode(preset_mode)
            return
        if percentage is None:
            percentage = 50
        self.set_percentageset_percentageset_percentage(percentage)