c56701baaf
* Add tests to reach full coverage for helpers/state.py. * Refactor reproduce_state function in helpers/state.py. Add two dicts, as global constants, service_attributes and service_to_state. Use these in combination with the dict of services per domain from ServiceRegistry, to find the correct service to use in a scene state change. * Use break statement in for loop, to break if service was selected to update state, in preference to update state attributes, ie state update takes precedence. * Add ATTR_CODE and ATTR_CODE_FORMAT in const. Import these in alarm_control_panel and lock platforms instead of making duplicate constants in multiple modules. * Use ATTR_MEDIA_CONTENT_TYPE and ATTR_MEDIA_CONTENT_ID in media_player platform in SERVICE_PLAY_MEDIA and play_media methods, instead of 'media_type' and 'media_id'. * Fix PEP257 in modified files.
86 lines
2.5 KiB
Python
86 lines
2.5 KiB
Python
"""
|
|
Allow users to set and activate scenes.
|
|
|
|
For more details about this component, please refer to the documentation at
|
|
https://home-assistant.io/components/scene/
|
|
"""
|
|
from collections import namedtuple
|
|
|
|
from homeassistant.components.scene import Scene
|
|
from homeassistant.const import (
|
|
ATTR_ENTITY_ID, STATE_OFF, STATE_ON)
|
|
from homeassistant.core import State
|
|
from homeassistant.helpers.state import reproduce_state
|
|
|
|
DEPENDENCIES = ['group']
|
|
STATE = 'scening'
|
|
|
|
CONF_ENTITIES = "entities"
|
|
|
|
SceneConfig = namedtuple('SceneConfig', ['name', 'states'])
|
|
|
|
|
|
def setup_platform(hass, config, add_devices, discovery_info=None):
|
|
"""Setup home assistant scene entries."""
|
|
scene_config = config.get("states")
|
|
|
|
if not isinstance(scene_config, list):
|
|
scene_config = [scene_config]
|
|
|
|
add_devices(HomeAssistantScene(hass, _process_config(scene))
|
|
for scene in scene_config)
|
|
|
|
return True
|
|
|
|
|
|
def _process_config(scene_config):
|
|
"""Process passed in config into a format to work with."""
|
|
name = scene_config.get('name')
|
|
|
|
states = {}
|
|
c_entities = dict(scene_config.get(CONF_ENTITIES, {}))
|
|
|
|
for entity_id in c_entities:
|
|
if isinstance(c_entities[entity_id], dict):
|
|
entity_attrs = c_entities[entity_id].copy()
|
|
state = entity_attrs.pop('state', None)
|
|
attributes = entity_attrs
|
|
else:
|
|
state = c_entities[entity_id]
|
|
attributes = {}
|
|
|
|
# YAML translates 'on' to a boolean
|
|
# http://yaml.org/type/bool.html
|
|
if isinstance(state, bool):
|
|
state = STATE_ON if state else STATE_OFF
|
|
else:
|
|
state = str(state)
|
|
|
|
states[entity_id.lower()] = State(entity_id, state, attributes)
|
|
|
|
return SceneConfig(name, states)
|
|
|
|
|
|
class HomeAssistantScene(Scene):
|
|
"""A scene is a group of entities and the states we want them to be."""
|
|
|
|
def __init__(self, hass, scene_config):
|
|
"""Initialize the scene."""
|
|
self.hass = hass
|
|
self.scene_config = scene_config
|
|
|
|
@property
|
|
def name(self):
|
|
"""Return the name of the scene."""
|
|
return self.scene_config.name
|
|
|
|
@property
|
|
def device_state_attributes(self):
|
|
"""Return the scene state attributes."""
|
|
return {
|
|
ATTR_ENTITY_ID: list(self.scene_config.states.keys()),
|
|
}
|
|
|
|
def activate(self):
|
|
"""Activate scene. Try to get entities into requested state."""
|
|
reproduce_state(self.hass, self.scene_config.states.values(), True)
|