0ed9e185b2
* Add support for learning new commands This update creates a generic service in the 'remote' component to enable remote control platforms to learn new commands. * Update __init__.py with the proposed changes - Add 'supported_features' property and a constant related to the 'learn_command' functionality. - Redefine 'async_learn_command' function as a coroutine. * Update __init__.py * Fix assertion error Adding the 'supported_features' attribute generated an assertion error on the 'Demo Remote' platform. This update fixes this. * Fix duplicated 'hass' object This update fixes a typo that occurred at the last update.
146 lines
4.3 KiB
Python
146 lines
4.3 KiB
Python
"""Support to interface with universal remote control devices."""
|
|
from datetime import timedelta
|
|
import functools as ft
|
|
import logging
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.loader import bind_hass
|
|
from homeassistant.helpers.entity_component import EntityComponent
|
|
from homeassistant.helpers.entity import ToggleEntity
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.const import (
|
|
STATE_ON, SERVICE_TURN_ON, SERVICE_TURN_OFF, SERVICE_TOGGLE,
|
|
ATTR_ENTITY_ID)
|
|
from homeassistant.components import group
|
|
from homeassistant.helpers.config_validation import ( # noqa
|
|
PLATFORM_SCHEMA, PLATFORM_SCHEMA_BASE)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
ATTR_ACTIVITY = 'activity'
|
|
ATTR_COMMAND = 'command'
|
|
ATTR_DEVICE = 'device'
|
|
ATTR_NUM_REPEATS = 'num_repeats'
|
|
ATTR_DELAY_SECS = 'delay_secs'
|
|
ATTR_HOLD_SECS = 'hold_secs'
|
|
ATTR_ALTERNATIVE = 'alternative'
|
|
ATTR_TIMEOUT = 'timeout'
|
|
|
|
DOMAIN = 'remote'
|
|
SCAN_INTERVAL = timedelta(seconds=30)
|
|
|
|
ENTITY_ID_ALL_REMOTES = group.ENTITY_ID_FORMAT.format('all_remotes')
|
|
ENTITY_ID_FORMAT = DOMAIN + '.{}'
|
|
|
|
GROUP_NAME_ALL_REMOTES = 'all remotes'
|
|
|
|
MIN_TIME_BETWEEN_SCANS = timedelta(seconds=10)
|
|
|
|
SERVICE_SEND_COMMAND = 'send_command'
|
|
SERVICE_LEARN_COMMAND = 'learn_command'
|
|
SERVICE_SYNC = 'sync'
|
|
|
|
DEFAULT_NUM_REPEATS = 1
|
|
DEFAULT_DELAY_SECS = 0.4
|
|
DEFAULT_HOLD_SECS = 0
|
|
|
|
SUPPORT_LEARN_COMMAND = 1
|
|
|
|
REMOTE_SERVICE_SCHEMA = vol.Schema({
|
|
vol.Optional(ATTR_ENTITY_ID): cv.comp_entity_ids,
|
|
})
|
|
|
|
REMOTE_SERVICE_ACTIVITY_SCHEMA = REMOTE_SERVICE_SCHEMA.extend({
|
|
vol.Optional(ATTR_ACTIVITY): cv.string
|
|
})
|
|
|
|
REMOTE_SERVICE_SEND_COMMAND_SCHEMA = REMOTE_SERVICE_SCHEMA.extend({
|
|
vol.Required(ATTR_COMMAND): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(ATTR_DEVICE): cv.string,
|
|
vol.Optional(
|
|
ATTR_NUM_REPEATS, default=DEFAULT_NUM_REPEATS): cv.positive_int,
|
|
vol.Optional(ATTR_DELAY_SECS): vol.Coerce(float),
|
|
vol.Optional(ATTR_HOLD_SECS, default=DEFAULT_HOLD_SECS): vol.Coerce(float),
|
|
})
|
|
|
|
REMOTE_SERVICE_LEARN_COMMAND_SCHEMA = REMOTE_SERVICE_SCHEMA.extend({
|
|
vol.Optional(ATTR_DEVICE): cv.string,
|
|
vol.Optional(ATTR_COMMAND): vol.All(cv.ensure_list, [cv.string]),
|
|
vol.Optional(ATTR_ALTERNATIVE): cv.boolean,
|
|
vol.Optional(ATTR_TIMEOUT): cv.positive_int
|
|
})
|
|
|
|
|
|
@bind_hass
|
|
def is_on(hass, entity_id=None):
|
|
"""Return if the remote is on based on the statemachine."""
|
|
entity_id = entity_id or ENTITY_ID_ALL_REMOTES
|
|
return hass.states.is_state(entity_id, STATE_ON)
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Track states and offer events for remotes."""
|
|
component = EntityComponent(
|
|
_LOGGER, DOMAIN, hass, SCAN_INTERVAL, GROUP_NAME_ALL_REMOTES)
|
|
await component.async_setup(config)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_TURN_OFF, REMOTE_SERVICE_ACTIVITY_SCHEMA,
|
|
'async_turn_off'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_TURN_ON, REMOTE_SERVICE_ACTIVITY_SCHEMA,
|
|
'async_turn_on'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_TOGGLE, REMOTE_SERVICE_ACTIVITY_SCHEMA,
|
|
'async_toggle'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_SEND_COMMAND, REMOTE_SERVICE_SEND_COMMAND_SCHEMA,
|
|
'async_send_command'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_LEARN_COMMAND, REMOTE_SERVICE_LEARN_COMMAND_SCHEMA,
|
|
'async_learn_command'
|
|
)
|
|
|
|
return True
|
|
|
|
|
|
class RemoteDevice(ToggleEntity):
|
|
"""Representation of a remote."""
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Flag supported features."""
|
|
return 0
|
|
|
|
def send_command(self, command, **kwargs):
|
|
"""Send a command to a device."""
|
|
raise NotImplementedError()
|
|
|
|
def async_send_command(self, command, **kwargs):
|
|
"""Send a command to a device.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_executor_job(
|
|
ft.partial(self.send_command, command, **kwargs))
|
|
|
|
def learn_command(self, **kwargs):
|
|
"""Learn a command from a device."""
|
|
raise NotImplementedError()
|
|
|
|
def async_learn_command(self, **kwargs):
|
|
"""Learn a command from a device.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_executor_job(
|
|
ft.partial(self.learn_command, **kwargs))
|