Home Assistant Unofficial Reference 2024.12.1
Namespaces | Classes | Functions | Variables
homeassistant.components.cover Namespace Reference

Namespaces

 const
 
 device_action
 
 device_condition
 
 device_trigger
 
 intent
 
 reproduce_state
 
 significant_change
 

Classes

class  CoverDeviceClass
 
class  CoverEntity
 
class  CoverEntityDescription
 
class  CoverEntityFeature
 
class  CoverState
 

Functions

bool async_setup (HomeAssistant hass, ConfigType config)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 
bool is_closed (HomeAssistant hass, str entity_id)
 

Variables

 __all__
 
 __dir__
 
 __getattr__
 
 _DEPRECATED_DEVICE_CLASS_AWNING
 
 _DEPRECATED_DEVICE_CLASS_BLIND
 
 _DEPRECATED_DEVICE_CLASS_CURTAIN
 
 _DEPRECATED_DEVICE_CLASS_DAMPER
 
 _DEPRECATED_DEVICE_CLASS_DOOR
 
 _DEPRECATED_DEVICE_CLASS_GARAGE
 
 _DEPRECATED_DEVICE_CLASS_GATE
 
 _DEPRECATED_DEVICE_CLASS_SHADE
 
 _DEPRECATED_DEVICE_CLASS_SHUTTER
 
 _DEPRECATED_DEVICE_CLASS_WINDOW
 
 _DEPRECATED_STATE_CLOSED
 
 _DEPRECATED_STATE_CLOSING
 
 _DEPRECATED_STATE_OPEN
 
 _DEPRECATED_STATE_OPENING
 
 _DEPRECATED_SUPPORT_CLOSE
 
 _DEPRECATED_SUPPORT_CLOSE_TILT
 
 _DEPRECATED_SUPPORT_OPEN
 
 _DEPRECATED_SUPPORT_OPEN_TILT
 
 _DEPRECATED_SUPPORT_SET_POSITION
 
 _DEPRECATED_SUPPORT_SET_TILT_POSITION
 
 _DEPRECATED_SUPPORT_STOP
 
 _DEPRECATED_SUPPORT_STOP_TILT
 
 _LOGGER
 
 ATTR_CURRENT_POSITION
 
 ATTR_CURRENT_TILT_POSITION
 
 ATTR_POSITION
 
 ATTR_TILT_POSITION
 
 CACHED_PROPERTIES_WITH_ATTR_
 
 check_if_deprecated_constant
 
 DEVICE_CLASSES
 
 DEVICE_CLASSES_SCHEMA
 
 dir_with_deprecated_constants
 
 ENTITY_ID_FORMAT
 
 module_globals
 
 module_globals_keys
 
 PLATFORM_SCHEMA
 
 PLATFORM_SCHEMA_BASE
 
 SCAN_INTERVAL
 
 seconds
 

Detailed Description

Support for Cover devices.

Function Documentation

◆ async_setup()

bool homeassistant.components.cover.async_setup ( HomeAssistant  hass,
ConfigType  config 
) 
Track states and offer events for covers.

Definition at line 172 of file __init__.py.

◆ async_setup_entry()

bool homeassistant.components.cover.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Set up a config entry.

Definition at line 252 of file __init__.py.

◆ async_unload_entry()

bool homeassistant.components.cover.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
) 
Unload a config entry.

Definition at line 257 of file __init__.py.

◆ is_closed()

bool homeassistant.components.cover.is_closed ( HomeAssistant  hass,
str  entity_id 
) 
Return if the cover is closed based on the statemachine.

Definition at line 167 of file __init__.py.

Variable Documentation

◆ __all__

homeassistant.components.cover.__all__
private

Definition at line 526 of file __init__.py.

◆ __dir__

homeassistant.components.cover.__dir__
private

Definition at line 523 of file __init__.py.

◆ __getattr__

homeassistant.components.cover.__getattr__
private

Definition at line 522 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_AWNING

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_AWNING
private

Definition at line 96 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_BLIND

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_BLIND
private

Definition at line 99 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_CURTAIN

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_CURTAIN
private

Definition at line 102 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_DAMPER

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_DAMPER
private

Definition at line 105 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_DOOR

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_DOOR
private

Definition at line 108 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_GARAGE

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_GARAGE
private

Definition at line 109 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_GATE

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_GATE
private

Definition at line 112 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_SHADE

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_SHADE
private

Definition at line 113 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_SHUTTER

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_SHUTTER
private

Definition at line 116 of file __init__.py.

◆ _DEPRECATED_DEVICE_CLASS_WINDOW

homeassistant.components.cover._DEPRECATED_DEVICE_CLASS_WINDOW
private

Definition at line 119 of file __init__.py.

