switch.py

Go to the documentation of this file.

"""Support for custom shell commands to turn a switch on/off."""
 
from __future__ import annotations
 
import asyncio
from datetime import datetime, timedelta
from typing import TYPE_CHECKING, Any, cast
 
from homeassistant.components.switch import ENTITY_ID_FORMAT, SwitchEntity
from homeassistant.const import (
    CONF_COMMAND_OFF,
    CONF_COMMAND_ON,
    CONF_COMMAND_STATE,
    CONF_NAME,
    CONF_SCAN_INTERVAL,
    CONF_VALUE_TEMPLATE,
)
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.event import async_track_time_interval
from homeassistant.helpers.template import Template
from homeassistant.helpers.trigger_template_entity import ManualTriggerEntity
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from homeassistant.util import dt as dt_util, slugify
 
from .const import CONF_COMMAND_TIMEOUT, LOGGER, TRIGGER_ENTITY_OPTIONS
from .utils import async_call_shell_with_timeout, async_check_output_or_log
 
SCAN_INTERVAL = timedelta(seconds=30)
 
 
async def async_setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    async_add_entities: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Find and return switches controlled by shell commands."""
    if not discovery_info:
        return
 
    switches = []
    discovery_info = cast(DiscoveryInfoType, discovery_info)
    entities: dict[str, dict[str, Any]] = {
        slugify(discovery_info[CONF_NAME]): discovery_info
    }
 
    for object_id, switch_config in entities.items():
        trigger_entity_config = {
            CONF_NAME: Template(switch_config.get(CONF_NAME, object_id), hass),
            **{k: v for k, v in switch_config.items() if k in TRIGGER_ENTITY_OPTIONS},
        }
 
        switches.append(
            CommandSwitch(
                trigger_entity_config,
                object_id,
                switch_config[CONF_COMMAND_ON],
                switch_config[CONF_COMMAND_OFF],
                switch_config.get(CONF_COMMAND_STATE),
                switch_config.get(CONF_VALUE_TEMPLATE),
                switch_config[CONF_COMMAND_TIMEOUT],
                switch_config.get(CONF_SCAN_INTERVAL, SCAN_INTERVAL),
            )
        )
 
    async_add_entities(switches)
 
 
class CommandSwitch(ManualTriggerEntity, SwitchEntity):
    """Representation a switch that can be toggled using shell commands."""
 
    _attr_should_poll = False
 
    def __init__(
        self,
        config: ConfigType,
        object_id: str,
        command_on: str,
        command_off: str,
        command_state: str | None,
        value_template: Template | None,
        timeout: int,
        scan_interval: timedelta,
    ) -> None:
        """Initialize the switch."""
        super().__init__(self.hasshasshass, config)
        self.entity_identity_identity_id = ENTITY_ID_FORMAT.format(object_id)
        self._attr_is_on_attr_is_on = False
        self._command_on_command_on = command_on
        self._command_off_command_off = command_off
        self._command_state_command_state = command_state
        self._value_template_value_template = value_template
        self._timeout_timeout = timeout
        self._scan_interval_scan_interval = scan_interval
        self._process_updates_process_updates: asyncio.Lock | None = None
 
    async def async_added_to_hass(self) -> None:
        """Call when entity about to be added to hass."""
        await super().async_added_to_hass()
        if self._command_state_command_state:
            self.async_on_removeasync_on_remove(
                async_track_time_interval(
                    self.hasshasshass,
                    self._update_entity_state_update_entity_state,
                    self._scan_interval_scan_interval,
                    name=f"Command Line Cover - {self.name}",
                    cancel_on_shutdown=True,
                ),
            )
 
    async def _switch(self, command: str) -> bool:
        """Execute the actual commands."""
        LOGGER.debug("Running command: %s", command)
 
        success = await async_call_shell_with_timeout(command, self._timeout_timeout) == 0
 
        if not success:
            LOGGER.error("Command failed: %s", command)
 
        return success
 
    async def _async_query_state_value(self, command: str) -> str | None:
        """Execute state command for return value."""
        LOGGER.debug("Running state value command: %s", command)
        return await async_check_output_or_log(command, self._timeout_timeout)
 
    async def _async_query_state_code(self, command: str) -> bool:
        """Execute state command for return code."""
        LOGGER.debug("Running state code command: %s", command)
        return (
            await async_call_shell_with_timeout(
                command, self._timeout_timeout, log_return_code=False
            )
            == 0
        )
 
    @property
    def assumed_state(self) -> bool:
        """Return true if we do optimistic updates."""
        return self._command_state_command_state is None
 
    async def _async_query_state(self) -> str | int | None:
        """Query for state."""
        if TYPE_CHECKING:
            assert self._command_state_command_state
        if self._value_template_value_template:
            return await self._async_query_state_value_async_query_state_value(self._command_state_command_state)
        return await self._async_query_state_code_async_query_state_code(self._command_state_command_state)
 
    async def _update_entity_state(self, now: datetime | None = None) -> None:
        """Update the state of the entity."""
        if self._process_updates_process_updates is None:
            self._process_updates_process_updates = asyncio.Lock()
        if self._process_updates_process_updates.locked():
            LOGGER.warning(
                "Updating Command Line Switch %s took longer than the scheduled update interval %s",
                self.namenamename,
                self._scan_interval_scan_interval,
            )
            return
 
        async with self._process_updates_process_updates:
            await self._async_update_async_update()
 
    async def _async_update(self) -> None:
        """Update device state."""
        if self._command_state_command_state:
            payload = str(await self._async_query_state_async_query_state())
            value = None
            if self._value_template_value_template:
                value = self._value_template_value_template.async_render_with_possible_json_value(
                    payload, None
                )
            self._attr_is_on_attr_is_on = None
            if payload or value:
                self._attr_is_on_attr_is_on = (value or payload).lower() == "true"
            self._process_manual_data_process_manual_data(payload)
            self.async_write_ha_stateasync_write_ha_state()
 
    async def async_update(self) -> None:
        """Update the entity.
 
        Only used by the generic entity update service.
        """
        await self._update_entity_state_update_entity_state(dt_util.now())
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        if await self._switch_switch(self._command_on_command_on) and not self._command_state_command_state:
            self._attr_is_on_attr_is_on = True
            self.async_write_ha_stateasync_write_ha_state()
        await self._update_entity_state_update_entity_state()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        if await self._switch_switch(self._command_off_command_off) and not self._command_state_command_state:
            self._attr_is_on_attr_is_on = False
            self.async_write_ha_stateasync_write_ha_state()
        await self._update_entity_state_update_entity_state()