switch.py

Go to the documentation of this file.

"""Elmax switch platform."""
 
import asyncio
import logging
from typing import Any
 
from elmax_api.model.command import SwitchCommand
from elmax_api.model.panel import PanelStatus
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
from .const import DOMAIN
from .coordinator import ElmaxCoordinator
from .entity import ElmaxEntity
 
_LOGGER = logging.getLogger(__name__)
 
 
async def async_setup_entry(
    hass: HomeAssistant,
    config_entry: ConfigEntry,
    async_add_entities: AddEntitiesCallback,
) -> None:
    """Set up the Elmax switch platform."""
    coordinator: ElmaxCoordinator = hass.data[DOMAIN][config_entry.entry_id]
    known_devices = set()
 
    def _discover_new_devices():
        panel_status: PanelStatus = coordinator.data
        # In case the panel is offline, its status will be None. In that case, simply do nothing
        if panel_status is None:
            return
 
        # Otherwise, add all the entities we found
        entities = []
        for actuator in panel_status.actuators:
            # Skip already handled devices
            if actuator.endpoint_id in known_devices:
                continue
            entity = ElmaxSwitch(
                elmax_device=actuator,
                panel_version=panel_status.release,
                coordinator=coordinator,
            )
            entities.append(entity)
 
        if entities:
            async_add_entities(entities)
            known_devices.update([entity.unique_id for entity in entities])
 
    # Register a listener for the discovery of new devices
    remove_handle = coordinator.async_add_listener(_discover_new_devices)
    config_entry.async_on_unload(remove_handle)
 
    # Immediately run a discovery, so we don't need to wait for the next update
    _discover_new_devices()
 
 
class ElmaxSwitch(ElmaxEntity, SwitchEntity):
    """Implement the Elmax switch entity."""
 
    @property
    def is_on(self) -> bool:
        """Return True if entity is on."""
        return self.coordinator.get_actuator_state(self._device_device.endpoint_id).opened
 
    async def _wait_for_state_change(self) -> bool:
        """Refresh data and wait until the state changes."""
        old_state = self.coordinator.get_actuator_state(self._device_device.endpoint_id).opened
 
        # Wait a bit at first to let Elmax cloud assimilate the new state.
        await asyncio.sleep(2.0)
        await self.coordinator.async_refresh()
        new_state = self.coordinator.get_actuator_state(self._device_device.endpoint_id).opened
 
        # First check attempt.
        if new_state == old_state:
            # Otherwise sleep a bit more and then trigger a final update.
            await asyncio.sleep(5.0)
            await self.coordinator.async_refresh()
            new_state = self.coordinator.get_actuator_state(
                self._device_device.endpoint_id
            ).opened
 
        return new_state != old_state
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the entity on."""
        await self.coordinator.http_client.execute_command(
            endpoint_id=self._device_device.endpoint_id, command=SwitchCommand.TURN_ON
        )
        if await self._wait_for_state_change_wait_for_state_change():
            self.async_write_ha_stateasync_write_ha_state()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the entity off."""
        await self.coordinator.http_client.execute_command(
            endpoint_id=self._device_device.endpoint_id, command=SwitchCommand.TURN_OFF
        )
        if await self._wait_for_state_change_wait_for_state_change():
            self.async_write_ha_stateasync_write_ha_state()