fan.py

Go to the documentation of this file.

"""Support for Big Ass Fans fan."""
 
from __future__ import annotations
 
import math
from typing import Any
 
from aiobafi6 import OffOnAuto
 
from homeassistant.components.fan import (
    DIRECTION_FORWARD,
    DIRECTION_REVERSE,
    FanEntity,
    FanEntityFeature,
)
from homeassistant.core import HomeAssistant, callback
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.util.percentage import (
    percentage_to_ranged_value,
    ranged_value_to_percentage,
)
 
from . import BAFConfigEntry
from .const import PRESET_MODE_AUTO, SPEED_COUNT, SPEED_RANGE
from .entity import BAFEntity
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    entry: BAFConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up SenseME fans."""
    device = entry.runtime_data
    if device.has_fan:
        async_add_entities([BAFFan(device)])
 
 
class BAFFan(BAFEntity, FanEntity):
    """BAF ceiling fan component."""
 
    _attr_supported_features = (
        FanEntityFeature.SET_SPEED
        | FanEntityFeature.DIRECTION
        | FanEntityFeature.PRESET_MODE
        | FanEntityFeature.TURN_OFF
        | FanEntityFeature.TURN_ON
    )
    _enable_turn_on_off_backwards_compatibility = False
    _attr_preset_modes = [PRESET_MODE_AUTO]
    _attr_speed_count = SPEED_COUNT
    _attr_name = None
    _attr_translation_key = "baf"
 
    @callback
    def _async_update_attrs(self) -> None:
        """Update attrs from device."""
        self._attr_is_on_attr_is_on = self._device_device.fan_mode == OffOnAuto.ON
        self._attr_current_direction_attr_current_direction = DIRECTION_FORWARD
        if self._device_device.reverse_enable:
            self._attr_current_direction_attr_current_direction = DIRECTION_REVERSE
        if self._device_device.speed is not None:
            self._attr_percentage_attr_percentage = ranged_value_to_percentage(
                SPEED_RANGE, self._device_device.speed
            )
        else:
            self._attr_percentage_attr_percentage = None
        auto = self._device_device.fan_mode == OffOnAuto.AUTO
        self._attr_preset_mode_attr_preset_mode = PRESET_MODE_AUTO if auto else None
        super()._async_update_attrs()
 
    async def async_set_percentage(self, percentage: int) -> None:
        """Set the speed of the fan, as a percentage."""
        device = self._device_device
        if device.fan_mode != OffOnAuto.ON:
            device.fan_mode = OffOnAuto.ON
        device.speed = math.ceil(percentage_to_ranged_value(SPEED_RANGE, percentage))
 
    async def async_turn_on(
        self,
        percentage: int | None = None,
        preset_mode: str | None = None,
        **kwargs: Any,
    ) -> None:
        """Turn the fan on with a percentage or preset mode."""
        if preset_mode is not None:
            await self.async_set_preset_modeasync_set_preset_modeasync_set_preset_mode(preset_mode)
            return
        if percentage is None:
            self._device_device.fan_mode = OffOnAuto.ON
            return
        await self.async_set_percentageasync_set_percentageasync_set_percentage(percentage)
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the fan off."""
        self._device_device.fan_mode = OffOnAuto.OFF
 
    async def async_set_preset_mode(self, preset_mode: str) -> None:
        """Set the preset mode of the fan."""
        self._device_device.fan_mode = OffOnAuto.AUTO
 
    async def async_set_direction(self, direction: str) -> None:
        """Set the direction of the fan."""
        self._device_device.reverse_enable = direction == DIRECTION_REVERSE