scene.py

Go to the documentation of this file.

"""Provide configuration end points for Scenes."""
 
from __future__ import annotations
 
from typing import Any
import uuid
 
from homeassistant.components.scene import (
    DOMAIN as SCENE_DOMAIN,
    PLATFORM_SCHEMA as SCENE_PLATFORM_SCHEMA,
)
from homeassistant.config import SCENE_CONFIG_PATH
from homeassistant.const import CONF_ID, SERVICE_RELOAD
from homeassistant.core import DOMAIN as HOMEASSISTANT_DOMAIN, HomeAssistant, callback
from homeassistant.helpers import config_validation as cv, entity_registry as er
 
from .const import ACTION_DELETE
from .view import EditIdBasedConfigView
 
PLATFORM_SCHEMA = SCENE_PLATFORM_SCHEMA
 
 
@callback
def async_setup(hass: HomeAssistant) -> bool:
    """Set up the Scene config API."""
 
    async def hook(action: str, config_key: str) -> None:
        """post_write_hook for Config View that reloads scenes."""
        if action != ACTION_DELETE:
            await hass.services.async_call(SCENE_DOMAIN, SERVICE_RELOAD)
            return
 
        ent_reg = er.async_get(hass)
 
        entity_id = ent_reg.async_get_entity_id(
            SCENE_DOMAIN, HOMEASSISTANT_DOMAIN, config_key
        )
 
        if entity_id is None:
            return
 
        ent_reg.async_remove(entity_id)
 
    hass.http.register_view(
        EditSceneConfigView(
            SCENE_DOMAIN,
            "config",
            SCENE_CONFIG_PATH,
            cv.string,
            data_schema=PLATFORM_SCHEMA,
            post_write_hook=hook,
        )
    )
    return True
 
 
class EditSceneConfigView(EditIdBasedConfigView):
    """Edit scene config."""
 
    def _write_value(
        self,
        hass: HomeAssistant,
        data: list[dict[str, Any]],
        config_key: str,
        new_value: dict[str, Any],
    ) -> None:
        """Set value."""
        updated_value = {CONF_ID: config_key}
        # Iterate through some keys that we want to have ordered in the output
        for key in ("name", "entities"):
            if key in new_value:
                updated_value[key] = new_value[key]
 
        # We cover all current fields above, but just in case we start
        # supporting more fields in the future.
        updated_value.update(new_value)
 
        updated = False
        for index, cur_value in enumerate(data):
            # When people copy paste their scenes to the config file,
            # they sometimes forget to add IDs. Fix it here.
            if CONF_ID not in cur_value:
                cur_value[CONF_ID] = uuid.uuid4().hex
 
            elif cur_value[CONF_ID] == config_key:
                data[index] = updated_value
                updated = True
 
        if not updated:
            data.append(updated_value)