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

Public Member Functions

None async_close_cover (self, **Any kwargs)
 
None async_open_cover (self, **Any kwargs)
 
None async_stop_cover (self, **Any kwargs)
 
int|None current_cover_position (self)
 
bool|None is_closed (self)
 
bool|None is_closing (self)
 
bool|None is_opening (self)
 
- Public Member Functions inherited from homeassistant.components.elmax.entity.ElmaxEntity
None __init__ (self, DeviceEndpoint elmax_device, str panel_version, ElmaxCoordinator coordinator)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.elmax.coordinator.ElmaxCoordinator
None __init__ (self, HomeAssistant hass, Logger logger, GenericElmax elmax_api_client, PanelEntry panel, str name, timedelta update_interval)
 
None async_shutdown (self)
 
Actuator get_actuator_state (self, str actuator_id)
 
Area get_area_state (self, str area_id)
 
Cover get_cover_state (self, str cover_id)
 
Actuator get_zone_state (self, str zone_id)
 
def http_client (self)
 
def http_client (self, GenericElmax client)
 
PanelEntry panel_entry (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, *config_entries.ConfigEntry|None|UndefinedType config_entry=UNDEFINED, str name, timedelta|None update_interval=None, Callable[[], Awaitable[_DataT]]|None update_method=None, Callable[[], Awaitable[None]]|None setup_method=None, Debouncer[Coroutine[Any, Any, None]]|None request_refresh_debouncer=None, bool always_update=True)
 
Callable[[], None] async_add_listener (self, CALLBACK_TYPE update_callback, Any context=None)
 
None async_config_entry_first_refresh (self)
 
Generator[Any] async_contexts (self)
 
None async_refresh (self)
 
None async_register_shutdown (self)
 
None async_request_refresh (self)
 
None async_set_update_error (self, Exception err)
 
None async_set_updated_data (self, _DataT data)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- 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_set_cover_position (self, **Any kwargs)
 
None async_set_cover_tilt_position (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)
 
int|None current_cover_tilt_position (self)
 
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)
 
CoverEntityFeature supported_features (self)
 
None toggle (self, **Any kwargs)
 
None toggle_tilt (self, **Any kwargs)
 
- 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_added_to_hass (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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (self)
 
bool available (self)
 
dict[str, Any]|None capability_attributes (self)
 
DeviceInfo|None device_info (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)
 
Mapping[str, Any]|None extra_state_attributes (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)
 
str|UndefinedType|None name (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)
 

Private Member Functions

bool|None __check_cover_status (self, CoverStatus status_to_check)
 

Static Private Attributes

tuple _attr_supported_features
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.helpers.update_coordinator.DataUpdateCoordinator
 always_update
 
 config_entry
 
 data
 
 hass
 
 last_exception
 
 last_update_success
 
 logger
 
 name
 
 setup_method
 
 update_interval
 
 update_method
 
- Public Attributes inherited from homeassistant.components.cover.CoverEntity
 current_cover_position
 
 current_cover_tilt_position
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 
- Static Public Attributes inherited from homeassistant.components.cover.CoverEntity
 None
 
- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Elmax Cover entity implementation.

Definition at line 70 of file cover.py.

Member Function Documentation

◆ __check_cover_status()

bool | None homeassistant.components.elmax.cover.ElmaxCover.__check_cover_status (   self,
CoverStatus  status_to_check 
)
private
Check if the current cover entity is in a specific state.

Definition at line 77 of file cover.py.

◆ async_close_cover()

None homeassistant.components.elmax.cover.ElmaxCover.async_close_cover (   self,
**Any  kwargs 
)
Close the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 130 of file cover.py.

◆ async_open_cover()

None homeassistant.components.elmax.cover.ElmaxCover.async_open_cover (   self,
**Any  kwargs 
)
Open the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 124 of file cover.py.

◆ async_stop_cover()

None homeassistant.components.elmax.cover.ElmaxCover.async_stop_cover (   self,
**Any  kwargs 
)
Stop the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 108 of file cover.py.

◆ current_cover_position()

int | None homeassistant.components.elmax.cover.ElmaxCover.current_cover_position (   self)
Return current position of cover.

None is unknown, 0 is closed, 100 is fully open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 91 of file cover.py.

◆ is_closed()

bool | None homeassistant.components.elmax.cover.ElmaxCover.is_closed (   self)
Tells if the cover is closed or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 86 of file cover.py.

◆ is_closing()

bool | None homeassistant.components.elmax.cover.ElmaxCover.is_closing (   self)
Return if the cover is closing or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 104 of file cover.py.

◆ is_opening()

bool | None homeassistant.components.elmax.cover.ElmaxCover.is_opening (   self)
Tells if the cover is opening or not.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 99 of file cover.py.

Member Data Documentation

◆ _attr_supported_features

tuple homeassistant.components.elmax.cover.ElmaxCover._attr_supported_features
staticprivate
Initial value:
= (
CoverEntityFeature.OPEN | CoverEntityFeature.CLOSE | CoverEntityFeature.STOP
)

Definition at line 73 of file cover.py.


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