118 lines
3.7 KiB
Python
118 lines
3.7 KiB
Python
"""Support for Litter-Robot "Vacuum"."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from datetime import time
|
|
from typing import Any
|
|
|
|
from pylitterbot import LitterRobot
|
|
from pylitterbot.enums import LitterBoxStatus
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.vacuum import (
|
|
StateVacuumEntity,
|
|
StateVacuumEntityDescription,
|
|
VacuumActivity,
|
|
VacuumEntityFeature,
|
|
)
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.helpers import config_validation as cv, entity_platform
|
|
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from .coordinator import LitterRobotConfigEntry
|
|
from .entity import LitterRobotEntity
|
|
|
|
SERVICE_SET_SLEEP_MODE = "set_sleep_mode"
|
|
|
|
LITTER_BOX_STATUS_STATE_MAP = {
|
|
LitterBoxStatus.CLEAN_CYCLE: VacuumActivity.CLEANING,
|
|
LitterBoxStatus.EMPTY_CYCLE: VacuumActivity.CLEANING,
|
|
LitterBoxStatus.CLEAN_CYCLE_COMPLETE: VacuumActivity.DOCKED,
|
|
LitterBoxStatus.CAT_DETECTED: VacuumActivity.DOCKED,
|
|
LitterBoxStatus.CAT_SENSOR_TIMING: VacuumActivity.DOCKED,
|
|
LitterBoxStatus.DRAWER_FULL_1: VacuumActivity.DOCKED,
|
|
LitterBoxStatus.DRAWER_FULL_2: VacuumActivity.DOCKED,
|
|
LitterBoxStatus.READY: VacuumActivity.DOCKED,
|
|
LitterBoxStatus.CAT_SENSOR_INTERRUPTED: VacuumActivity.PAUSED,
|
|
LitterBoxStatus.OFF: VacuumActivity.DOCKED,
|
|
}
|
|
|
|
LITTER_BOX_ENTITY = StateVacuumEntityDescription(
|
|
key="litter_box", translation_key="litter_box"
|
|
)
|
|
|
|
|
|
async def async_setup_entry(
|
|
hass: HomeAssistant,
|
|
entry: LitterRobotConfigEntry,
|
|
async_add_entities: AddEntitiesCallback,
|
|
) -> None:
|
|
"""Set up Litter-Robot cleaner using config entry."""
|
|
coordinator = entry.runtime_data
|
|
async_add_entities(
|
|
LitterRobotCleaner(
|
|
robot=robot, coordinator=coordinator, description=LITTER_BOX_ENTITY
|
|
)
|
|
for robot in coordinator.litter_robots()
|
|
)
|
|
|
|
platform = entity_platform.async_get_current_platform()
|
|
platform.async_register_entity_service(
|
|
SERVICE_SET_SLEEP_MODE,
|
|
{
|
|
vol.Required("enabled"): cv.boolean,
|
|
vol.Optional("start_time"): cv.time,
|
|
},
|
|
"async_set_sleep_mode",
|
|
)
|
|
|
|
|
|
class LitterRobotCleaner(LitterRobotEntity[LitterRobot], StateVacuumEntity):
|
|
"""Litter-Robot "Vacuum" Cleaner."""
|
|
|
|
_attr_supported_features = (
|
|
VacuumEntityFeature.START | VacuumEntityFeature.STATE | VacuumEntityFeature.STOP
|
|
)
|
|
|
|
@property
|
|
def activity(self) -> VacuumActivity:
|
|
"""Return the state of the cleaner."""
|
|
return LITTER_BOX_STATUS_STATE_MAP.get(self.robot.status, VacuumActivity.ERROR)
|
|
|
|
async def async_start(self) -> None:
|
|
"""Start a clean cycle."""
|
|
await self.robot.set_power_status(True)
|
|
await self.robot.start_cleaning()
|
|
|
|
async def async_stop(self, **kwargs: Any) -> None:
|
|
"""Stop the vacuum cleaner."""
|
|
await self.robot.set_power_status(False)
|
|
|
|
async def async_set_sleep_mode(
|
|
self, enabled: bool, start_time: str | None = None
|
|
) -> None:
|
|
"""Set the sleep mode."""
|
|
await self.robot.set_sleep_mode(
|
|
enabled, self.parse_time_at_default_timezone(start_time)
|
|
)
|
|
|
|
@staticmethod
|
|
def parse_time_at_default_timezone(time_str: str | None) -> time | None:
|
|
"""Parse a time string and add default timezone."""
|
|
if time_str is None:
|
|
return None
|
|
|
|
if (parsed_time := dt_util.parse_time(time_str)) is None:
|
|
return None
|
|
|
|
return (
|
|
dt_util.start_of_local_day()
|
|
.replace(
|
|
hour=parsed_time.hour,
|
|
minute=parsed_time.minute,
|
|
second=parsed_time.second,
|
|
)
|
|
.timetz()
|
|
)
|