mirror of
https://github.com/home-assistant/core.git
synced 2025-07-09 22:37:11 +00:00
Add base entity to Switch as X (#68057)
This commit is contained in:
parent
4ea0f7d321
commit
cd3f931ded
106
homeassistant/components/switch_as_x/entity.py
Normal file
106
homeassistant/components/switch_as_x/entity.py
Normal file
@ -0,0 +1,106 @@
|
||||
"""Base entity for the Switch as X integration."""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
from homeassistant.components.switch.const import DOMAIN as SWITCH_DOMAIN
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID,
|
||||
SERVICE_TURN_OFF,
|
||||
SERVICE_TURN_ON,
|
||||
STATE_ON,
|
||||
STATE_UNAVAILABLE,
|
||||
)
|
||||
from homeassistant.core import Event, callback
|
||||
from homeassistant.helpers import entity_registry as er
|
||||
from homeassistant.helpers.entity import Entity, ToggleEntity
|
||||
from homeassistant.helpers.event import async_track_state_change_event
|
||||
|
||||
|
||||
class BaseEntity(Entity):
|
||||
"""Represents a Switch as a X."""
|
||||
|
||||
_attr_should_poll = False
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
name: str,
|
||||
switch_entity_id: str,
|
||||
unique_id: str | None,
|
||||
device_id: str | None = None,
|
||||
) -> None:
|
||||
"""Initialize Light Switch."""
|
||||
self._device_id = device_id
|
||||
self._attr_name = name
|
||||
self._attr_unique_id = unique_id
|
||||
self._switch_entity_id = switch_entity_id
|
||||
|
||||
@callback
|
||||
def async_state_changed_listener(self, event: Event | None = None) -> None:
|
||||
"""Handle child updates."""
|
||||
if (
|
||||
state := self.hass.states.get(self._switch_entity_id)
|
||||
) is None or state.state == STATE_UNAVAILABLE:
|
||||
self._attr_available = False
|
||||
return
|
||||
|
||||
self._attr_available = True
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Register callbacks."""
|
||||
|
||||
@callback
|
||||
def _async_state_changed_listener(event: Event | None = None) -> None:
|
||||
"""Handle child updates."""
|
||||
self.async_state_changed_listener(event)
|
||||
self.async_write_ha_state()
|
||||
|
||||
self.async_on_remove(
|
||||
async_track_state_change_event(
|
||||
self.hass, [self._switch_entity_id], _async_state_changed_listener
|
||||
)
|
||||
)
|
||||
|
||||
# Call once on adding
|
||||
_async_state_changed_listener()
|
||||
|
||||
# Add this entity to the wrapped switch's device
|
||||
registry = er.async_get(self.hass)
|
||||
if registry.async_get(self.entity_id) is not None:
|
||||
registry.async_update_entity(self.entity_id, device_id=self._device_id)
|
||||
|
||||
|
||||
class BaseToggleEntity(BaseEntity, ToggleEntity):
|
||||
"""Represents a Switch as a ToggleEntity."""
|
||||
|
||||
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||
"""Forward the turn_on command to the switch in this light switch."""
|
||||
await self.hass.services.async_call(
|
||||
SWITCH_DOMAIN,
|
||||
SERVICE_TURN_ON,
|
||||
{ATTR_ENTITY_ID: self._switch_entity_id},
|
||||
blocking=True,
|
||||
context=self._context,
|
||||
)
|
||||
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Forward the turn_off command to the switch in this light switch."""
|
||||
await self.hass.services.async_call(
|
||||
SWITCH_DOMAIN,
|
||||
SERVICE_TURN_OFF,
|
||||
{ATTR_ENTITY_ID: self._switch_entity_id},
|
||||
blocking=True,
|
||||
context=self._context,
|
||||
)
|
||||
|
||||
@callback
|
||||
def async_state_changed_listener(self, event: Event | None = None) -> None:
|
||||
"""Handle child updates."""
|
||||
super().async_state_changed_listener(event)
|
||||
if (
|
||||
not self.available
|
||||
or (state := self.hass.states.get(self._switch_entity_id)) is None
|
||||
):
|
||||
return
|
||||
|
||||
self._attr_is_on = state.state == STATE_ON
|
@ -1,23 +1,14 @@
|
||||
"""Light support for switch entities."""
|
||||
from __future__ import annotations
|
||||
|
||||
from typing import Any
|
||||
|
||||
from homeassistant.components.light import COLOR_MODE_ONOFF, LightEntity
|
||||
from homeassistant.components.switch.const import DOMAIN as SWITCH_DOMAIN
|
||||
from homeassistant.config_entries import ConfigEntry
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID,
|
||||
CONF_ENTITY_ID,
|
||||
SERVICE_TURN_OFF,
|
||||
SERVICE_TURN_ON,
|
||||
STATE_ON,
|
||||
STATE_UNAVAILABLE,
|
||||
)
|
||||
from homeassistant.core import Event, HomeAssistant, callback
|
||||
from homeassistant.const import CONF_ENTITY_ID
|
||||
from homeassistant.core import HomeAssistant
|
||||
from homeassistant.helpers import entity_registry as er
|
||||
from homeassistant.helpers.entity_platform import AddEntitiesCallback
|
||||
from homeassistant.helpers.event import async_track_state_change_event
|
||||
|
||||
from .entity import BaseToggleEntity
|
||||
|
||||
|
||||
async def async_setup_entry(
|
||||
@ -26,7 +17,6 @@ async def async_setup_entry(
|
||||
async_add_entities: AddEntitiesCallback,
|
||||
) -> None:
|
||||
"""Initialize Light Switch config entry."""
|
||||
|
||||
registry = er.async_get(hass)
|
||||
entity_id = er.async_validate_entity_id(
|
||||
registry, config_entry.options[CONF_ENTITY_ID]
|
||||
@ -46,72 +36,8 @@ async def async_setup_entry(
|
||||
)
|
||||
|
||||
|
||||
class LightSwitch(LightEntity):
|
||||
class LightSwitch(BaseToggleEntity, LightEntity):
|
||||
"""Represents a Switch as a Light."""
|
||||
|
||||
_attr_color_mode = COLOR_MODE_ONOFF
|
||||
_attr_should_poll = False
|
||||
_attr_supported_color_modes = {COLOR_MODE_ONOFF}
|
||||
|
||||
def __init__(
|
||||
self,
|
||||
name: str,
|
||||
switch_entity_id: str,
|
||||
unique_id: str | None,
|
||||
device_id: str | None = None,
|
||||
) -> None:
|
||||
"""Initialize Light Switch."""
|
||||
self._device_id = device_id
|
||||
self._attr_name = name
|
||||
self._attr_unique_id = unique_id
|
||||
self._switch_entity_id = switch_entity_id
|
||||
|
||||
async def async_turn_on(self, **kwargs: Any) -> None:
|
||||
"""Forward the turn_on command to the switch in this light switch."""
|
||||
await self.hass.services.async_call(
|
||||
SWITCH_DOMAIN,
|
||||
SERVICE_TURN_ON,
|
||||
{ATTR_ENTITY_ID: self._switch_entity_id},
|
||||
blocking=True,
|
||||
context=self._context,
|
||||
)
|
||||
|
||||
async def async_turn_off(self, **kwargs: Any) -> None:
|
||||
"""Forward the turn_off command to the switch in this light switch."""
|
||||
await self.hass.services.async_call(
|
||||
SWITCH_DOMAIN,
|
||||
SERVICE_TURN_OFF,
|
||||
{ATTR_ENTITY_ID: self._switch_entity_id},
|
||||
blocking=True,
|
||||
context=self._context,
|
||||
)
|
||||
|
||||
async def async_added_to_hass(self) -> None:
|
||||
"""Register callbacks."""
|
||||
|
||||
@callback
|
||||
def async_state_changed_listener(event: Event | None = None) -> None:
|
||||
"""Handle child updates."""
|
||||
if (
|
||||
state := self.hass.states.get(self._switch_entity_id)
|
||||
) is None or state.state == STATE_UNAVAILABLE:
|
||||
self._attr_available = False
|
||||
return
|
||||
|
||||
self._attr_available = True
|
||||
self._attr_is_on = state.state == STATE_ON
|
||||
self.async_write_ha_state()
|
||||
|
||||
self.async_on_remove(
|
||||
async_track_state_change_event(
|
||||
self.hass, [self._switch_entity_id], async_state_changed_listener
|
||||
)
|
||||
)
|
||||
|
||||
# Call once on adding
|
||||
async_state_changed_listener()
|
||||
|
||||
# Add this entity to the wrapped switch's device
|
||||
registry = er.async_get(self.hass)
|
||||
if registry.async_get(self.entity_id) is not None:
|
||||
registry.async_update_entity(self.entity_id, device_id=self._device_id)
|
||||
|
Loading…
x
Reference in New Issue
Block a user