switch.py

Go to the documentation of this file.

"""Support for Switchmate."""
 
from __future__ import annotations
 
from datetime import timedelta
from typing import Any
 
from switchmate import Switchmate
import voluptuous as vol
 
from homeassistant.components.switch import (
    PLATFORM_SCHEMA as SWITCH_PLATFORM_SCHEMA,
    SwitchEntity,
)
from homeassistant.const import CONF_MAC, CONF_NAME
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
CONF_FLIP_ON_OFF = "flip_on_off"
DEFAULT_NAME = "Switchmate"
 
SCAN_INTERVAL = timedelta(minutes=30)
 
PLATFORM_SCHEMA = SWITCH_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_MAC): cv.string,
        vol.Optional(CONF_NAME, default=DEFAULT_NAME): cv.string,
        vol.Optional(CONF_FLIP_ON_OFF, default=False): cv.boolean,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Perform the setup for Switchmate devices."""
    name = config.get(CONF_NAME)
    mac_addr = config[CONF_MAC]
    flip_on_off = config[CONF_FLIP_ON_OFF]
    add_entities([SwitchmateEntity(mac_addr, name, flip_on_off)], True)
 
 
class SwitchmateEntity(SwitchEntity):
    """Representation of a Switchmate."""
 
    def __init__(self, mac, name, flip_on_off) -> None:
        """Initialize the Switchmate."""
 
        self._mac_mac = mac
        self._name_name = name
        self._device_device = Switchmate(mac=mac, flip_on_off=flip_on_off)
 
    @property
    def unique_id(self) -> str:
        """Return a unique, Home Assistant friendly identifier for this entity."""
        return self._mac_mac.replace(":", "")
 
    @property
    def available(self) -> bool:
        """Return True if entity is available."""
        return self._device_device.available
 
    @property
    def name(self) -> str:
        """Return the name of the switch."""
        return self._name_name
 
    async def async_update(self) -> None:
        """Synchronize state with switch."""
        await self._device_device.update()
 
    @property
    def is_on(self) -> bool:
        """Return true if it is on."""
        return self._device_device.state
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the switch on."""
        await self._device_device.turn_on()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the switch off."""
        await self._device_device.turn_off()