◆ _DEPRECATED_STATE_CLOSED

homeassistant.components.cover._DEPRECATED_STATE_CLOSED
private

Definition at line 69 of file __init__.py.

◆ _DEPRECATED_STATE_CLOSING

homeassistant.components.cover._DEPRECATED_STATE_CLOSING
private

Definition at line 70 of file __init__.py.

◆ _DEPRECATED_STATE_OPEN

homeassistant.components.cover._DEPRECATED_STATE_OPEN
private

Definition at line 71 of file __init__.py.

◆ _DEPRECATED_STATE_OPENING

homeassistant.components.cover._DEPRECATED_STATE_OPENING
private

Definition at line 72 of file __init__.py.

◆ _DEPRECATED_SUPPORT_CLOSE

homeassistant.components.cover._DEPRECATED_SUPPORT_CLOSE
private

Definition at line 142 of file __init__.py.

◆ _DEPRECATED_SUPPORT_CLOSE_TILT

homeassistant.components.cover._DEPRECATED_SUPPORT_CLOSE_TILT
private

Definition at line 150 of file __init__.py.

◆ _DEPRECATED_SUPPORT_OPEN

homeassistant.components.cover._DEPRECATED_SUPPORT_OPEN
private

Definition at line 141 of file __init__.py.

◆ _DEPRECATED_SUPPORT_OPEN_TILT

homeassistant.components.cover._DEPRECATED_SUPPORT_OPEN_TILT
private

Definition at line 147 of file __init__.py.

◆ _DEPRECATED_SUPPORT_SET_POSITION

homeassistant.components.cover._DEPRECATED_SUPPORT_SET_POSITION
private

Definition at line 143 of file __init__.py.

◆ _DEPRECATED_SUPPORT_SET_TILT_POSITION

homeassistant.components.cover._DEPRECATED_SUPPORT_SET_TILT_POSITION
private

Definition at line 156 of file __init__.py.

◆ _DEPRECATED_SUPPORT_STOP

homeassistant.components.cover._DEPRECATED_SUPPORT_STOP
private

Definition at line 146 of file __init__.py.

◆ _DEPRECATED_SUPPORT_STOP_TILT

homeassistant.components.cover._DEPRECATED_SUPPORT_STOP_TILT
private

Definition at line 153 of file __init__.py.

◆ _LOGGER

homeassistant.components.cover._LOGGER
private

Definition at line 48 of file __init__.py.

◆ ATTR_CURRENT_POSITION

homeassistant.components.cover.ATTR_CURRENT_POSITION

Definition at line 160 of file __init__.py.

◆ ATTR_CURRENT_TILT_POSITION

homeassistant.components.cover.ATTR_CURRENT_TILT_POSITION

Definition at line 161 of file __init__.py.

◆ ATTR_POSITION

homeassistant.components.cover.ATTR_POSITION

Definition at line 162 of file __init__.py.

◆ ATTR_TILT_POSITION

homeassistant.components.cover.ATTR_TILT_POSITION

Definition at line 163 of file __init__.py.

◆ CACHED_PROPERTIES_WITH_ATTR_

homeassistant.components.cover.CACHED_PROPERTIES_WITH_ATTR_

Definition at line 268 of file __init__.py.

◆ check_if_deprecated_constant

homeassistant.components.cover.check_if_deprecated_constant

Definition at line 522 of file __init__.py.

◆ DEVICE_CLASSES

homeassistant.components.cover.DEVICE_CLASSES

Definition at line 95 of file __init__.py.

◆ DEVICE_CLASSES_SCHEMA

homeassistant.components.cover.DEVICE_CLASSES_SCHEMA

Definition at line 91 of file __init__.py.

◆ dir_with_deprecated_constants

homeassistant.components.cover.dir_with_deprecated_constants

Definition at line 524 of file __init__.py.

◆ ENTITY_ID_FORMAT

homeassistant.components.cover.ENTITY_ID_FORMAT

Definition at line 51 of file __init__.py.

◆ module_globals

homeassistant.components.cover.module_globals

Definition at line 522 of file __init__.py.

◆ module_globals_keys

homeassistant.components.cover.module_globals_keys

Definition at line 524 of file __init__.py.

◆ PLATFORM_SCHEMA

homeassistant.components.cover.PLATFORM_SCHEMA

Definition at line 52 of file __init__.py.

◆ PLATFORM_SCHEMA_BASE

homeassistant.components.cover.PLATFORM_SCHEMA_BASE

Definition at line 53 of file __init__.py.

◆ SCAN_INTERVAL

homeassistant.components.cover.SCAN_INTERVAL

Definition at line 54 of file __init__.py.

◆ seconds

homeassistant.components.cover.seconds

Definition at line 54 of file __init__.py.