Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.homekit_controller.cover.HomeKitWindowCover Class Reference
Inheritance diagram for homeassistant.components.homekit_controller.cover.HomeKitWindowCover:
[legend]
Collaboration diagram for homeassistant.components.homekit_controller.cover.HomeKitWindowCover:
[legend]

Public Member Functions

None async_close_cover (self, **Any kwargs)
 
None async_open_cover (self, **Any kwargs)
 
None async_set_cover_position (self, **Any kwargs)
 
None async_set_cover_tilt_position (self, **Any kwargs)
 
None async_stop_cover (self, **Any kwargs)
 
int current_cover_position (self)
 
int|None current_cover_tilt_position (self)
 
dict[str, Any] extra_state_attributes (self)
 
list[strget_characteristic_types (self)
 
bool is_closed (self)
 
bool is_closing (self)
 
bool is_horizontal_tilt (self)
 
bool is_opening (self)
 
bool is_vertical_tilt (self)
 
CoverEntityFeature supported_features (self)
 
- Public Member Functions inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
None __init__ (self, HKDevice accessory, ConfigType devinfo)
 
None async_added_to_hass (self)
 
None async_put_characteristics (self, dict[str, Any] characteristics)
 
None async_setup (self)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
bool available (self)
 
str|None default_name (self)
 
DeviceInfo device_info (self)
 
str|None name (self)
 
str old_unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.Entity
None __init_subclass__ (cls, **Any kwargs)
 
str __repr__ (self)
 
None add_to_platform_abort (self)
 
None add_to_platform_finish (self)
 
None add_to_platform_start (self, HomeAssistant hass, EntityPlatform platform, asyncio.Semaphore|None parallel_updates)
 
bool assumed_state (self)
 
None async_device_update (self, bool warning=True)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
None async_on_remove (self, CALLBACK_TYPE func)
 
None async_registry_entry_updated (self)
 
None async_remove (self, *bool force_remove=False)
 
None async_removed_from_registry (self)
 
None async_schedule_update_ha_state (self, bool force_refresh=False)
 
None async_set_context (self, Context context)
 
None async_update_ha_state (self, bool force_refresh=False)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
dict[str, Any]|None capability_attributes (self)
 
bool enabled (self)
 
EntityCategory|None entity_category (self)
 
str|None entity_picture (self)
 
bool entity_registry_enabled_default (self)
 
bool entity_registry_visible_default (self)
 
bool force_update (self)
 
HassJobType get_hassjob_type (self, str function_name)
 
er.EntityOptionsType|None get_initial_entity_options (self)
 
bool has_entity_name (self)
 
str|None icon (self)
 
None schedule_update_ha_state (self, bool force_refresh=False)
 
bool should_poll (self)
 
str|None suggested_object_id (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (self)
 
str|None unique_id (self)
 
str|None unit_of_measurement (self)
 
bool use_device_name (self)
 
- Public Member Functions inherited from homeassistant.helpers.entity.CachedProperties
None __init__ (cls, str name, tuple[type,...] bases, dict[Any, Any] namespace, **Any kwargs)
 
Any __new__ (mcs, str name, tuple[type,...] bases, dict[Any, Any] namespace, set[str]|None cached_properties=None, **Any kwargs)
 
- Public Member Functions inherited from homeassistant.components.cover.CoverEntity
None async_close_cover_tilt (self, **Any kwargs)
 
None async_open_cover_tilt (self, **Any kwargs)
 
None async_stop_cover_tilt (self, **Any kwargs)
 
None async_toggle (self, **Any kwargs)
 
None async_toggle_tilt (self, **Any kwargs)
 
None close_cover (self, **Any kwargs)
 
None close_cover_tilt (self, **Any kwargs)
 
CoverDeviceClass|None device_class (self)
 
None open_cover (self, **Any kwargs)
 
None open_cover_tilt (self, **Any kwargs)
 
None set_cover_position (self, **Any kwargs)
 
None set_cover_tilt_position (self, **Any kwargs)
 
str|None state (self)
 
dict[str, Any] state_attributes (self)
 
None stop_cover (self, **Any kwargs)
 
None stop_cover_tilt (self, **Any kwargs)
 
None toggle (self, **Any kwargs)
 
None toggle_tilt (self, **Any kwargs)
 

Public Attributes

 current_cover_position
 
- Public Attributes inherited from homeassistant.components.homekit_controller.entity.HomeKitEntity
 accessory
 
 accessory_info
 
 all_characteristics
 
 all_iids
 
 pollable_characteristics
 
 service
 
 watchable_characteristics
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Public Attributes inherited from homeassistant.components.cover.CoverEntity
 current_cover_position
 
 current_cover_tilt_position
 

Private Member Functions

None _async_reconfigure (self)
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 
- Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
 None
 

Detailed Description

Representation of a HomeKit Window or Window Covering.

Definition at line 133 of file cover.py.

Member Function Documentation

◆ _async_reconfigure()

None homeassistant.components.homekit_controller.cover.HomeKitWindowCover._async_reconfigure (   self)
private
Reconfigure entity.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 137 of file cover.py.

◆ async_close_cover()

None homeassistant.components.homekit_controller.cover.HomeKitWindowCover.async_close_cover (   self,
**Any  kwargs 
)
Send close command.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 255 of file cover.py.

◆ async_open_cover()

None homeassistant.components.homekit_controller.cover.HomeKitWindowCover.async_open_cover (   self,
**Any  kwargs 
)
Send open command.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 251 of file cover.py.

◆ async_set_cover_position()

None homeassistant.components.homekit_controller.cover.HomeKitWindowCover.async_set_cover_position (   self,
**Any  kwargs 
)
Send position command.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 259 of file cover.py.

◆ async_set_cover_tilt_position()

None homeassistant.components.homekit_controller.cover.HomeKitWindowCover.async_set_cover_tilt_position (   self,
**Any  kwargs 
)
Move the cover tilt to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 266 of file cover.py.

◆ async_stop_cover()

None homeassistant.components.homekit_controller.cover.HomeKitWindowCover.async_stop_cover (   self,
**Any  kwargs 
)
Send hold command.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 247 of file cover.py.

◆ current_cover_position()

int homeassistant.components.homekit_controller.cover.HomeKitWindowCover.current_cover_position (   self)
Return the current position of cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 180 of file cover.py.

◆ current_cover_tilt_position()

int | None homeassistant.components.homekit_controller.cover.HomeKitWindowCover.current_cover_tilt_position (   self)
Return current position of cover tilt.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 218 of file cover.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.homekit_controller.cover.HomeKitWindowCover.extra_state_attributes (   self)
Return the optional state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 296 of file cover.py.

◆ get_characteristic_types()

list[str] homeassistant.components.homekit_controller.cover.HomeKitWindowCover.get_characteristic_types (   self)
Define the homekit characteristics the entity cares about.

Reimplemented from homeassistant.components.homekit_controller.entity.HomeKitEntity.

Definition at line 142 of file cover.py.

◆ is_closed()

bool homeassistant.components.homekit_controller.cover.HomeKitWindowCover.is_closed (   self)
Return true if cover is closed, else False.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 185 of file cover.py.

◆ is_closing()

bool homeassistant.components.homekit_controller.cover.HomeKitWindowCover.is_closing (   self)
Return if the cover is closing or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 190 of file cover.py.

◆ is_horizontal_tilt()

bool homeassistant.components.homekit_controller.cover.HomeKitWindowCover.is_horizontal_tilt (   self)
Return True if the service has a horizontal tilt characteristic.

Definition at line 204 of file cover.py.

◆ is_opening()

bool homeassistant.components.homekit_controller.cover.HomeKitWindowCover.is_opening (   self)
Return if the cover is opening or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 197 of file cover.py.

◆ is_vertical_tilt()

bool homeassistant.components.homekit_controller.cover.HomeKitWindowCover.is_vertical_tilt (   self)
Return True if the service has a vertical tilt characteristic.

Definition at line 211 of file cover.py.

◆ supported_features()

CoverEntityFeature homeassistant.components.homekit_controller.cover.HomeKitWindowCover.supported_features (   self)
Flag supported features.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 157 of file cover.py.

Member Data Documentation

◆ current_cover_position

homeassistant.components.homekit_controller.cover.HomeKitWindowCover.current_cover_position

Definition at line 187 of file cover.py.


The documentation for this class was generated from the following file: