mirror of
https://github.com/home-assistant/core
synced 2024-08-31 05:57:13 +02:00
110 lines
3.1 KiB
Python
110 lines
3.1 KiB
Python
"""Allow users to set and activate scenes."""
|
|
from __future__ import annotations
|
|
|
|
import functools as ft
|
|
import importlib
|
|
import logging
|
|
from typing import Any
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.light import ATTR_TRANSITION
|
|
from homeassistant.const import CONF_PLATFORM, SERVICE_TURN_ON
|
|
from homeassistant.core import DOMAIN as HA_DOMAIN
|
|
from homeassistant.helpers.entity import Entity
|
|
from homeassistant.helpers.entity_component import EntityComponent
|
|
|
|
# mypy: allow-untyped-defs, no-check-untyped-defs
|
|
|
|
DOMAIN = "scene"
|
|
STATE = "scening"
|
|
STATES = "states"
|
|
|
|
|
|
def _hass_domain_validator(config):
|
|
"""Validate platform in config for homeassistant domain."""
|
|
if CONF_PLATFORM not in config:
|
|
config = {CONF_PLATFORM: HA_DOMAIN, STATES: config}
|
|
|
|
return config
|
|
|
|
|
|
def _platform_validator(config):
|
|
"""Validate it is a valid platform."""
|
|
try:
|
|
platform = importlib.import_module(f".{config[CONF_PLATFORM]}", __name__)
|
|
except ImportError:
|
|
try:
|
|
platform = importlib.import_module(
|
|
f"homeassistant.components.{config[CONF_PLATFORM]}.scene"
|
|
)
|
|
except ImportError:
|
|
raise vol.Invalid("Invalid platform specified") from None
|
|
|
|
if not hasattr(platform, "PLATFORM_SCHEMA"):
|
|
return config
|
|
|
|
return platform.PLATFORM_SCHEMA(config)
|
|
|
|
|
|
PLATFORM_SCHEMA = vol.Schema(
|
|
vol.All(
|
|
_hass_domain_validator,
|
|
vol.Schema({vol.Required(CONF_PLATFORM): str}, extra=vol.ALLOW_EXTRA),
|
|
_platform_validator,
|
|
),
|
|
extra=vol.ALLOW_EXTRA,
|
|
)
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Set up the scenes."""
|
|
component = hass.data[DOMAIN] = EntityComponent(
|
|
logging.getLogger(__name__), DOMAIN, hass
|
|
)
|
|
|
|
await component.async_setup(config)
|
|
# Ensure Home Assistant platform always loaded.
|
|
await component.async_setup_platform(HA_DOMAIN, {"platform": HA_DOMAIN, STATES: []})
|
|
component.async_register_entity_service(
|
|
SERVICE_TURN_ON,
|
|
{ATTR_TRANSITION: vol.All(vol.Coerce(float), vol.Clamp(min=0, max=6553))},
|
|
"async_activate",
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
async def async_setup_entry(hass, entry):
|
|
"""Set up a config entry."""
|
|
return await hass.data[DOMAIN].async_setup_entry(entry)
|
|
|
|
|
|
async def async_unload_entry(hass, entry):
|
|
"""Unload a config entry."""
|
|
return await hass.data[DOMAIN].async_unload_entry(entry)
|
|
|
|
|
|
class Scene(Entity):
|
|
"""A scene is a group of entities and the states we want them to be."""
|
|
|
|
@property
|
|
def should_poll(self) -> bool:
|
|
"""No polling needed."""
|
|
return False
|
|
|
|
@property
|
|
def state(self) -> str | None:
|
|
"""Return the state of the scene."""
|
|
return STATE
|
|
|
|
def activate(self, **kwargs: Any) -> None:
|
|
"""Activate scene. Try to get entities into requested state."""
|
|
raise NotImplementedError()
|
|
|
|
async def async_activate(self, **kwargs: Any) -> None:
|
|
"""Activate scene. Try to get entities into requested state."""
|
|
task = self.hass.async_add_job(ft.partial(self.activate, **kwargs))
|
|
if task:
|
|
await task
|