Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.zwave_js.cover.CoverPositionMixin Class Reference
Inheritance diagram for homeassistant.components.zwave_js.cover.CoverPositionMixin:
[legend]
Collaboration diagram for homeassistant.components.zwave_js.cover.CoverPositionMixin:
[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_stop_cover (self, **Any kwargs)
 
int|None current_cover_position (self)
 
bool|None is_closed (self)
 
int percent_to_zwave_position (self, int value)
 
int zwave_to_percent_position (self, int value)
 
- Public Member Functions inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
None __init__ (self, ConfigEntry config_entry, Driver driver, ZwaveDiscoveryInfo info)
 
None async_added_to_hass (self)
 
None async_poll_value (self, bool refresh_all_values)
 
bool available (self)
 
str generate_name (self, bool include_value_name=False, str|None alternate_value_name=None, Sequence[str|None]|None additional_info=None, str|None name_prefix=None)
 
ZwaveValue|None get_zwave_value (self, str|int value_property, int|None command_class=None, int|None endpoint=None, int|str|None value_property_key=None, bool add_to_watched_value_ids=True, bool check_all_endpoints=False)
 
None on_value_update (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_will_remove_from_hass (self)
 
None async_write_ha_state (self)
 
str|None attribution (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)
 
- 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_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)
 
bool|None is_closing (self)
 
bool|None is_opening (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)
 

Static Public Attributes

 None
 
- 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
 

Private Member Functions

int _fully_closed_position (self)
 
int _fully_open_position (self)
 
int _position_range (self)
 
None _set_position_values (self, ZwaveValue current_value, ZwaveValue|None target_value=None, ZwaveValue|None stop_value=None)
 

Private Attributes

 _attr_supported_features
 
 _current_position_value
 
 _stop_position_value
 
 _target_position_value
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.zwave_js.entity.ZWaveBaseEntity
 config_entry
 
 driver
 
 info
 
 watched_value_ids
 
- 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
 

Detailed Description

Mix-in class for cover with position support.

Definition at line 88 of file cover.py.

Member Function Documentation

◆ _fully_closed_position()

int homeassistant.components.zwave_js.cover.CoverPositionMixin._fully_closed_position (   self)
private
Return value that represents fully closed position.

Definition at line 137 of file cover.py.

◆ _fully_open_position()

int homeassistant.components.zwave_js.cover.CoverPositionMixin._fully_open_position (   self)
private
Return value that represents fully opened position.

Definition at line 131 of file cover.py.

◆ _position_range()

int homeassistant.components.zwave_js.cover.CoverPositionMixin._position_range (   self)
private
Return range between fully opened and fully closed position.

Definition at line 143 of file cover.py.

◆ _set_position_values()

None homeassistant.components.zwave_js.cover.CoverPositionMixin._set_position_values (   self,
ZwaveValue  current_value,
ZwaveValue | None   target_value = None,
ZwaveValue | None   stop_value = None 
)
private
Set values for position.

Definition at line 95 of file cover.py.

◆ async_close_cover()

None homeassistant.components.zwave_js.cover.CoverPositionMixin.async_close_cover (   self,
**Any  kwargs 
)
Close cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Reimplemented in homeassistant.components.zwave_js.cover.ZWaveWindowCovering.

Definition at line 180 of file cover.py.

◆ async_open_cover()

None homeassistant.components.zwave_js.cover.CoverPositionMixin.async_open_cover (   self,
**Any  kwargs 
)
Open the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Reimplemented in homeassistant.components.zwave_js.cover.ZWaveWindowCovering.

Definition at line 173 of file cover.py.

◆ async_set_cover_position()

None homeassistant.components.zwave_js.cover.CoverPositionMixin.async_set_cover_position (   self,
**Any  kwargs 
)
Move the cover to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 165 of file cover.py.

◆ async_stop_cover()

None homeassistant.components.zwave_js.cover.CoverPositionMixin.async_stop_cover (   self,
**Any  kwargs 
)
Stop cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Reimplemented in homeassistant.components.zwave_js.cover.ZWaveWindowCovering.

Definition at line 187 of file cover.py.

◆ current_cover_position()

int | None homeassistant.components.zwave_js.cover.CoverPositionMixin.current_cover_position (   self)
Return the current position of cover where 0 means closed and 100 is fully open.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 155 of file cover.py.

◆ is_closed()

bool | None homeassistant.components.zwave_js.cover.CoverPositionMixin.is_closed (   self)
Return true if cover is closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 148 of file cover.py.

◆ percent_to_zwave_position()

int homeassistant.components.zwave_js.cover.CoverPositionMixin.percent_to_zwave_position (   self,
int  value 
)
Convert position in 0-100 scale to closed_value-open_value scale.

Definition at line 117 of file cover.py.

◆ zwave_to_percent_position()

int homeassistant.components.zwave_js.cover.CoverPositionMixin.zwave_to_percent_position (   self,
int  value 
)
Convert closed_value-open_value scale to position in 0-100 scale.

Definition at line 124 of file cover.py.

Member Data Documentation

◆ _attr_supported_features

homeassistant.components.zwave_js.cover.CoverPositionMixin._attr_supported_features
private

Definition at line 102 of file cover.py.

◆ _current_position_value

homeassistant.components.zwave_js.cover.CoverPositionMixin._current_position_value
private

Definition at line 108 of file cover.py.

◆ _stop_position_value

homeassistant.components.zwave_js.cover.CoverPositionMixin._stop_position_value
private

Definition at line 114 of file cover.py.

◆ _target_position_value

homeassistant.components.zwave_js.cover.CoverPositionMixin._target_position_value
private

Definition at line 109 of file cover.py.

◆ None

homeassistant.components.zwave_js.cover.CoverPositionMixin.None
static

Definition at line 91 of file cover.py.


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