Add support for fan groups (#57941)
* Add support for fan groups * dry * dry * fix refactor error * tweaks * wip * tweaks * tweaks * fix * fixes * coverage * tweaks
This commit is contained in:
J. Nick Koston
GitHub
parent
f594bc353b
commit
def7c80e71
5 changed files with 836 additions and 3 deletions
284
homeassistant/components/group/fan.py
Normal file
284
homeassistant/components/group/fan.py
Normal file
|
|
@ -0,0 +1,284 @@
|
|||
"""This platform allows several fans to be grouped into one fan."""
|
||||
from __future__ import annotations
|
||||
|
||||
from functools import reduce
|
||||
import logging
|
||||
from operator import ior
|
||||
from typing import Any
|
||||
|
||||
import voluptuous as vol
|
||||
|
||||
from homeassistant.components.fan import (
|
||||
ATTR_DIRECTION,
|
||||
ATTR_OSCILLATING,
|
||||
ATTR_PERCENTAGE,
|
||||
ATTR_PERCENTAGE_STEP,
|
||||
DOMAIN,
|
||||
PLATFORM_SCHEMA,
|
||||
SERVICE_OSCILLATE,
|
||||
SERVICE_SET_DIRECTION,
|
||||
SERVICE_SET_PERCENTAGE,
|
||||
SERVICE_TURN_OFF,
|
||||
SERVICE_TURN_ON,
|
||||
SUPPORT_DIRECTION,
|
||||
SUPPORT_OSCILLATE,
|
||||
SUPPORT_SET_SPEED,
|
||||
FanEntity,
|
||||
)
|
||||
from homeassistant.const import (
|
||||
ATTR_ASSUMED_STATE,
|
||||
ATTR_ENTITY_ID,
|
||||
ATTR_SUPPORTED_FEATURES,
|
||||
CONF_ENTITIES,
|
||||
CONF_NAME,
|
||||
CONF_UNIQUE_ID,
|
||||
STATE_ON,
|
||||
)
|
||||
from homeassistant.core import CoreState, Event, HomeAssistant, State
|
||||
import homeassistant.helpers.config_validation as cv
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.event import async_track_state_change_event
|
||||
from homeassistant.helpers.typing import ConfigType
|
||||
|
||||
from . import GroupEntity
|
||||
from .util import (
|
||||
attribute_equal,
|
||||
most_frequent_attribute,
|
||||
reduce_attribute,
|
||||
states_equal,
|
||||
)
|
||||
|
||||
SUPPORTED_FLAGS = {SUPPORT_SET_SPEED, SUPPORT_DIRECTION, SUPPORT_OSCILLATE}
|
||||
|
||||
DEFAULT_NAME = "Fan Group"
|
||||
|
||||
|
||||
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
||||
{
|
||||
vol.Required(CONF_ENTITIES): cv.entities_domain(DOMAIN),
|
||||
vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
|
||||
vol.Optional(CONF_UNIQUE_ID): cv.string,
|
||||
}
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
||||
async def async_setup_platform(
|
||||
hass: HomeAssistant,
|
||||
config: ConfigType,
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
discovery_info: dict[str, Any] | None = None,
|
||||
) -> None:
|
||||
"""Set up the Group Cover platform."""
|
||||
async_add_entities(
|
||||
[FanGroup(config.get(CONF_UNIQUE_ID), config[CONF_NAME], config[CONF_ENTITIES])]
|
||||
)
|
||||
|
||||
|
||||
class FanGroup(GroupEntity, FanEntity):
|
||||
"""Representation of a FanGroup."""
|
||||
|
||||
_attr_assumed_state: bool = True
|
||||
|
||||
def __init__(self, unique_id: str | None, name: str, entities: list[str]) -> None:
|
||||
"""Initialize a FanGroup entity."""
|
||||
self._entities = entities
|
||||
self._fans: dict[int, set[str]] = {flag: set() for flag in SUPPORTED_FLAGS}
|
||||
self._percentage = None
|
||||
self._oscillating = None
|
||||
self._direction = None
|
||||
self._supported_features = 0
|
||||
self._speed_count = 100
|
||||
self._is_on = False
|
||||
self._attr_name = name
|
||||
self._attr_extra_state_attributes = {ATTR_ENTITY_ID: entities}
|
||||
self._attr_unique_id = unique_id
|
||||
|
||||
@property
|
||||
def supported_features(self) -> int:
|
||||
"""Flag supported features."""
|
||||
return self._supported_features
|
||||
|
||||
@property
|
||||
def speed_count(self) -> int:
|
||||
"""Return the number of speeds the fan supports."""
|
||||
return self._speed_count
|
||||
|
||||
@property
|
||||
def is_on(self) -> bool:
|
||||
"""Return true if the entity is on."""
|
||||
return self._is_on
|
||||
|
||||
@property
|
||||
def percentage(self) -> int | None:
|
||||
"""Return the current speed as a percentage."""
|
||||
return self._percentage
|
||||
|
||||
@property
|
||||
def current_direction(self) -> str | None:
|
||||
"""Return the current direction of the fan."""
|
||||
return self._direction
|
||||
|
||||
@property
|
||||
def oscillating(self) -> bool | None:
|
||||
"""Return whether or not the fan is currently oscillating."""
|
||||
return self._oscillating
|
||||
|
||||
async def _update_supported_features_event(self, event: Event) -> None:
|
||||
self.async_set_context(event.context)
|
||||
if (entity := event.data.get("entity_id")) is not None:
|
||||
await self.async_update_supported_features(
|
||||
entity, event.data.get("new_state")
|
||||
)
|
||||
|
||||
async def async_update_supported_features(
|
||||
self,
|
||||
entity_id: str,
|
||||
new_state: State | None,
|
||||
update_state: bool = True,
|
||||
) -> None:
|
||||
"""Update dictionaries with supported features."""
|
||||
if not new_state:
|
||||
for values in self._fans.values():
|
||||
values.discard(entity_id)
|
||||
else:
|
||||
features = new_state.attributes.get(ATTR_SUPPORTED_FEATURES, 0)
|
||||
for feature in SUPPORTED_FLAGS:
|
||||
if features & feature:
|
||||
self._fans[feature].add(entity_id)
|
||||
else:
|
||||
self._fans[feature].discard(entity_id)
|
||||
|
||||
if update_state:
|
||||
await self.async_defer_or_update_ha_state()
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Register listeners."""
|
||||
for entity_id in self._entities:
|
||||
if (new_state := self.hass.states.get(entity_id)) is None:
|
||||
continue
|
||||
await self.async_update_supported_features(
|
||||
entity_id, new_state, update_state=False
|
||||
)
|
||||
self.async_on_remove(
|
||||
async_track_state_change_event(
|
||||
self.hass, self._entities, self._update_supported_features_event
|
||||
)
|
||||
)
|
||||
|
||||
if self.hass.state == CoreState.running:
|
||||
await self.async_update()
|
||||
return
|
||||
await super().async_added_to_hass()
|
||||
|
||||
async def async_set_percentage(self, percentage: int) -> None:
|
||||
"""Set the speed of the fan, as a percentage."""
|
||||
if percentage == 0:
|
||||
await self.async_turn_off()
|
||||
await self._async_call_supported_entities(
|
||||
SERVICE_SET_PERCENTAGE, SUPPORT_SET_SPEED, {ATTR_PERCENTAGE: percentage}
|
||||
)
|
||||
|
||||
async def async_oscillate(self, oscillating: bool) -> None:
|
||||
"""Oscillate the fan."""
|
||||
await self._async_call_supported_entities(
|
||||
SERVICE_OSCILLATE, SUPPORT_OSCILLATE, {ATTR_OSCILLATING: oscillating}
|
||||
)
|
||||
|
||||
async def async_set_direction(self, direction: str) -> None:
|
||||
"""Set the direction of the fan."""
|
||||
await self._async_call_supported_entities(
|
||||
SERVICE_SET_DIRECTION, SUPPORT_DIRECTION, {ATTR_DIRECTION: direction}
|
||||
)
|
||||
|
||||
async def async_turn_on(
|
||||
self,
|
||||
speed: str | None = None,
|
||||
percentage: int | None = None,
|
||||
preset_mode: str | None = None,
|
||||
**kwargs: Any,
|
||||
) -> None:
|
||||
"""Turn on the fan."""
|
||||
if percentage is not None:
|
||||
await self.async_set_percentage(percentage)
|
||||
return
|
||||
await self._async_call_all_entities(SERVICE_TURN_ON)
|
||||
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Turn the fans off."""
|
||||
await self._async_call_all_entities(SERVICE_TURN_OFF)
|
||||
|
||||
async def _async_call_supported_entities(
|
||||
self, service: str, support_flag: int, data: dict[str, Any]
|
||||
) -> None:
|
||||
"""Call a service with all entities."""
|
||||
await self.hass.services.async_call(
|
||||
DOMAIN,
|
||||
service,
|
||||
{**data, ATTR_ENTITY_ID: self._fans[support_flag]},
|
||||
blocking=True,
|
||||
context=self._context,
|
||||
)
|
||||
|
||||
async def _async_call_all_entities(self, service: str) -> None:
|
||||
"""Call a service with all entities."""
|
||||
await self.hass.services.async_call(
|
||||
DOMAIN,
|
||||
service,
|
||||
{ATTR_ENTITY_ID: self._entities},
|
||||
blocking=True,
|
||||
context=self._context,
|
||||
)
|
||||
|
||||
def _async_states_by_support_flag(self, flag: int) -> list[State]:
|
||||
"""Return all the entity states for a supported flag."""
|
||||
states: list[State] = list(
|
||||
filter(None, [self.hass.states.get(x) for x in self._fans[flag]])
|
||||
)
|
||||
return states
|
||||
|
||||
def _set_attr_most_frequent(self, attr: str, flag: int, entity_attr: str) -> None:
|
||||
"""Set an attribute based on most frequent supported entities attributes."""
|
||||
states = self._async_states_by_support_flag(flag)
|
||||
setattr(self, attr, most_frequent_attribute(states, entity_attr))
|
||||
self._attr_assumed_state |= not attribute_equal(states, entity_attr)
|
||||
|
||||
async def async_update(self) -> None:
|
||||
"""Update state and attributes."""
|
||||
self._attr_assumed_state = False
|
||||
|
||||
on_states: list[State] = list(
|
||||
filter(None, [self.hass.states.get(x) for x in self._entities])
|
||||
)
|
||||
self._is_on = any(state.state == STATE_ON for state in on_states)
|
||||
self._attr_assumed_state |= not states_equal(on_states)
|
||||
|
||||
percentage_states = self._async_states_by_support_flag(SUPPORT_SET_SPEED)
|
||||
self._percentage = reduce_attribute(percentage_states, ATTR_PERCENTAGE)
|
||||
self._attr_assumed_state |= not attribute_equal(
|
||||
percentage_states, ATTR_PERCENTAGE
|
||||
)
|
||||
if (
|
||||
percentage_states
|
||||
and percentage_states[0].attributes.get(ATTR_PERCENTAGE_STEP)
|
||||
and attribute_equal(percentage_states, ATTR_PERCENTAGE_STEP)
|
||||
):
|
||||
self._speed_count = (
|
||||
round(100 / percentage_states[0].attributes[ATTR_PERCENTAGE_STEP])
|
||||
or 100
|
||||
)
|
||||
else:
|
||||
self._speed_count = 100
|
||||
|
||||
self._set_attr_most_frequent(
|
||||
"_oscillating", SUPPORT_OSCILLATE, ATTR_OSCILLATING
|
||||
)
|
||||
self._set_attr_most_frequent("_direction", SUPPORT_DIRECTION, ATTR_DIRECTION)
|
||||
|
||||
self._supported_features = reduce(
|
||||
ior, [feature for feature in SUPPORTED_FLAGS if self._fans[feature]], 0
|
||||
)
|
||||
self._attr_assumed_state |= any(
|
||||
state.attributes.get(ATTR_ASSUMED_STATE) for state in on_states
|
||||
)
|
||||
Loading…
Add table
Add a link
Reference in a new issue