lawn_mower.py

Go to the documentation of this file.

"""Demo platform that has a couple fake lawn mowers."""
 
from __future__ import annotations
 
from homeassistant.components.lawn_mower import (
    LawnMowerActivity,
    LawnMowerEntity,
    LawnMowerEntityFeature,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the Demo lawn mowers."""
    async_add_entities(
        [
            DemoLawnMower(
                "kitchen_sink_mower_001",
                "Mower can mow",
                LawnMowerActivity.DOCKED,
                LawnMowerEntityFeature.START_MOWING,
            ),
            DemoLawnMower(
                "kitchen_sink_mower_002",
                "Mower can return",
                LawnMowerActivity.RETURNING,
                LawnMowerEntityFeature.DOCK
                | LawnMowerEntityFeature.PAUSE
                | LawnMowerEntityFeature.START_MOWING,
            ),
            DemoLawnMower(
                "kitchen_sink_mower_003",
                "Mower can dock",
                LawnMowerActivity.MOWING,
                LawnMowerEntityFeature.DOCK | LawnMowerEntityFeature.START_MOWING,
            ),
            DemoLawnMower(
                "kitchen_sink_mower_004",
                "Mower can pause",
                LawnMowerActivity.DOCKED,
                LawnMowerEntityFeature.PAUSE | LawnMowerEntityFeature.START_MOWING,
            ),
            DemoLawnMower(
                "kitchen_sink_mower_005",
                "Mower can do all",
                LawnMowerActivity.DOCKED,
                LawnMowerEntityFeature.DOCK
                | LawnMowerEntityFeature.PAUSE
                | LawnMowerEntityFeature.START_MOWING,
            ),
            DemoLawnMower(
                "kitchen_sink_mower_006",
                "Mower is paused",
                LawnMowerActivity.PAUSED,
                LawnMowerEntityFeature.DOCK
                | LawnMowerEntityFeature.PAUSE
                | LawnMowerEntityFeature.START_MOWING,
            ),
        ]
    )
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Everything but the Kitchen Sink config entry."""
    await async_setup_platform(hass, {}, async_add_entities)
 
 
class DemoLawnMower(LawnMowerEntity):
    """Representation of a Demo lawn mower."""
 
    def __init__(
        self,
        unique_id: str,
        name: str,
        activity: LawnMowerActivity,
        features: LawnMowerEntityFeature = LawnMowerEntityFeature(0),
    ) -> None:
        """Initialize the lawn mower."""
        self._attr_name_attr_name = name
        self._attr_unique_id_attr_unique_id = unique_id
        self._attr_supported_features_attr_supported_features = features
        self._attr_activity_attr_activity = activity
 
    async def async_start_mowing(self) -> None:
        """Start mowing."""
        self._attr_activity_attr_activity = LawnMowerActivity.MOWING
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_dock(self) -> None:
        """Start docking."""
        self._attr_activity_attr_activity = LawnMowerActivity.DOCKED
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_pause(self) -> None:
        """Pause mower."""
        self._attr_activity_attr_activity = LawnMowerActivity.PAUSED
        self.async_write_ha_stateasync_write_ha_state()