switch.py

Go to the documentation of this file.

"""Support for ZoneMinder switches."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import voluptuous as vol
from zoneminder.monitor import Monitor, MonitorState
from zoneminder.zm import ZoneMinder
 
from homeassistant.components.switch import (
    PLATFORM_SCHEMA as SWITCH_PLATFORM_SCHEMA,
    SwitchEntity,
)
from homeassistant.const import CONF_COMMAND_OFF, CONF_COMMAND_ON
from homeassistant.core import HomeAssistant
from homeassistant.exceptions import PlatformNotReady
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
from . import DOMAIN as ZONEMINDER_DOMAIN
 
_LOGGER = logging.getLogger(__name__)
 
PLATFORM_SCHEMA = SWITCH_PLATFORM_SCHEMA.extend(
    {
        vol.Required(CONF_COMMAND_ON): cv.string,
        vol.Required(CONF_COMMAND_OFF): cv.string,
    }
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up the ZoneMinder switch platform."""
 
    on_state = MonitorState(config.get(CONF_COMMAND_ON))
    off_state = MonitorState(config.get(CONF_COMMAND_OFF))
 
    switches: list[ZMSwitchMonitors] = []
    zm_client: ZoneMinder
    for zm_client in hass.data[ZONEMINDER_DOMAIN].values():
        if not (monitors := zm_client.get_monitors()):
            raise PlatformNotReady(
                "Switch could not fetch any monitors from ZoneMinder"
            )
        switches.extend(
            ZMSwitchMonitors(monitor, on_state, off_state) for monitor in monitors
        )
    add_entities(switches)
 
 
class ZMSwitchMonitors(SwitchEntity):
    """Representation of a ZoneMinder switch."""
 
    icon = "mdi:record-rec"
 
    def __init__(self, monitor: Monitor, on_state: str, off_state: str) -> None:
        """Initialize the switch."""
        self._monitor_monitor = monitor
        self._on_state_on_state = on_state
        self._off_state_off_state = off_state
        self._state_state: bool | None = None
        self._attr_name_attr_name = f"{monitor.name} State"
 
    def update(self) -> None:
        """Update the switch value."""
        self._state_state = self._monitor_monitor.function == self._on_state_on_state
 
    @property
    def is_on(self) -> bool | None:
        """Return True if entity is on."""
        return self._state_state
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the entity on."""
        self._monitor_monitor.function = self._on_state_on_state
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the entity off."""
        self._monitor_monitor.function = self._off_state_off_state