switch.py

Go to the documentation of this file.

"""KMtronic Switch integration."""
 
from typing import Any
import urllib.parse
 
from homeassistant.components.switch import SwitchEntity
from homeassistant.config_entries import ConfigEntry
from homeassistant.core import HomeAssistant
from homeassistant.helpers.device_registry import DeviceInfo
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.update_coordinator import CoordinatorEntity
 
from .const import CONF_REVERSE, DATA_COORDINATOR, DATA_HUB, DOMAIN, MANUFACTURER
 
 
async def async_setup_entry(
    hass: HomeAssistant, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
) -> None:
    """Config entry example."""
    coordinator = hass.data[DOMAIN][entry.entry_id][DATA_COORDINATOR]
    hub = hass.data[DOMAIN][entry.entry_id][DATA_HUB]
    reverse = entry.options.get(CONF_REVERSE, False)
    await hub.async_get_relays()
 
    async_add_entities(
        [
            KMtronicSwitch(hub, coordinator, relay, reverse, entry.entry_id)
            for relay in hub.relays
        ]
    )
 
 
class KMtronicSwitch(CoordinatorEntity, SwitchEntity):
    """KMtronic Switch Entity."""
 
    _attr_translation_key = "relay"
    _attr_has_entity_name = True
 
    def __init__(self, hub, coordinator, relay, reverse, config_entry_id):
        """Pass coordinator to CoordinatorEntity."""
        super().__init__(coordinator)
        self._relay_relay = relay
        self._reverse_reverse = reverse
 
        hostname = urllib.parse.urlsplit(hub.host).hostname
        self._attr_device_info_attr_device_info = DeviceInfo(
            identifiers={(DOMAIN, config_entry_id)},
            name=f"Controller {hostname}",
            manufacturer=MANUFACTURER,
            configuration_url=hub.host,
        )
 
        self._attr_translation_placeholders_attr_translation_placeholders = {"relay_id": relay.id}
        self._attr_unique_id_attr_unique_id = f"{config_entry_id}_relay{relay.id}"
 
    @property
    def is_on(self):
        """Return entity state."""
        if self._reverse_reverse:
            return not self._relay_relay.is_energised
        return self._relay_relay.is_energised
 
    async def async_turn_on(self, **kwargs: Any) -> None:
        """Turn the switch on."""
        if self._reverse_reverse:
            await self._relay_relay.de_energise()
        else:
            await self._relay_relay.energise()
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_turn_off(self, **kwargs: Any) -> None:
        """Turn the switch off."""
        if self._reverse_reverse:
            await self._relay_relay.energise()
        else:
            await self._relay_relay.de_energise()
        self.async_write_ha_stateasync_write_ha_state()
 
    async def async_toggle(self, **kwargs: Any) -> None:
        """Toggle the switch."""
        await self._relay_relay.toggle()
        self.async_write_ha_stateasync_write_ha_state()