141 lines
4.6 KiB
Python
141 lines
4.6 KiB
Python
"""Support for Litter-Robot "Vacuum"."""
|
|
from pylitterbot import Robot
|
|
|
|
from homeassistant.components.vacuum import (
|
|
STATE_CLEANING,
|
|
STATE_DOCKED,
|
|
STATE_ERROR,
|
|
SUPPORT_SEND_COMMAND,
|
|
SUPPORT_START,
|
|
SUPPORT_STATE,
|
|
SUPPORT_STATUS,
|
|
SUPPORT_TURN_OFF,
|
|
SUPPORT_TURN_ON,
|
|
VacuumEntity,
|
|
)
|
|
from homeassistant.const import STATE_OFF
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from .const import DOMAIN
|
|
from .hub import LitterRobotEntity
|
|
|
|
SUPPORT_LITTERROBOT = (
|
|
SUPPORT_SEND_COMMAND
|
|
| SUPPORT_START
|
|
| SUPPORT_STATE
|
|
| SUPPORT_STATUS
|
|
| SUPPORT_TURN_OFF
|
|
| SUPPORT_TURN_ON
|
|
)
|
|
TYPE_LITTER_BOX = "Litter Box"
|
|
|
|
|
|
async def async_setup_entry(hass, config_entry, async_add_entities):
|
|
"""Set up Litter-Robot cleaner using config entry."""
|
|
hub = hass.data[DOMAIN][config_entry.entry_id]
|
|
|
|
entities = []
|
|
for robot in hub.account.robots:
|
|
entities.append(LitterRobotCleaner(robot, TYPE_LITTER_BOX, hub))
|
|
|
|
if entities:
|
|
async_add_entities(entities, True)
|
|
|
|
|
|
class LitterRobotCleaner(LitterRobotEntity, VacuumEntity):
|
|
"""Litter-Robot "Vacuum" Cleaner."""
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Flag cleaner robot features that are supported."""
|
|
return SUPPORT_LITTERROBOT
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the cleaner."""
|
|
switcher = {
|
|
Robot.UnitStatus.CCP: STATE_CLEANING,
|
|
Robot.UnitStatus.EC: STATE_CLEANING,
|
|
Robot.UnitStatus.CCC: STATE_DOCKED,
|
|
Robot.UnitStatus.CST: STATE_DOCKED,
|
|
Robot.UnitStatus.DF1: STATE_DOCKED,
|
|
Robot.UnitStatus.DF2: STATE_DOCKED,
|
|
Robot.UnitStatus.RDY: STATE_DOCKED,
|
|
Robot.UnitStatus.OFF: STATE_OFF,
|
|
}
|
|
|
|
return switcher.get(self.robot.unit_status, STATE_ERROR)
|
|
|
|
@property
|
|
def error(self):
|
|
"""Return the error associated with the current state, if any."""
|
|
return self.robot.unit_status.value
|
|
|
|
@property
|
|
def status(self):
|
|
"""Return the status of the cleaner."""
|
|
return f"{self.robot.unit_status.value}{' (Sleeping)' if self.robot.is_sleeping else ''}"
|
|
|
|
async def async_turn_on(self, **kwargs):
|
|
"""Turn the cleaner on, starting a clean cycle."""
|
|
await self.perform_action_and_refresh(self.robot.set_power_status, True)
|
|
|
|
async def async_turn_off(self, **kwargs):
|
|
"""Turn the unit off, stopping any cleaning in progress as is."""
|
|
await self.perform_action_and_refresh(self.robot.set_power_status, False)
|
|
|
|
async def async_start(self):
|
|
"""Start a clean cycle."""
|
|
await self.perform_action_and_refresh(self.robot.start_cleaning)
|
|
|
|
async def async_send_command(self, command, params=None, **kwargs):
|
|
"""Send command.
|
|
|
|
Available commands:
|
|
- reset_waste_drawer
|
|
* params: none
|
|
- set_sleep_mode
|
|
* params:
|
|
- enabled: bool
|
|
- sleep_time: str (optional)
|
|
|
|
"""
|
|
if command == "reset_waste_drawer":
|
|
# Normally we need to request a refresh of data after a command is sent.
|
|
# However, the API for resetting the waste drawer returns a refreshed
|
|
# data set for the robot. Thus, we only need to tell hass to update the
|
|
# state of devices associated with this robot.
|
|
await self.robot.reset_waste_drawer()
|
|
self.hub.coordinator.async_set_updated_data(True)
|
|
elif command == "set_sleep_mode":
|
|
await self.perform_action_and_refresh(
|
|
self.robot.set_sleep_mode,
|
|
params.get("enabled"),
|
|
self.parse_time_at_default_timezone(params.get("sleep_time")),
|
|
)
|
|
else:
|
|
raise NotImplementedError()
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return device specific state attributes."""
|
|
[sleep_mode_start_time, sleep_mode_end_time] = [None, None]
|
|
|
|
if self.robot.sleep_mode_active:
|
|
sleep_mode_start_time = dt_util.as_local(
|
|
self.robot.sleep_mode_start_time
|
|
).strftime("%H:%M:00")
|
|
sleep_mode_end_time = dt_util.as_local(
|
|
self.robot.sleep_mode_end_time
|
|
).strftime("%H:%M:00")
|
|
|
|
return {
|
|
"clean_cycle_wait_time_minutes": self.robot.clean_cycle_wait_time_minutes,
|
|
"is_sleeping": self.robot.is_sleeping,
|
|
"sleep_mode_start_time": sleep_mode_start_time,
|
|
"sleep_mode_end_time": sleep_mode_end_time,
|
|
"power_status": self.robot.power_status,
|
|
"unit_status_code": self.robot.unit_status.name,
|
|
"last_seen": self.robot.last_seen,
|
|
}
|