mirror of
https://github.com/home-assistant/core
synced 2024-09-03 08:14:07 +02:00
202 lines
5.7 KiB
Python
202 lines
5.7 KiB
Python
"""Support for SCSGate switches."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
|
|
from scsgate.messages import ScenarioTriggeredMessage, StateMessage
|
|
from scsgate.tasks import ToggleStatusTask
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.switch import PLATFORM_SCHEMA, SwitchEntity
|
|
from homeassistant.const import ATTR_ENTITY_ID, ATTR_STATE, CONF_DEVICES, CONF_NAME
|
|
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
|
|
|
|
from . import CONF_SCS_ID, DOMAIN, SCSGATE_SCHEMA
|
|
|
|
ATTR_SCENARIO_ID = "scenario_id"
|
|
|
|
CONF_TRADITIONAL = "traditional"
|
|
CONF_SCENARIO = "scenario"
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{vol.Required(CONF_DEVICES): cv.schema_with_slug_keys(SCSGATE_SCHEMA)}
|
|
)
|
|
|
|
|
|
def setup_platform(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
add_entities: AddEntitiesCallback,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> None:
|
|
"""Set up the SCSGate switches."""
|
|
logger = logging.getLogger(__name__)
|
|
scsgate = hass.data[DOMAIN]
|
|
|
|
_setup_traditional_switches(
|
|
logger=logger,
|
|
config=config,
|
|
scsgate=scsgate,
|
|
add_entities_callback=add_entities,
|
|
)
|
|
|
|
_setup_scenario_switches(logger=logger, config=config, scsgate=scsgate, hass=hass)
|
|
|
|
|
|
def _setup_traditional_switches(logger, config, scsgate, add_entities_callback):
|
|
"""Add traditional SCSGate switches."""
|
|
traditional = config.get(CONF_TRADITIONAL)
|
|
switches = []
|
|
|
|
if traditional:
|
|
for entity_info in traditional.values():
|
|
if entity_info[CONF_SCS_ID] in scsgate.devices:
|
|
continue
|
|
|
|
name = entity_info[CONF_NAME]
|
|
scs_id = entity_info[CONF_SCS_ID]
|
|
|
|
logger.info("Adding %s scsgate.traditional_switch", name)
|
|
|
|
switch = SCSGateSwitch(
|
|
name=name, scs_id=scs_id, logger=logger, scsgate=scsgate
|
|
)
|
|
switches.append(switch)
|
|
|
|
add_entities_callback(switches)
|
|
scsgate.add_devices_to_register(switches)
|
|
|
|
|
|
def _setup_scenario_switches(logger, config, scsgate, hass):
|
|
"""Add only SCSGate scenario switches."""
|
|
if scenario := config.get(CONF_SCENARIO):
|
|
for entity_info in scenario.values():
|
|
if entity_info[CONF_SCS_ID] in scsgate.devices:
|
|
continue
|
|
|
|
name = entity_info[CONF_NAME]
|
|
scs_id = entity_info[CONF_SCS_ID]
|
|
|
|
logger.info("Adding %s scsgate.scenario_switch", name)
|
|
|
|
switch = SCSGateScenarioSwitch(
|
|
name=name, scs_id=scs_id, logger=logger, hass=hass
|
|
)
|
|
scsgate.add_device(switch)
|
|
|
|
|
|
class SCSGateSwitch(SwitchEntity):
|
|
"""Representation of a SCSGate switch."""
|
|
|
|
def __init__(self, scs_id, name, logger, scsgate):
|
|
"""Initialize the switch."""
|
|
self._name = name
|
|
self._scs_id = scs_id
|
|
self._toggled = False
|
|
self._logger = logger
|
|
self._scsgate = scsgate
|
|
|
|
@property
|
|
def scs_id(self):
|
|
"""Return the SCS ID."""
|
|
return self._scs_id
|
|
|
|
@property
|
|
def should_poll(self):
|
|
"""No polling needed."""
|
|
return False
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device if any."""
|
|
return self._name
|
|
|
|
@property
|
|
def is_on(self):
|
|
"""Return true if switch is on."""
|
|
return self._toggled
|
|
|
|
def turn_on(self, **kwargs):
|
|
"""Turn the device on."""
|
|
|
|
self._scsgate.append_task(ToggleStatusTask(target=self._scs_id, toggled=True))
|
|
|
|
self._toggled = True
|
|
self.schedule_update_ha_state()
|
|
|
|
def turn_off(self, **kwargs):
|
|
"""Turn the device off."""
|
|
|
|
self._scsgate.append_task(ToggleStatusTask(target=self._scs_id, toggled=False))
|
|
|
|
self._toggled = False
|
|
self.schedule_update_ha_state()
|
|
|
|
def process_event(self, message):
|
|
"""Handle a SCSGate message related with this switch."""
|
|
if self._toggled == message.toggled:
|
|
self._logger.info(
|
|
"Switch %s, ignoring message %s because state already active",
|
|
self._scs_id,
|
|
message,
|
|
)
|
|
# Nothing changed, ignoring
|
|
return
|
|
|
|
self._toggled = message.toggled
|
|
self.schedule_update_ha_state()
|
|
|
|
command = "off"
|
|
if self._toggled:
|
|
command = "on"
|
|
|
|
self.hass.bus.fire(
|
|
"button_pressed", {ATTR_ENTITY_ID: self._scs_id, ATTR_STATE: command}
|
|
)
|
|
|
|
|
|
class SCSGateScenarioSwitch:
|
|
"""Provides a SCSGate scenario switch.
|
|
|
|
This switch is always in an 'off" state, when toggled it's used to trigger
|
|
events.
|
|
"""
|
|
|
|
def __init__(self, scs_id, name, logger, hass):
|
|
"""Initialize the scenario."""
|
|
self._name = name
|
|
self._scs_id = scs_id
|
|
self._logger = logger
|
|
self._hass = hass
|
|
|
|
@property
|
|
def scs_id(self):
|
|
"""Return the SCS ID."""
|
|
return self._scs_id
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the device if any."""
|
|
return self._name
|
|
|
|
def process_event(self, message):
|
|
"""Handle a SCSGate message related with this switch."""
|
|
|
|
if isinstance(message, StateMessage):
|
|
scenario_id = message.bytes[4]
|
|
elif isinstance(message, ScenarioTriggeredMessage):
|
|
scenario_id = message.scenario
|
|
else:
|
|
self._logger.warning(
|
|
"Scenario switch: received unknown message %s", message
|
|
)
|
|
return
|
|
|
|
self._hass.bus.fire(
|
|
"scenario_switch_triggered",
|
|
{ATTR_ENTITY_ID: int(self._scs_id), ATTR_SCENARIO_ID: int(scenario_id, 16)},
|
|
)
|