Google Actions for Assistant (#9632)
* http: Add headers key to json[_message] * Add google_assistant component This component provides API endpoints for the Actions on Google Smart Home API to interact with Google Assistant. * google_assistant: Re-add fan support * google_assistant: Fix Scene handling - The way I originally wrote the MAPPING_COMPONENT and the way it's actual used changed so the comment was updated to match that. - Use const's in more places - Handle the ActivateScene command correctly * google_assistant: Fix flakey compare test Was failing on 3.4.2 and 3.5, this is more correct anyway. * google_assistant: Use volume attr for media_player
This commit is contained in:
parent
1d68777981
commit
9d20a53d63
9 changed files with 996 additions and 4 deletions
161
homeassistant/components/google_assistant/smart_home.py
Normal file
161
homeassistant/components/google_assistant/smart_home.py
Normal file
|
@ -0,0 +1,161 @@
|
|||
"""Support for Google Assistant Smart Home API."""
|
||||
import logging
|
||||
|
||||
# Typing imports
|
||||
# pylint: disable=using-constant-test,unused-import,ungrouped-imports
|
||||
# if False:
|
||||
from aiohttp.web import Request, Response # NOQA
|
||||
from typing import Dict, Tuple, Any # NOQA
|
||||
from homeassistant.helpers.entity import Entity # NOQA
|
||||
from homeassistant.core import HomeAssistant # NOQA
|
||||
|
||||
from homeassistant.const import (
|
||||
ATTR_SUPPORTED_FEATURES, ATTR_ENTITY_ID,
|
||||
CONF_FRIENDLY_NAME, STATE_OFF,
|
||||
SERVICE_TURN_OFF, SERVICE_TURN_ON
|
||||
)
|
||||
from homeassistant.components import (
|
||||
switch, light, cover, media_player, group, fan, scene
|
||||
)
|
||||
|
||||
from .const import (
|
||||
ATTR_GOOGLE_ASSISTANT_NAME,
|
||||
COMMAND_BRIGHTNESS, COMMAND_ONOFF, COMMAND_ACTIVATESCENE,
|
||||
TRAIT_ONOFF, TRAIT_BRIGHTNESS, TRAIT_COLOR_TEMP,
|
||||
TRAIT_RGB_COLOR, TRAIT_SCENE,
|
||||
TYPE_LIGHT, TYPE_SCENE, TYPE_SWITCH,
|
||||
CONF_ALIASES,
|
||||
)
|
||||
|
||||
_LOGGER = logging.getLogger(__name__)
|
||||
|
||||
# Mapping is [actions schema, primary trait, optional features]
|
||||
# optional is SUPPORT_* = (trait, command)
|
||||
MAPPING_COMPONENT = {
|
||||
group.DOMAIN: [TYPE_SCENE, TRAIT_SCENE, None],
|
||||
scene.DOMAIN: [TYPE_SCENE, TRAIT_SCENE, None],
|
||||
switch.DOMAIN: [TYPE_SWITCH, TRAIT_ONOFF, None],
|
||||
fan.DOMAIN: [TYPE_SWITCH, TRAIT_ONOFF, None],
|
||||
light.DOMAIN: [
|
||||
TYPE_LIGHT, TRAIT_ONOFF, {
|
||||
light.SUPPORT_BRIGHTNESS: TRAIT_BRIGHTNESS,
|
||||
light.SUPPORT_RGB_COLOR: TRAIT_RGB_COLOR,
|
||||
light.SUPPORT_COLOR_TEMP: TRAIT_COLOR_TEMP,
|
||||
}
|
||||
],
|
||||
cover.DOMAIN: [
|
||||
TYPE_LIGHT, TRAIT_ONOFF, {
|
||||
cover.SUPPORT_SET_POSITION: TRAIT_BRIGHTNESS
|
||||
}
|
||||
],
|
||||
media_player.DOMAIN: [
|
||||
TYPE_LIGHT, TRAIT_ONOFF, {
|
||||
media_player.SUPPORT_VOLUME_SET: TRAIT_BRIGHTNESS
|
||||
}
|
||||
],
|
||||
} # type: Dict[str, list]
|
||||
|
||||
|
||||
def make_actions_response(request_id: str, payload: dict) -> dict:
|
||||
"""Helper to simplify format for response."""
|
||||
return {'requestId': request_id, 'payload': payload}
|
||||
|
||||
|
||||
def entity_to_device(entity: Entity):
|
||||
"""Convert a hass entity into an google actions device."""
|
||||
class_data = MAPPING_COMPONENT.get(entity.domain)
|
||||
if class_data is None:
|
||||
return None
|
||||
|
||||
device = {
|
||||
'id': entity.entity_id,
|
||||
'name': {},
|
||||
'traits': [],
|
||||
'willReportState': False,
|
||||
}
|
||||
device['type'] = class_data[0]
|
||||
device['traits'].append(class_data[1])
|
||||
|
||||
# handle custom names
|
||||
device['name']['name'] = \
|
||||
entity.attributes.get(ATTR_GOOGLE_ASSISTANT_NAME) or \
|
||||
entity.attributes.get(CONF_FRIENDLY_NAME)
|
||||
|
||||
# use aliases
|
||||
aliases = entity.attributes.get(CONF_ALIASES)
|
||||
if isinstance(aliases, list):
|
||||
device['name']['nicknames'] = aliases
|
||||
else:
|
||||
_LOGGER.warning("%s must be a list", CONF_ALIASES)
|
||||
|
||||
# add trait if entity supports feature
|
||||
if class_data[2]:
|
||||
supported = entity.attributes.get(ATTR_SUPPORTED_FEATURES, 0)
|
||||
for feature, trait in class_data[2].items():
|
||||
if feature & supported > 0:
|
||||
device['traits'].append(trait)
|
||||
|
||||
return device
|
||||
|
||||
|
||||
def query_device(entity: Entity) -> dict:
|
||||
"""Take an entity and return a properly formatted device object."""
|
||||
final_state = entity.state != STATE_OFF
|
||||
final_brightness = entity.attributes.get(light.ATTR_BRIGHTNESS, 255
|
||||
if final_state else 0)
|
||||
|
||||
if entity.domain == media_player.DOMAIN:
|
||||
level = entity.attributes.get(media_player.ATTR_MEDIA_VOLUME_LEVEL, 1.0
|
||||
if final_state else 0.0)
|
||||
# Convert 0.0-1.0 to 0-255
|
||||
final_brightness = round(min(1.0, level) * 255)
|
||||
|
||||
if final_brightness is None:
|
||||
final_brightness = 255 if final_state else 0
|
||||
|
||||
final_brightness = 100 * (final_brightness / 255)
|
||||
|
||||
return {
|
||||
"on": final_state,
|
||||
"online": True,
|
||||
"brightness": int(final_brightness)
|
||||
}
|
||||
|
||||
|
||||
# erroneous bug on old pythons and pylint
|
||||
# https://github.com/PyCQA/pylint/issues/1212
|
||||
# pylint: disable=invalid-sequence-index
|
||||
def determine_service(entity_id: str, command: str,
|
||||
params: dict) -> Tuple[str, dict]:
|
||||
"""
|
||||
Determine service and service_data.
|
||||
|
||||
Attempt to return a tuple of service and service_data based on the entity
|
||||
and action requested.
|
||||
"""
|
||||
domain = entity_id.split('.')[0]
|
||||
service_data = {ATTR_ENTITY_ID: entity_id} # type: Dict[str, Any]
|
||||
# special media_player handling
|
||||
if domain == media_player.DOMAIN and command == COMMAND_BRIGHTNESS:
|
||||
brightness = params.get('brightness', 0)
|
||||
service_data[media_player.ATTR_MEDIA_VOLUME_LEVEL] = brightness / 100
|
||||
return (media_player.SERVICE_VOLUME_SET, service_data)
|
||||
|
||||
# special cover handling
|
||||
if domain == cover.DOMAIN:
|
||||
if command == COMMAND_BRIGHTNESS:
|
||||
service_data['position'] = params.get('brightness', 0)
|
||||
return (cover.SERVICE_SET_COVER_POSITION, service_data)
|
||||
if command == COMMAND_ONOFF and params.get('on') is True:
|
||||
return (cover.SERVICE_OPEN_COVER, service_data)
|
||||
return (cover.SERVICE_CLOSE_COVER, service_data)
|
||||
|
||||
if command == COMMAND_BRIGHTNESS:
|
||||
brightness = params.get('brightness')
|
||||
service_data['brightness'] = int(brightness / 100 * 255)
|
||||
return (SERVICE_TURN_ON, service_data)
|
||||
|
||||
if command == COMMAND_ACTIVATESCENE or (COMMAND_ONOFF == command and
|
||||
params.get('on') is True):
|
||||
return (SERVICE_TURN_ON, service_data)
|
||||
return (SERVICE_TURN_OFF, service_data)
|
Loading…
Add table
Add a link
Reference in a new issue