switch.py

Go to the documentation of this file.

"""Component provides support for the Foscam Switch."""
 
from __future__ import annotations
 
from typing import Any
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant, callback
from homeassistant.exceptions import HomeAssistantError
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from . import FoscamCoordinator
from .const import DOMAIN, LOGGER
from .entity import FoscamEntity
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up foscam switch from a config entry."""
 
    coordinator: FoscamCoordinator = hass.data[DOMAIN][config_entry.entry_id]
 
    await coordinator.async_config_entry_first_refresh()
 
    if coordinator.data["is_asleep"]["supported"]:
        async_add_entities([FoscamSleepSwitch(coordinator, config_entry)])
 
 
class FoscamSleepSwitch(FoscamEntity, SwitchEntity):
    """An implementation for Sleep Switch."""
 
    def __init__(
        self,
        coordinator: FoscamCoordinator,
        config_entry: ConfigEntry,
    ) -> None:
        """Initialize a Foscam Sleep Switch."""
        super().__init__(coordinator, config_entry.entry_id)
 
        self._attr_unique_id_attr_unique_id = "sleep_switch"
        self._attr_translation_key_attr_translation_key = "sleep_switch"
        self._attr_has_entity_name_attr_has_entity_name = True
 
        self.is_asleepis_asleep = self.coordinator.data["is_asleep"]["status"]
 
    @property
    def is_on(self):
        """Return true if camera is asleep."""
        return self.is_asleepis_asleep
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Wake camera."""
        LOGGER.debug("Wake camera")
 
        ret, _ = await self.hasshasshass.async_add_executor_job(
            self.coordinator.session.wake_up
        )
 
        if ret != 0:
            raise HomeAssistantError(f"Error waking up: {ret}")
 
        await self.coordinator.async_request_refresh()
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """But camera is sleep."""
        LOGGER.debug("Sleep camera")
 
        ret, _ = await self.hasshasshass.async_add_executor_job(self.coordinator.session.sleep)
 
        if ret != 0:
            raise HomeAssistantError(f"Error sleeping: {ret}")
 
        await self.coordinator.async_request_refresh()
 
    @callback
    def _handle_coordinator_update(self) -> None:
        """Handle updated data from the coordinator."""
 
        self.is_asleepis_asleep = self.coordinator.data["is_asleep"]["status"]
 
        self.async_write_ha_stateasync_write_ha_state()