322 lines
9.2 KiB
Python
322 lines
9.2 KiB
Python
"""
|
|
Support for Cover devices.
|
|
|
|
For more details about this platform, please refer to the documentation at
|
|
https://home-assistant.io/components/cover/
|
|
"""
|
|
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 Entity
|
|
from homeassistant.helpers.config_validation import PLATFORM_SCHEMA # noqa
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.components import group
|
|
from homeassistant.helpers import intent
|
|
from homeassistant.const import (
|
|
SERVICE_OPEN_COVER, SERVICE_CLOSE_COVER, SERVICE_SET_COVER_POSITION,
|
|
SERVICE_STOP_COVER, SERVICE_OPEN_COVER_TILT, SERVICE_CLOSE_COVER_TILT,
|
|
SERVICE_STOP_COVER_TILT, SERVICE_SET_COVER_TILT_POSITION, STATE_OPEN,
|
|
STATE_CLOSED, STATE_UNKNOWN, STATE_OPENING, STATE_CLOSING, ATTR_ENTITY_ID)
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
DOMAIN = 'cover'
|
|
DEPENDENCIES = ['group']
|
|
SCAN_INTERVAL = timedelta(seconds=15)
|
|
|
|
GROUP_NAME_ALL_COVERS = 'all covers'
|
|
ENTITY_ID_ALL_COVERS = group.ENTITY_ID_FORMAT.format('all_covers')
|
|
|
|
ENTITY_ID_FORMAT = DOMAIN + '.{}'
|
|
|
|
DEVICE_CLASSES = [
|
|
'damper',
|
|
'garage', # Garage door control
|
|
'window', # Window control
|
|
]
|
|
|
|
DEVICE_CLASSES_SCHEMA = vol.All(vol.Lower, vol.In(DEVICE_CLASSES))
|
|
|
|
SUPPORT_OPEN = 1
|
|
SUPPORT_CLOSE = 2
|
|
SUPPORT_SET_POSITION = 4
|
|
SUPPORT_STOP = 8
|
|
SUPPORT_OPEN_TILT = 16
|
|
SUPPORT_CLOSE_TILT = 32
|
|
SUPPORT_STOP_TILT = 64
|
|
SUPPORT_SET_TILT_POSITION = 128
|
|
|
|
ATTR_CURRENT_POSITION = 'current_position'
|
|
ATTR_CURRENT_TILT_POSITION = 'current_tilt_position'
|
|
ATTR_POSITION = 'position'
|
|
ATTR_TILT_POSITION = 'tilt_position'
|
|
|
|
INTENT_OPEN_COVER = 'HassOpenCover'
|
|
INTENT_CLOSE_COVER = 'HassCloseCover'
|
|
|
|
COVER_SERVICE_SCHEMA = vol.Schema({
|
|
vol.Optional(ATTR_ENTITY_ID): cv.entity_ids,
|
|
})
|
|
|
|
COVER_SET_COVER_POSITION_SCHEMA = COVER_SERVICE_SCHEMA.extend({
|
|
vol.Required(ATTR_POSITION):
|
|
vol.All(vol.Coerce(int), vol.Range(min=0, max=100)),
|
|
})
|
|
|
|
COVER_SET_COVER_TILT_POSITION_SCHEMA = COVER_SERVICE_SCHEMA.extend({
|
|
vol.Required(ATTR_TILT_POSITION):
|
|
vol.All(vol.Coerce(int), vol.Range(min=0, max=100)),
|
|
})
|
|
|
|
|
|
@bind_hass
|
|
def is_closed(hass, entity_id=None):
|
|
"""Return if the cover is closed based on the statemachine."""
|
|
entity_id = entity_id or ENTITY_ID_ALL_COVERS
|
|
return hass.states.is_state(entity_id, STATE_CLOSED)
|
|
|
|
|
|
async def async_setup(hass, config):
|
|
"""Track states and offer events for covers."""
|
|
component = hass.data[DOMAIN] = EntityComponent(
|
|
_LOGGER, DOMAIN, hass, SCAN_INTERVAL, GROUP_NAME_ALL_COVERS)
|
|
|
|
await component.async_setup(config)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_OPEN_COVER, COVER_SERVICE_SCHEMA,
|
|
'async_open_cover'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_CLOSE_COVER, COVER_SERVICE_SCHEMA,
|
|
'async_close_cover'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_SET_COVER_POSITION, COVER_SET_COVER_POSITION_SCHEMA,
|
|
'async_set_cover_position'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_STOP_COVER, COVER_SERVICE_SCHEMA,
|
|
'async_stop_cover'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_OPEN_COVER_TILT, COVER_SERVICE_SCHEMA,
|
|
'async_open_cover_tilt'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_CLOSE_COVER_TILT, COVER_SERVICE_SCHEMA,
|
|
'async_close_cover_tilt'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_STOP_COVER_TILT, COVER_SERVICE_SCHEMA,
|
|
'async_stop_cover_tilt'
|
|
)
|
|
|
|
component.async_register_entity_service(
|
|
SERVICE_SET_COVER_TILT_POSITION, COVER_SET_COVER_TILT_POSITION_SCHEMA,
|
|
'async_set_cover_tilt_position'
|
|
)
|
|
|
|
hass.helpers.intent.async_register(intent.ServiceIntentHandler(
|
|
INTENT_OPEN_COVER, DOMAIN, SERVICE_OPEN_COVER,
|
|
"Opened {}"))
|
|
hass.helpers.intent.async_register(intent.ServiceIntentHandler(
|
|
INTENT_CLOSE_COVER, DOMAIN, SERVICE_CLOSE_COVER,
|
|
"Closed {}"))
|
|
|
|
return True
|
|
|
|
|
|
async def async_setup_entry(hass, entry):
|
|
"""Set up a config entry."""
|
|
return await hass.data[DOMAIN].async_setup_entry(entry)
|
|
|
|
|
|
async def async_unload_entry(hass, entry):
|
|
"""Unload a config entry."""
|
|
return await hass.data[DOMAIN].async_unload_entry(entry)
|
|
|
|
|
|
class CoverDevice(Entity):
|
|
"""Representation a cover."""
|
|
|
|
@property
|
|
def current_cover_position(self):
|
|
"""Return current position of cover.
|
|
|
|
None is unknown, 0 is closed, 100 is fully open.
|
|
"""
|
|
pass
|
|
|
|
@property
|
|
def current_cover_tilt_position(self):
|
|
"""Return current position of cover tilt.
|
|
|
|
None is unknown, 0 is closed, 100 is fully open.
|
|
"""
|
|
pass
|
|
|
|
@property
|
|
def state(self):
|
|
"""Return the state of the cover."""
|
|
if self.is_opening:
|
|
return STATE_OPENING
|
|
if self.is_closing:
|
|
return STATE_CLOSING
|
|
|
|
closed = self.is_closed
|
|
|
|
if closed is None:
|
|
return STATE_UNKNOWN
|
|
|
|
return STATE_CLOSED if closed else STATE_OPEN
|
|
|
|
@property
|
|
def state_attributes(self):
|
|
"""Return the state attributes."""
|
|
data = {}
|
|
|
|
current = self.current_cover_position
|
|
if current is not None:
|
|
data[ATTR_CURRENT_POSITION] = self.current_cover_position
|
|
|
|
current_tilt = self.current_cover_tilt_position
|
|
if current_tilt is not None:
|
|
data[ATTR_CURRENT_TILT_POSITION] = self.current_cover_tilt_position
|
|
|
|
return data
|
|
|
|
@property
|
|
def supported_features(self):
|
|
"""Flag supported features."""
|
|
supported_features = SUPPORT_OPEN | SUPPORT_CLOSE | SUPPORT_STOP
|
|
|
|
if self.current_cover_position is not None:
|
|
supported_features |= SUPPORT_SET_POSITION
|
|
|
|
if self.current_cover_tilt_position is not None:
|
|
supported_features |= (
|
|
SUPPORT_OPEN_TILT | SUPPORT_CLOSE_TILT | SUPPORT_STOP_TILT |
|
|
SUPPORT_SET_TILT_POSITION)
|
|
|
|
return supported_features
|
|
|
|
@property
|
|
def is_opening(self):
|
|
"""Return if the cover is opening or not."""
|
|
pass
|
|
|
|
@property
|
|
def is_closing(self):
|
|
"""Return if the cover is closing or not."""
|
|
pass
|
|
|
|
@property
|
|
def is_closed(self):
|
|
"""Return if the cover is closed or not."""
|
|
raise NotImplementedError()
|
|
|
|
def open_cover(self, **kwargs):
|
|
"""Open the cover."""
|
|
raise NotImplementedError()
|
|
|
|
def async_open_cover(self, **kwargs):
|
|
"""Open the cover.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(ft.partial(self.open_cover, **kwargs))
|
|
|
|
def close_cover(self, **kwargs):
|
|
"""Close cover."""
|
|
raise NotImplementedError()
|
|
|
|
def async_close_cover(self, **kwargs):
|
|
"""Close cover.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(ft.partial(self.close_cover, **kwargs))
|
|
|
|
def set_cover_position(self, **kwargs):
|
|
"""Move the cover to a specific position."""
|
|
pass
|
|
|
|
def async_set_cover_position(self, **kwargs):
|
|
"""Move the cover to a specific position.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(
|
|
ft.partial(self.set_cover_position, **kwargs))
|
|
|
|
def stop_cover(self, **kwargs):
|
|
"""Stop the cover."""
|
|
pass
|
|
|
|
def async_stop_cover(self, **kwargs):
|
|
"""Stop the cover.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(ft.partial(self.stop_cover, **kwargs))
|
|
|
|
def open_cover_tilt(self, **kwargs):
|
|
"""Open the cover tilt."""
|
|
pass
|
|
|
|
def async_open_cover_tilt(self, **kwargs):
|
|
"""Open the cover tilt.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(
|
|
ft.partial(self.open_cover_tilt, **kwargs))
|
|
|
|
def close_cover_tilt(self, **kwargs):
|
|
"""Close the cover tilt."""
|
|
pass
|
|
|
|
def async_close_cover_tilt(self, **kwargs):
|
|
"""Close the cover tilt.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(
|
|
ft.partial(self.close_cover_tilt, **kwargs))
|
|
|
|
def set_cover_tilt_position(self, **kwargs):
|
|
"""Move the cover tilt to a specific position."""
|
|
pass
|
|
|
|
def async_set_cover_tilt_position(self, **kwargs):
|
|
"""Move the cover tilt to a specific position.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(
|
|
ft.partial(self.set_cover_tilt_position, **kwargs))
|
|
|
|
def stop_cover_tilt(self, **kwargs):
|
|
"""Stop the cover."""
|
|
pass
|
|
|
|
def async_stop_cover_tilt(self, **kwargs):
|
|
"""Stop the cover.
|
|
|
|
This method must be run in the event loop and returns a coroutine.
|
|
"""
|
|
return self.hass.async_add_job(
|
|
ft.partial(self.stop_cover_tilt, **kwargs))
|