switch.py

Go to the documentation of this file.

"""Support for customised Kankun SP3 Wifi switch."""
 
from __future__ import annotations
 
import logging
from typing import Any
 
import requests
import voluptuous as vol
 
from homeassistant.components.switch import (
    PLATFORM_SCHEMA as SWITCH_PLATFORM_SCHEMA,
    SwitchEntity,
)
from homeassistant.const import (
    CONF_HOST,
    CONF_NAME,
    CONF_PASSWORD,
    CONF_PATH,
    CONF_PORT,
    CONF_SWITCHES,
    CONF_USERNAME,
)
from homeassistant.core import HomeAssistant
import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
 
_LOGGER = logging.getLogger(__name__)
 
DEFAULT_PORT = 80
DEFAULT_PATH = "/cgi-bin/json.cgi"
 
SWITCH_SCHEMA = vol.Schema(
    {
        vol.Required(CONF_HOST): cv.string,
        vol.Optional(CONF_NAME): cv.string,
        vol.Optional(CONF_PORT, default=DEFAULT_PORT): cv.port,
        vol.Optional(CONF_PATH, default=DEFAULT_PATH): cv.string,
        vol.Optional(CONF_USERNAME): cv.string,
        vol.Optional(CONF_PASSWORD): cv.string,
    }
)
 
PLATFORM_SCHEMA = SWITCH_PLATFORM_SCHEMA.extend(
    {vol.Required(CONF_SWITCHES): cv.schema_with_slug_keys(SWITCH_SCHEMA)}
)
 
 
def setup_platform(
    hass: HomeAssistant,
    config: ConfigType,
    add_entities_callback: AddEntitiesCallback,
    discovery_info: DiscoveryInfoType | None = None,
) -> None:
    """Set up Kankun Wifi switches."""
    switches = config.get("switches", {})
    devices = []
 
    for dev_name, properties in switches.items():
        devices.append(
            KankunSwitch(
                hass,
                properties.get(CONF_NAME, dev_name),
                properties.get(CONF_HOST),
                properties.get(CONF_PORT, DEFAULT_PORT),
                properties.get(CONF_PATH, DEFAULT_PATH),
                properties.get(CONF_USERNAME),
                properties.get(CONF_PASSWORD),
            )
        )
 
    add_entities_callback(devices)
 
 
class KankunSwitch(SwitchEntity):
    """Representation of a Kankun Wifi switch."""
 
    def __init__(self, hass, name, host, port, path, user, passwd):
        """Initialize the device."""
        self._hass_hass = hass
        self._name_name = name
        self._state_state = False
        self._url_url = f"http://{host}:{port}{path}"
        if user is not None:
            self._auth_auth = (user, passwd)
        else:
            self._auth_auth = None
 
    def _switch(self, newstate):
        """Switch on or off."""
        _LOGGER.debug("Switching to state: %s", newstate)
 
        try:
            req = requests.get(
                f"{self._url}?set={newstate}", auth=self._auth_auth, timeout=5
            )
            return req.json()["ok"]
        except requests.RequestException:
            _LOGGER.error("Switching failed")
 
    def _query_state(self):
        """Query switch state."""
        _LOGGER.debug("Querying state from: %s", self._url_url)
 
        try:
            req = requests.get(f"{self._url}?get=state", auth=self._auth_auth, timeout=5)
            return req.json()["state"] == "on"
        except requests.RequestException:
            _LOGGER.error("State query failed")
 
    @property
    def name(self):
        """Return the name of the switch."""
        return self._name_name
 
    @property
    def is_on(self):
        """Return true if device is on."""
        return self._state_state
 
    def update(self) -> None:
        """Update device state."""
        self._state_state = self._query_state_query_state()
 
    def turn_on(self, **kwargs: Any) -> None:
        """Turn the device on."""
        if self._switch_switch("on"):
            self._state_state = True
 
    def turn_off(self, **kwargs: Any) -> None:
        """Turn the device off."""
        if self._switch_switch("off"):
            self._state_state = False