switch.py

Go to the documentation of this file.

"""Support for WeMo switches."""
 
from __future__ import annotations
 
from datetime import datetime, timedelta
from typing import Any
 
from pywemo import CoffeeMaker, Insight, Maker, StandbyState, Switch
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import STATE_OFF, STATE_ON, STATE_STANDBY, STATE_UNKNOWN
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import async_wemo_dispatcher_connect
from .coordinator import DeviceCoordinator
from .entity import WemoBinaryStateEntity
 
SCAN_INTERVAL = timedelta(seconds=10)
PARALLEL_UPDATES = 0
 
ATTR_COFFEMAKER_MODE = "coffeemaker_mode"
ATTR_CURRENT_STATE_DETAIL = "state_detail"
ATTR_ON_LATEST_TIME = "on_latest_time"
ATTR_ON_TODAY_TIME = "on_today_time"
ATTR_ON_TOTAL_TIME = "on_total_time"
ATTR_POWER_THRESHOLD = "power_threshold_w"
ATTR_SENSOR_STATE = "sensor_state"
ATTR_SWITCH_MODE = "switch_mode"
 
MAKER_SWITCH_MOMENTARY = "momentary"
MAKER_SWITCH_TOGGLE = "toggle"
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    _config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up WeMo switches."""
 
    async def _discovered_wemo(coordinator: DeviceCoordinator) -> None:
        """Handle a discovered Wemo device."""
        async_add_entities([WemoSwitch(coordinator)])
 
    await async_wemo_dispatcher_connect(hass, _discovered_wemo)
 
 
class WemoSwitch(WemoBinaryStateEntity, SwitchEntity):
    """Representation of a WeMo switch."""
 
    # All wemo devices used with WemoSwitch are subclasses of Switch.
    wemo: Switch
 
    @property
    def extra_state_attributes(self) -> dict[str, Any]:
        """Return the state attributes of the device."""
        attr: dict[str, Any] = {}
        if isinstance(self.wemowemowemo, Maker):
            # Is the maker sensor on or off.
            if self.wemowemowemo.has_sensor:
                # Note a state of 1 matches the WeMo app 'not triggered'!
                if self.wemowemowemo.sensor_state:
                    attr[ATTR_SENSOR_STATE] = STATE_OFF
                else:
                    attr[ATTR_SENSOR_STATE] = STATE_ON
 
            # Is the maker switch configured as toggle(0) or momentary (1).
            if self.wemowemowemo.switch_mode:
                attr[ATTR_SWITCH_MODE] = MAKER_SWITCH_MOMENTARY
            else:
                attr[ATTR_SWITCH_MODE] = MAKER_SWITCH_TOGGLE
 
        if isinstance(self.wemowemowemo, (Insight, CoffeeMaker)):
            attr[ATTR_CURRENT_STATE_DETAIL] = self.detail_statedetail_state
 
        if isinstance(self.wemowemowemo, Insight):
            attr[ATTR_ON_LATEST_TIME] = self.as_uptimeas_uptime(self.wemowemowemo.on_for)
            attr[ATTR_ON_TODAY_TIME] = self.as_uptimeas_uptime(self.wemowemowemo.today_on_time)
            attr[ATTR_ON_TOTAL_TIME] = self.as_uptimeas_uptime(self.wemowemowemo.total_on_time)
            attr[ATTR_POWER_THRESHOLD] = self.wemowemowemo.threshold_power_watts
 
        if isinstance(self.wemowemowemo, CoffeeMaker):
            attr[ATTR_COFFEMAKER_MODE] = self.wemowemowemo.mode
 
        return attr
 
    @staticmethod
    def as_uptime(_seconds: int) -> str:
        """Format seconds into uptime string in the format: 00d 00h 00m 00s."""
        uptime = datetime(1, 1, 1) + timedelta(seconds=_seconds)
        return (
            f"{uptime.day - 1:0>2d}d {uptime.hour:0>2d}h "
            f"{uptime.minute:0>2d}m {uptime.second:0>2d}s"
        )
 
    @property
    def detail_state(self) -> str:
        """Return the state of the device."""
        if isinstance(self.wemowemowemo, CoffeeMaker):
            return self.wemowemowemo.mode_string
        if isinstance(self.wemowemowemo, Insight):
            standby_state = self.wemowemowemo.standby_state
            if standby_state == StandbyState.ON:
                return STATE_ON
            if standby_state == StandbyState.OFF:
                return STATE_OFF
            if standby_state == StandbyState.STANDBY:
                return STATE_STANDBY
            return STATE_UNKNOWN
        # Unreachable code statement.
        raise RuntimeError
 
    @property
    def icon(self) -> str | None:
        """Return the icon of device based on its type."""
        if isinstance(self.wemowemowemo, CoffeeMaker):
            return "mdi:coffee"
        return None
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the switch on."""
        with self._wemo_call_wrapper_wemo_call_wrapper("turn on"):
            self.wemowemowemo.on()
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the switch off."""
        with self._wemo_call_wrapper_wemo_call_wrapper("turn off"):
            self.wemowemowemo.off()