Luke
GitHub
parent
9cace8e4bd
commit
3474f46b09
10 changed files with 95 additions and 170 deletions
|
|
@ -1,23 +1,27 @@
|
|||
"""Support for Roborock switch."""
|
||||
from __future__ import annotations
|
||||
|
||||
import asyncio
|
||||
from collections.abc import Callable, Coroutine
|
||||
from dataclasses import dataclass
|
||||
import logging
|
||||
from typing import Any
|
||||
|
||||
from roborock.exceptions import RoborockException
|
||||
from roborock.roborock_typing import RoborockCommand
|
||||
from roborock.api import AttributeCache
|
||||
from roborock.command_cache import CacheableAttribute
|
||||
from roborock.local_api import RoborockLocalClient
|
||||
|
||||
from homeassistant.components.switch import SwitchEntity, SwitchEntityDescription
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import EntityCategory
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers.entity import DeviceInfo
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.util import slugify
|
||||
|
||||
from .const import DOMAIN
|
||||
from .coordinator import RoborockDataUpdateCoordinator
|
||||
from .device import RoborockCoordinatedEntity, RoborockEntity
|
||||
from .device import RoborockEntity
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
|
|
@ -27,23 +31,11 @@ class RoborockSwitchDescriptionMixin:
|
|||
"""Define an entity description mixin for switch entities."""
|
||||
|
||||
# Gets the status of the switch
|
||||
get_value: Callable[[RoborockEntity], Coroutine[Any, Any, dict]]
|
||||
# Evaluate the result of get_value to determine a bool
|
||||
evaluate_value: Callable[[dict], bool]
|
||||
cache_key: CacheableAttribute
|
||||
# Sets the status of the switch
|
||||
set_command: Callable[[RoborockEntity, bool], Coroutine[Any, Any, dict]]
|
||||
# Check support of this feature
|
||||
check_support: Callable[[RoborockDataUpdateCoordinator], Coroutine[Any, Any, dict]]
|
||||
|
||||
|
||||
@dataclass
|
||||
class RoborockCoordinatedSwitchDescriptionMixIn:
|
||||
"""Define an entity description mixin for switch entities."""
|
||||
|
||||
get_value: Callable[[RoborockCoordinatedEntity], bool]
|
||||
set_command: Callable[[RoborockCoordinatedEntity, bool], Coroutine[Any, Any, dict]]
|
||||
# Check support of this feature
|
||||
check_support: Callable[[RoborockDataUpdateCoordinator], dict]
|
||||
update_value: Callable[[AttributeCache, bool], Coroutine[Any, Any, dict]]
|
||||
# Attribute from cache
|
||||
attribute: str
|
||||
|
||||
|
||||
@dataclass
|
||||
|
|
@ -53,59 +45,42 @@ class RoborockSwitchDescription(
|
|||
"""Class to describe an Roborock switch entity."""
|
||||
|
||||
|
||||
@dataclass
|
||||
class RoborockCoordinatedSwitchDescription(
|
||||
SwitchEntityDescription, RoborockCoordinatedSwitchDescriptionMixIn
|
||||
):
|
||||
"""Class to describe an Roborock switch entity that needs a coordinator."""
|
||||
|
||||
|
||||
SWITCH_DESCRIPTIONS: list[RoborockSwitchDescription] = [
|
||||
RoborockSwitchDescription(
|
||||
set_command=lambda entity, value: entity.send(
|
||||
RoborockCommand.SET_CHILD_LOCK_STATUS, {"lock_status": 1 if value else 0}
|
||||
cache_key=CacheableAttribute.child_lock_status,
|
||||
update_value=lambda cache, value: cache.update_value(
|
||||
{"lock_status": 1 if value else 0}
|
||||
),
|
||||
get_value=lambda data: data.send(RoborockCommand.GET_CHILD_LOCK_STATUS),
|
||||
check_support=lambda data: data.api.send_command(
|
||||
RoborockCommand.GET_CHILD_LOCK_STATUS
|
||||
),
|
||||
evaluate_value=lambda data: data["lock_status"] == 1,
|
||||
attribute="lock_status",
|
||||
key="child_lock",
|
||||
translation_key="child_lock",
|
||||
icon="mdi:account-lock",
|
||||
entity_category=EntityCategory.CONFIG,
|
||||
),
|
||||
RoborockSwitchDescription(
|
||||
set_command=lambda entity, value: entity.send(
|
||||
RoborockCommand.SET_FLOW_LED_STATUS, {"status": 1 if value else 0}
|
||||
cache_key=CacheableAttribute.flow_led_status,
|
||||
update_value=lambda cache, value: cache.update_value(
|
||||
{"status": 1 if value else 0}
|
||||
),
|
||||
get_value=lambda data: data.send(RoborockCommand.GET_FLOW_LED_STATUS),
|
||||
check_support=lambda data: data.api.send_command(
|
||||
RoborockCommand.GET_FLOW_LED_STATUS
|
||||
),
|
||||
evaluate_value=lambda data: data["status"] == 1,
|
||||
attribute="status",
|
||||
key="status_indicator",
|
||||
translation_key="status_indicator",
|
||||
icon="mdi:alarm-light-outline",
|
||||
entity_category=EntityCategory.CONFIG,
|
||||
),
|
||||
]
|
||||
|
||||
COORDINATED_SWITCH_DESCRIPTION = [
|
||||
RoborockCoordinatedSwitchDescription(
|
||||
set_command=lambda entity, value: entity.send(
|
||||
RoborockCommand.SET_DND_TIMER,
|
||||
RoborockSwitchDescription(
|
||||
cache_key=CacheableAttribute.dnd_timer,
|
||||
update_value=lambda cache, value: cache.update_value(
|
||||
[
|
||||
entity.coordinator.roborock_device_info.props.dnd_timer.start_hour,
|
||||
entity.coordinator.roborock_device_info.props.dnd_timer.start_minute,
|
||||
entity.coordinator.roborock_device_info.props.dnd_timer.end_hour,
|
||||
entity.coordinator.roborock_device_info.props.dnd_timer.end_minute,
|
||||
],
|
||||
cache.value.get("start_hour"),
|
||||
cache.value.get("start_minute"),
|
||||
cache.value.get("end_hour"),
|
||||
cache.value.get("end_minute"),
|
||||
]
|
||||
)
|
||||
if value
|
||||
else entity.send(RoborockCommand.CLOSE_DND_TIMER),
|
||||
check_support=lambda data: data.roborock_device_info.props.dnd_timer,
|
||||
get_value=lambda data: data.coordinator.roborock_device_info.props.dnd_timer.enabled,
|
||||
else cache.close_value(),
|
||||
attribute="enabled",
|
||||
key="dnd_switch",
|
||||
translation_key="dnd_switch",
|
||||
icon="mdi:bell-cancel",
|
||||
|
|
@ -120,114 +95,74 @@ async def async_setup_entry(
|
|||
async_add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Set up Roborock switch platform."""
|
||||
|
||||
coordinators: dict[str, RoborockDataUpdateCoordinator] = hass.data[DOMAIN][
|
||||
config_entry.entry_id
|
||||
]
|
||||
possible_entities: list[
|
||||
tuple[str, RoborockDataUpdateCoordinator, RoborockSwitchDescription]
|
||||
tuple[RoborockDataUpdateCoordinator, RoborockSwitchDescription]
|
||||
] = [
|
||||
(device_id, coordinator, description)
|
||||
for device_id, coordinator in coordinators.items()
|
||||
(coordinator, description)
|
||||
for coordinator in coordinators.values()
|
||||
for description in SWITCH_DESCRIPTIONS
|
||||
]
|
||||
# We need to check if this function is supported by the device.
|
||||
results = await asyncio.gather(
|
||||
*(
|
||||
description.check_support(coordinator)
|
||||
for _, coordinator, description in possible_entities
|
||||
coordinator.api.cache.get(description.cache_key).async_value()
|
||||
for coordinator, description in possible_entities
|
||||
),
|
||||
return_exceptions=True,
|
||||
)
|
||||
valid_entities: list[RoborockNonCoordinatedSwitchEntity] = []
|
||||
for posible_entity, result in zip(possible_entities, results):
|
||||
if isinstance(result, Exception):
|
||||
if not isinstance(result, RoborockException):
|
||||
raise result
|
||||
valid_entities: list[RoborockSwitch] = []
|
||||
for (coordinator, description), result in zip(possible_entities, results):
|
||||
if result is None or isinstance(result, Exception):
|
||||
_LOGGER.debug("Not adding entity because of %s", result)
|
||||
else:
|
||||
valid_entities.append(
|
||||
RoborockNonCoordinatedSwitchEntity(
|
||||
f"{posible_entity[2].key}_{slugify(posible_entity[0])}",
|
||||
posible_entity[1],
|
||||
posible_entity[2],
|
||||
result,
|
||||
RoborockSwitch(
|
||||
f"{description.key}_{slugify(coordinator.roborock_device_info.device.duid)}",
|
||||
coordinator.device_info,
|
||||
description,
|
||||
coordinator.api,
|
||||
)
|
||||
)
|
||||
async_add_entities(
|
||||
valid_entities,
|
||||
True,
|
||||
)
|
||||
async_add_entities(
|
||||
(
|
||||
RoborockCoordinatedSwitchEntity(
|
||||
f"{description.key}_{slugify(device_id)}",
|
||||
coordinator,
|
||||
description,
|
||||
)
|
||||
for device_id, coordinator in coordinators.items()
|
||||
for description in COORDINATED_SWITCH_DESCRIPTION
|
||||
if description.check_support(coordinator) is not None
|
||||
)
|
||||
)
|
||||
async_add_entities(valid_entities)
|
||||
|
||||
|
||||
class RoborockNonCoordinatedSwitchEntity(RoborockEntity, SwitchEntity):
|
||||
"""A class to let you turn functionality on Roborock devices on and off that does not need a coordinator."""
|
||||
class RoborockSwitch(RoborockEntity, SwitchEntity):
|
||||
"""A class to let you turn functionality on Roborock devices on and off that does need a coordinator."""
|
||||
|
||||
entity_description: RoborockSwitchDescription
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
unique_id: str,
|
||||
coordinator: RoborockDataUpdateCoordinator,
|
||||
entity_description: RoborockSwitchDescription,
|
||||
initial_value: bool,
|
||||
device_info: DeviceInfo,
|
||||
description: RoborockSwitchDescription,
|
||||
api: RoborockLocalClient,
|
||||
) -> None:
|
||||
"""Create a switch entity."""
|
||||
self.entity_description = entity_description
|
||||
super().__init__(unique_id, coordinator.device_info, coordinator.api)
|
||||
self._attr_is_on = initial_value
|
||||
"""Initialize the entity."""
|
||||
super().__init__(unique_id, device_info, api)
|
||||
self.entity_description = description
|
||||
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Turn off the switch."""
|
||||
await self.entity_description.set_command(self, False)
|
||||
|
||||
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||
"""Turn on the switch."""
|
||||
await self.entity_description.set_command(self, True)
|
||||
|
||||
async def async_update(self) -> None:
|
||||
"""Update switch."""
|
||||
self._attr_is_on = self.entity_description.evaluate_value(
|
||||
await self.entity_description.get_value(self)
|
||||
await self.entity_description.update_value(
|
||||
self.get_cache(self.entity_description.cache_key), False
|
||||
)
|
||||
|
||||
|
||||
class RoborockCoordinatedSwitchEntity(RoborockCoordinatedEntity, SwitchEntity):
|
||||
"""A class to let you turn functionality on Roborock devices on and off that does need a coordinator."""
|
||||
|
||||
entity_description: RoborockCoordinatedSwitchDescription
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
unique_id: str,
|
||||
coordinator: RoborockDataUpdateCoordinator,
|
||||
entity_description: RoborockCoordinatedSwitchDescription,
|
||||
) -> None:
|
||||
"""Create a switch entity."""
|
||||
self.entity_description = entity_description
|
||||
super().__init__(unique_id, coordinator)
|
||||
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Turn off the switch."""
|
||||
await self.entity_description.set_command(self, False)
|
||||
|
||||
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||
"""Turn on the switch."""
|
||||
await self.entity_description.set_command(self, True)
|
||||
await self.entity_description.update_value(
|
||||
self.get_cache(self.entity_description.cache_key), True
|
||||
)
|
||||
|
||||
@property
|
||||
def is_on(self) -> bool | None:
|
||||
"""Use the coordinator to determine if the switch is on."""
|
||||
return self.entity_description.get_value(self)
|
||||
"""Return True if entity is on."""
|
||||
return (
|
||||
self.get_cache(self.entity_description.cache_key).value.get(
|
||||
self.entity_description.attribute
|
||||
)
|
||||
== 1
|
||||
)
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue