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

Public Member Functions

None __init__ (self, PowerviewShadeUpdateCoordinator coordinator, PowerviewDeviceInfo device_info, str room_name, BaseShade shade, str name)
 
int current_cover_position (self)
 
bool is_closed (self)
 
ShadePosition open_position (self)
 
bool should_poll (self)
 
- Public Member Functions inherited from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualRailBase
int transition_steps (self)
 
- Public Member Functions inherited from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase
bool assumed_state (self)
 
None async_added_to_hass (self)
 
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)
 
None async_update (self)
 
None async_will_remove_from_hass (self)
 
ShadePosition close_position (self)
 
dict[str, strextra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.components.hunterdouglas_powerview.entity.ShadeEntity
DeviceInfo device_info (self)
 
ShadePosition positions (self)
 
- Public Member Functions inherited from homeassistant.components.hunterdouglas_powerview.entity.HDEntity
None __init__ (self, PowerviewShadeUpdateCoordinator coordinator, PowerviewDeviceInfo device_info, str room_name, str powerview_id)
 
PowerviewShadeData data (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.hunterdouglas_powerview.coordinator.PowerviewShadeUpdateCoordinator
None __init__ (self, HomeAssistant hass, Shades shades, Hub hub)
 
- 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_shutdown (self)
 
None async_update_listeners (self)
 
timedelta|None update_interval (self)
 
None update_interval (self, timedelta|None value)
 
- Public Member Functions inherited from homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData
None __init__ (self)
 
dict[int, dict[str|int, Any]] get_all_raw_data (self)
 
dict[str|int, Any] get_raw_data (self, int shade_id)
 
BaseShade get_shade (self, int shade_id)
 
ShadePosition get_shade_position (self, int shade_id)
 
None store_group_data (self, PowerviewData shade_data)
 
None update_from_group_data (self, int shade_id)
 
None update_shade_position (self, int shade_id, ShadePosition new_position)
 
None update_shade_velocity (self, int shade_id, ShadePosition shade_data)
 
- 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)
 
- 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)
 
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)
 
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)
 
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)
 
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

int _clamp_cover_limit (self, int target_hass_position)
 
ShadePosition _get_shade_move (self, int target_hass_position)
 

Private Attributes

 _attr_unique_id
 

Static Private Attributes

string _attr_translation_key = "top"
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.hunterdouglas_powerview.coordinator.PowerviewShadeUpdateCoordinator
 hub
 
 radio_operation_lock
 
 shades
 
- 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

Representation of the top PowerViewShadeDualRailBase shade.

These shades have top/down bottom up functionality and two entities.
Sibling Class: PowerViewShadeTDBUBottom
API Class: ShadeTopDownBottomUp

Definition at line 615 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop.__init__ (   self,
PowerviewShadeUpdateCoordinator  coordinator,
PowerviewDeviceInfo  device_info,
str  room_name,
BaseShade  shade,
str  name 
)
Initialize the shade.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 625 of file cover.py.

Member Function Documentation

◆ _clamp_cover_limit()

int homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop._clamp_cover_limit (   self,
int  target_hass_position 
)
private
Don't allow a cover to go into an impossbile position.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 670 of file cover.py.

◆ _get_shade_move()

ShadePosition homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop._get_shade_move (   self,
int  target_hass_position 
)
private
Return a ShadePosition.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 675 of file cover.py.

◆ current_cover_position()

int homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop.current_cover_position (   self)
Return the current position of cover.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 653 of file cover.py.

◆ is_closed()

bool homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop.is_closed (   self)
Return if the cover is closed.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 647 of file cover.py.

◆ open_position()

ShadePosition homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop.open_position (   self)
Return the open position and required additional positions.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 659 of file cover.py.

◆ should_poll()

bool homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop.should_poll (   self)
Certain shades create multiple entities.

Do not poll shade multiple times. One shade will return data
for both and multiple polling will cause timeouts.

Reimplemented from homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.

Definition at line 638 of file cover.py.

Member Data Documentation

◆ _attr_translation_key

string homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop._attr_translation_key = "top"
staticprivate

Definition at line 623 of file cover.py.

◆ _attr_unique_id

homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop._attr_unique_id
private

Definition at line 635 of file cover.py.


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