Reproduce states by letting each component opt in on handling state recovery itself (#18700)
* Move group to it's own setup * Let each component to handle restore of state * Move constants for climate into const.py For now import all into __init__.py to keep backword compat * Move media plyaer constants to const.py file For now import all constants into __init__.py to keep backword compatibility * Move media player to it's own file * Move climate to it's own file * Remove ecobee service from common components BREAKING CHANGE * Add tests for climate * Add test for media_player * Make sure we clone timestamps of state * Add tests for groups * Remove old tests for media player, it's handled by other tests * Add tests for calls to component functions * Add docstring for climate const * Add docstring for media_player const * Explicitly import constants in climate * Explicitly import constants in media_player * Add period to climate const * Add period to media_player const * Fix some lint errors in climate * Fix some lint errors in media_player * Fix lint warnings on climate tests * Fix lint warnings on group tests * Fix lint warnings on media_player tests * Fix lint warnings on state tests * Adjust indent for state tests
This commit is contained in:
1 parent
c76a61ad16
commit
3bb5caabe2
13 files changed
+846
-228
No files matched your search
@@ -10,41 +10,27 @@ from typing import ( # noqa: F401 pylint: disable=unused-import
|
||||
|
||||
from homeassistant.loader import bind_hass
|
||||
import homeassistant.util.dt as dt_util
|
||||
from homeassistant.components.media_player import (
|
||||
ATTR_MEDIA_CONTENT_ID, ATTR_MEDIA_CONTENT_TYPE, ATTR_MEDIA_SEEK_POSITION,
|
||||
ATTR_MEDIA_VOLUME_LEVEL, ATTR_MEDIA_VOLUME_MUTED, SERVICE_PLAY_MEDIA,
|
||||
SERVICE_SELECT_SOURCE, ATTR_INPUT_SOURCE)
|
||||
from homeassistant.components.notify import (
|
||||
ATTR_MESSAGE, SERVICE_NOTIFY)
|
||||
from homeassistant.components.sun import (
|
||||
STATE_ABOVE_HORIZON, STATE_BELOW_HORIZON)
|
||||
from homeassistant.components.mysensors.switch import (
|
||||
ATTR_IR_CODE, SERVICE_SEND_IR_CODE)
|
||||
from homeassistant.components.climate import (
|
||||
ATTR_AUX_HEAT, ATTR_AWAY_MODE, ATTR_FAN_MODE, ATTR_HOLD_MODE,
|
||||
ATTR_HUMIDITY, ATTR_OPERATION_MODE, ATTR_SWING_MODE,
|
||||
SERVICE_SET_AUX_HEAT, SERVICE_SET_AWAY_MODE, SERVICE_SET_HOLD_MODE,
|
||||
SERVICE_SET_FAN_MODE, SERVICE_SET_HUMIDITY, SERVICE_SET_OPERATION_MODE,
|
||||
SERVICE_SET_SWING_MODE, SERVICE_SET_TEMPERATURE, STATE_HEAT, STATE_COOL,
|
||||
STATE_IDLE)
|
||||
from homeassistant.components.ecobee.climate import (
|
||||
ATTR_FAN_MIN_ON_TIME, SERVICE_SET_FAN_MIN_ON_TIME,
|
||||
ATTR_RESUME_ALL, SERVICE_RESUME_PROGRAM)
|
||||
from homeassistant.components.cover import (
|
||||
ATTR_POSITION, ATTR_TILT_POSITION)
|
||||
from homeassistant.const import (
|
||||
ATTR_ENTITY_ID, ATTR_OPTION, ATTR_TEMPERATURE, SERVICE_ALARM_ARM_AWAY,
|
||||
ATTR_ENTITY_ID, ATTR_OPTION, SERVICE_ALARM_ARM_AWAY,
|
||||
SERVICE_ALARM_ARM_HOME, SERVICE_ALARM_DISARM, SERVICE_ALARM_TRIGGER,
|
||||
SERVICE_LOCK, SERVICE_MEDIA_PAUSE, SERVICE_MEDIA_PLAY, SERVICE_MEDIA_STOP,
|
||||
SERVICE_MEDIA_SEEK, SERVICE_TURN_OFF, SERVICE_TURN_ON, SERVICE_UNLOCK,
|
||||
SERVICE_VOLUME_MUTE, SERVICE_VOLUME_SET, SERVICE_OPEN_COVER,
|
||||
SERVICE_LOCK, SERVICE_TURN_OFF, SERVICE_TURN_ON, SERVICE_UNLOCK,
|
||||
SERVICE_OPEN_COVER,
|
||||
SERVICE_CLOSE_COVER, SERVICE_SET_COVER_POSITION,
|
||||
SERVICE_SET_COVER_TILT_POSITION, STATE_ALARM_ARMED_AWAY,
|
||||
STATE_ALARM_ARMED_HOME, STATE_ALARM_DISARMED, STATE_ALARM_TRIGGERED,
|
||||
STATE_CLOSED, STATE_HOME, STATE_LOCKED, STATE_NOT_HOME, STATE_OFF,
|
||||
STATE_ON, STATE_OPEN, STATE_PAUSED, STATE_PLAYING, STATE_UNKNOWN,
|
||||
STATE_ON, STATE_OPEN, STATE_UNKNOWN,
|
||||
STATE_UNLOCKED, SERVICE_SELECT_OPTION)
|
||||
from homeassistant.core import State, DOMAIN as HASS_DOMAIN
|
||||
from homeassistant.core import (
|
||||
Context, State, DOMAIN as HASS_DOMAIN)
|
||||
from homeassistant.util.async_ import run_coroutine_threadsafe
|
||||
from .typing import HomeAssistantType
|
||||
|
||||
@@ -55,22 +41,7 @@ GROUP_DOMAIN = 'group'
|
||||
# Update this dict of lists when new services are added to HA.
|
||||
# Each item is a service with a list of required attributes.
|
||||
SERVICE_ATTRIBUTES = {
|
||||
SERVICE_PLAY_MEDIA: [ATTR_MEDIA_CONTENT_TYPE, ATTR_MEDIA_CONTENT_ID],
|
||||
SERVICE_MEDIA_SEEK: [ATTR_MEDIA_SEEK_POSITION],
|
||||
SERVICE_VOLUME_MUTE: [ATTR_MEDIA_VOLUME_MUTED],
|
||||
SERVICE_VOLUME_SET: [ATTR_MEDIA_VOLUME_LEVEL],
|
||||
SERVICE_NOTIFY: [ATTR_MESSAGE],
|
||||
SERVICE_SET_AWAY_MODE: [ATTR_AWAY_MODE],
|
||||
SERVICE_SET_FAN_MODE: [ATTR_FAN_MODE],
|
||||
SERVICE_SET_FAN_MIN_ON_TIME: [ATTR_FAN_MIN_ON_TIME],
|
||||
SERVICE_RESUME_PROGRAM: [ATTR_RESUME_ALL],
|
||||
SERVICE_SET_TEMPERATURE: [ATTR_TEMPERATURE],
|
||||
SERVICE_SET_HUMIDITY: [ATTR_HUMIDITY],
|
||||
SERVICE_SET_SWING_MODE: [ATTR_SWING_MODE],
|
||||
SERVICE_SET_HOLD_MODE: [ATTR_HOLD_MODE],
|
||||
SERVICE_SET_OPERATION_MODE: [ATTR_OPERATION_MODE],
|
||||
SERVICE_SET_AUX_HEAT: [ATTR_AUX_HEAT],
|
||||
SERVICE_SELECT_SOURCE: [ATTR_INPUT_SOURCE],
|
||||
SERVICE_SEND_IR_CODE: [ATTR_IR_CODE],
|
||||
SERVICE_SELECT_OPTION: [ATTR_OPTION],
|
||||
SERVICE_SET_COVER_POSITION: [ATTR_POSITION],
|
||||
@@ -82,9 +53,6 @@ SERVICE_ATTRIBUTES = {
|
||||
SERVICE_TO_STATE = {
|
||||
SERVICE_TURN_ON: STATE_ON,
|
||||
SERVICE_TURN_OFF: STATE_OFF,
|
||||
SERVICE_MEDIA_PLAY: STATE_PLAYING,
|
||||
SERVICE_MEDIA_PAUSE: STATE_PAUSED,
|
||||
SERVICE_MEDIA_STOP: STATE_IDLE,
|
||||
SERVICE_ALARM_ARM_AWAY: STATE_ALARM_ARMED_AWAY,
|
||||
SERVICE_ALARM_ARM_HOME: STATE_ALARM_ARMED_HOME,
|
||||
SERVICE_ALARM_DISARM: STATE_ALARM_DISARMED,
|
||||
@@ -142,14 +110,56 @@ def reproduce_state(hass: HomeAssistantType,
|
||||
|
||||
|
||||
@bind_hass
|
||||
async def async_reproduce_state(hass: HomeAssistantType,
|
||||
states: Union[State, Iterable[State]],
|
||||
blocking: bool = False) -> None:
|
||||
"""Reproduce given state."""
|
||||
async def async_reproduce_state(
|
||||
hass: HomeAssistantType,
|
||||
states: Union[State, Iterable[State]],
|
||||
blocking: bool = False,
|
||||
context: Optional[Context] = None) -> None:
|
||||
"""Reproduce a list of states on multiple domains."""
|
||||
if isinstance(states, State):
|
||||
states = [states]
|
||||
|
||||
to_call = defaultdict(list) # type: Dict[Tuple[str, str, str], List[str]]
|
||||
to_call = defaultdict(list) # type: Dict[str, List[State]]
|
||||
|
||||
for state in states:
|
||||
to_call[state.domain].append(state)
|
||||
|
||||
async def worker(domain: str, data: List[State]) -> None:
|
||||
component = getattr(hass.components, domain)
|
||||
if hasattr(component, 'async_reproduce_states'):
|
||||
await component.async_reproduce_states(
|
||||
data,
|
||||
context=context)
|
||||
else:
|
||||
await async_reproduce_state_legacy(
|
||||
hass,
|
||||
domain,
|
||||
data,
|
||||
blocking=blocking,
|
||||
context=context)
|
||||
|
||||
if to_call:
|
||||
# run all domains in parallel
|
||||
await asyncio.gather(*[
|
||||
worker(domain, data)
|
||||
for domain, data in to_call.items()
|
||||
])
|
||||
|
||||
|
||||
@bind_hass
|
||||
async def async_reproduce_state_legacy(
|
||||
hass: HomeAssistantType,
|
||||
domain: str,
|
||||
states: Iterable[State],
|
||||
blocking: bool = False,
|
||||
context: Optional[Context] = None) -> None:
|
||||
"""Reproduce given state."""
|
||||
to_call = defaultdict(list) # type: Dict[Tuple[str, str], List[str]]
|
||||
|
||||
if domain == GROUP_DOMAIN:
|
||||
service_domain = HASS_DOMAIN
|
||||
else:
|
||||
service_domain = domain
|
||||
|
||||
for state in states:
|
||||
|
||||
@@ -158,11 +168,6 @@ async def async_reproduce_state(hass: HomeAssistantType,
|
||||
state.entity_id)
|
||||
continue
|
||||
|
||||
if state.domain == GROUP_DOMAIN:
|
||||
service_domain = HASS_DOMAIN
|
||||
else:
|
||||
service_domain = state.domain
|
||||
|
||||
domain_services = hass.services.async_services().get(service_domain)
|
||||
|
||||
if not domain_services:
|
||||
@@ -189,32 +194,22 @@ async def async_reproduce_state(hass: HomeAssistantType,
|
||||
|
||||
# We group service calls for entities by service call
|
||||
# json used to create a hashable version of dict with maybe lists in it
|
||||
key = (service_domain, service,
|
||||
key = (service,
|
||||
json.dumps(dict(state.attributes), sort_keys=True))
|
||||
to_call[key].append(state.entity_id)
|
||||
|
||||
domain_tasks = {} # type: Dict[str, List[Awaitable[Optional[bool]]]]
|
||||
for (service_domain, service, service_data), entity_ids in to_call.items():
|
||||
domain_tasks = [] # type: List[Awaitable[Optional[bool]]]
|
||||
for (service, service_data), entity_ids in to_call.items():
|
||||
data = json.loads(service_data)
|
||||
data[ATTR_ENTITY_ID] = entity_ids
|
||||
|
||||
if service_domain not in domain_tasks:
|
||||
domain_tasks[service_domain] = []
|
||||
|
||||
domain_tasks[service_domain].append(
|
||||
hass.services.async_call(service_domain, service, data, blocking)
|
||||
domain_tasks.append(
|
||||
hass.services.async_call(service_domain, service, data, blocking,
|
||||
context)
|
||||
)
|
||||
|
||||
async def async_handle_service_calls(
|
||||
coro_list: Iterable[Awaitable]) -> None:
|
||||
"""Handle service calls by domain sequence."""
|
||||
for coro in coro_list:
|
||||
await coro
|
||||
|
||||
execute_tasks = [async_handle_service_calls(coro_list)
|
||||
for coro_list in domain_tasks.values()]
|
||||
if execute_tasks:
|
||||
await asyncio.wait(execute_tasks, loop=hass.loop)
|
||||
if domain_tasks:
|
||||
await asyncio.wait(domain_tasks, loop=hass.loop)
|
||||
|
||||
|
||||
def state_as_number(state: State) -> float:
|
||||
@@ -223,6 +218,9 @@ def state_as_number(state: State) -> float:
|
||||
|
||||
Raises ValueError if this is not possible.
|
||||
"""
|
||||
from homeassistant.components.climate import (
|
||||
STATE_HEAT, STATE_COOL, STATE_IDLE)
|
||||
|
||||
if state.state in (STATE_ON, STATE_LOCKED, STATE_ABOVE_HORIZON,
|
||||
STATE_OPEN, STATE_HOME, STATE_HEAT, STATE_COOL):
|
||||
return 1
|
||||
|
||||
Reference in new issue
Block a user