vacuum.py

Go to the documentation of this file.

"""Demo platform for the vacuum component."""
 
from __future__ import annotations
 
from datetime import datetime
from typing import Any
 
from homeassistant.components.vacuum import (
    ATTR_CLEANED_AREA,
    STATE_CLEANING,
    STATE_DOCKED,
    STATE_IDLE,
    STATE_PAUSED,
    STATE_RETURNING,
    StateVacuumEntity,
    VacuumEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers import event
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
SUPPORT_MINIMAL_SERVICES = VacuumEntityFeature.TURN_ON | VacuumEntityFeature.TURN_OFF
 
SUPPORT_BASIC_SERVICES = (
    VacuumEntityFeature.STATE
    | VacuumEntityFeature.START
    | VacuumEntityFeature.STOP
    | VacuumEntityFeature.BATTERY
)
 
SUPPORT_MOST_SERVICES = (
    VacuumEntityFeature.STATE
    | VacuumEntityFeature.START
    | VacuumEntityFeature.STOP
    | VacuumEntityFeature.PAUSE
    | VacuumEntityFeature.RETURN_HOME
    | VacuumEntityFeature.BATTERY
    | VacuumEntityFeature.FAN_SPEED
)
 
SUPPORT_ALL_SERVICES = (
    VacuumEntityFeature.STATE
    | VacuumEntityFeature.START
    | VacuumEntityFeature.STOP
    | VacuumEntityFeature.PAUSE
    | VacuumEntityFeature.STOP
    | VacuumEntityFeature.RETURN_HOME
    | VacuumEntityFeature.FAN_SPEED
    | VacuumEntityFeature.SEND_COMMAND
    | VacuumEntityFeature.LOCATE
    | VacuumEntityFeature.STATUS
    | VacuumEntityFeature.BATTERY
    | VacuumEntityFeature.LOCATE
    | VacuumEntityFeature.MAP
    | VacuumEntityFeature.CLEAN_SPOT
)
 
FAN_SPEEDS = ["min", "medium", "high", "max"]
DEMO_VACUUM_COMPLETE = "0_Ground_floor"
DEMO_VACUUM_MOST = "1_First_floor"
DEMO_VACUUM_BASIC = "2_Second_floor"
DEMO_VACUUM_MINIMAL = "3_Third_floor"
DEMO_VACUUM_NONE = "4_Fourth_floor"
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Demo config entry."""
    async_add_entities(
        [
            StateDemoVacuum(DEMO_VACUUM_COMPLETE, SUPPORT_ALL_SERVICES),
            StateDemoVacuum(DEMO_VACUUM_MOST, SUPPORT_MOST_SERVICES),
            StateDemoVacuum(DEMO_VACUUM_BASIC, SUPPORT_BASIC_SERVICES),
            StateDemoVacuum(DEMO_VACUUM_MINIMAL, SUPPORT_MINIMAL_SERVICES),
            StateDemoVacuum(DEMO_VACUUM_NONE, VacuumEntityFeature(0)),
        ]
    )
 
 
class StateDemoVacuum(StateVacuumEntity):
    """Representation of a demo vacuum supporting states."""
 
    _attr_should_poll = False
    _attr_translation_key = "model_s"
 
    def __init__(self, name: str, supported_features: VacuumEntityFeature) -> None:
        """Initialize the vacuum."""
        self._attr_name_attr_name = name
        self._attr_supported_features_attr_supported_features = supported_features
        self._state_state = STATE_DOCKED
        self._fan_speed_fan_speed = FAN_SPEEDS[1]
        self._cleaned_area: float = 0
        self._battery_level_battery_level = 100
 
    @property
    def state(self) -> str:
        """Return the current state of the vacuum."""
        return self._state_state
 
    @property
    def battery_level(self) -> int:
        """Return the current battery level of the vacuum."""
        return max(0, min(100, self._battery_level_battery_level))
 
    @property
    def fan_speed(self) -> str:
        """Return the current fan speed of the vacuum."""
        return self._fan_speed_fan_speed
 
    @property
    def fan_speed_list(self) -> list[str]:
        """Return the list of supported fan speeds."""
        return FAN_SPEEDS
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return device state attributes."""
        return {ATTR_CLEANED_AREA: round(self._cleaned_area, 2)}
 
    def start(self) -> None:
        """Start or resume the cleaning task."""
        if self._state_state != STATE_CLEANING:
            self._state_state = STATE_CLEANING
            self._cleaned_area += 1.32
            self._battery_level_battery_level -= 1
            self.schedule_update_ha_stateschedule_update_ha_state()
 
    def pause(self) -> None:
        """Pause the cleaning task."""
        if self._state_state == STATE_CLEANING:
            self._state_state = STATE_PAUSED
            self.schedule_update_ha_stateschedule_update_ha_state()
 
    def stop(self, **kwargs: Any) -> None:
        """Stop the cleaning task, do not return to dock."""
        self._state_state = STATE_IDLE
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def return_to_base(self, **kwargs: Any) -> None:
        """Return dock to charging base."""
        self._state_state = STATE_RETURNING
        self.schedule_update_ha_stateschedule_update_ha_state()
 
        event.call_later(self.hasshass, 30, self.__set_state_to_dock__set_state_to_dock)
 
    def clean_spot(self, **kwargs: Any) -> None:
        """Perform a spot clean-up."""
        self._state_state = STATE_CLEANING
        self._cleaned_area += 1.32
        self._battery_level_battery_level -= 1
        self.schedule_update_ha_stateschedule_update_ha_state()
 
    def set_fan_speed(self, fan_speed: str, **kwargs: Any) -> None:
        """Set the vacuum's fan speed."""
        if fan_speed in self.fan_speed_listfan_speed_listfan_speed_list:
            self._fan_speed_fan_speed = fan_speed
            self.schedule_update_ha_stateschedule_update_ha_state()
 
    async def async_locate(self, **kwargs: Any) -> None:
        """Locate the vacuum's position."""
        await self.hasshass.services.async_call(
            "notify",
            "persistent_notification",
            service_data={"message": "I'm here!", "title": "Locate request"},
        )
        self._state_state = STATE_IDLE
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_clean_spot(self, **kwargs: Any) -> None:
        """Locate the vacuum's position."""
        self._state_state = STATE_CLEANING
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_send_command(
        self,
        command: str,
        params: dict[str, Any] | list[Any] | None = None,
        **kwargs: Any,
    ) -> None:
        """Send a command to the vacuum."""
        self._state_state = STATE_IDLE
        self.async_write_ha_stateasync_write_ha_state()
 
    def __set_state_to_dock(self, _: datetime) -> None:
        self._state_state = STATE_DOCKED
        self.schedule_update_ha_stateschedule_update_ha_state()