homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase Class Reference

Inheritance diagram for homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase:

Collaboration diagram for homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase:

Public Member Functions
None	__init__ (self, PowerviewShadeUpdateCoordinator coordinator, PowerviewDeviceInfo device_info, str room_name, BaseShade shade, str name)
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)
int	current_cover_position (self)
dict[str, str]	extra_state_attributes (self)
bool	is_closed (self)
ShadePosition	open_position (self)
bool	should_poll (self)
int	transition_steps (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, str]	translation_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
None	_async_cancel_scheduled_transition_update (self)
None	_async_complete_schedule_update (self, datetime _)
None	_async_execute_move (self, ShadePosition move)
None	_async_force_refresh_state (self)
None	_async_force_resync (self, *Any _)
None	_async_schedule_update_for_transition (self, int steps)
None	_async_set_cover_position (self, int target_hass_position)
None	_async_update_shade_data (self, ShadePosition shade_data)
None	_async_update_shade_from_group (self)
int	_clamp_cover_limit (self, int target_hass_position)
ShadePosition	_get_shade_move (self, int target_hass_position)
bool	_update_in_progress (self)

Private Attributes
	_attr_is_closing
	_attr_is_opening
	_forced_resync
	_scheduled_transition_update

Static Private Attributes
	_attr_device_class = CoverDeviceClass.SHADE
tuple	_attr_supported_features

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 a powerview shade.

Definition at line 92 of file cover.py.

Constructor & Destructor Documentation

__init__()

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

Initialize the shade.

Reimplemented from homeassistant.components.hunterdouglas_powerview.entity.ShadeEntity.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombinedTilt, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedFront, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombined, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUBottom, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTiltOnly, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase.

Definition at line 102 of file cover.py.

Member Function Documentation

_async_cancel_scheduled_transition_update()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_cancel_scheduled_transition_update (   self )

private

Cancel any previous updates.

Definition at line 238 of file cover.py.

_async_complete_schedule_update()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_complete_schedule_update (   self, datetime  _  )

private

Update status of the cover.

Definition at line 271 of file cover.py.

_async_execute_move()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_execute_move (   self, ShadePosition  move  )

private

Execute a move that can affect multiple positions.

Definition at line 208 of file cover.py.

_async_force_refresh_state()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_force_refresh_state (   self )

private

Refresh the cover state and force the device cache to be bypassed.

Definition at line 286 of file cover.py.

_async_force_resync()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_force_resync (   self, *Any  _  )

private

Force a resync after an update since the hub may have stale state.

Definition at line 280 of file cover.py.

_async_schedule_update_for_transition()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_schedule_update_for_transition (   self, int  steps  )

private

Definition at line 248 of file cover.py.

_async_set_cover_position()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_set_cover_position (   self, int  target_hass_position  )

private

Move the shade to a position.

Definition at line 218 of file cover.py.

_async_update_shade_data()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_update_shade_data (   self, ShadePosition  shade_data  )

private

Update the current cover position from the data.

Definition at line 231 of file cover.py.

_async_update_shade_from_group()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._async_update_shade_from_group (   self )

private

Update with new data from the coordinator.

Definition at line 308 of file cover.py.

_clamp_cover_limit()

int homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._clamp_cover_limit (   self, int  target_hass_position  )

private

Don't allow a cover to go into an impossbile position.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUBottom.

Definition at line 191 of file cover.py.

_get_shade_move()

ShadePosition homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._get_shade_move (   self, int  target_hass_position  )

private

Return a ShadePosition.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedFront, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombined, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUBottom, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltAnywhere, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase.

Definition at line 201 of file cover.py.

_update_in_progress()

bool homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._update_in_progress (   self )

private

Check if an update is already in progress.

Definition at line 303 of file cover.py.

assumed_state()

bool homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.assumed_state

(

self

)

If the device is hard wired we are polling state.

The hub will frequently provide the wrong state
for battery power devices so we set assumed
state in this case.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 119 of file cover.py.

async_added_to_hass()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_added_to_hass

(

self

)

When entity is added to hass.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 292 of file cover.py.

async_close_cover()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_close_cover	(		self,
		**Any	kwargs
	)

Close the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 168 of file cover.py.

async_open_cover()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_open_cover	(		self,
		**Any	kwargs
	)

Open the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 176 of file cover.py.

async_set_cover_position()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_set_cover_position	(		self,
		**Any	kwargs
	)

Move the shade to a specific position.

Reimplemented from homeassistant.components.cover.CoverEntity.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTopDown.

Definition at line 196 of file cover.py.

async_stop_cover()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_stop_cover	(		self,
		**Any	kwargs
	)

Stop the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 184 of file cover.py.

async_update()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_update

(

self

)

Refresh shade position.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 316 of file cover.py.

async_will_remove_from_hass()

None homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.async_will_remove_from_hass

(

self

)

Cancel any pending refreshes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 298 of file cover.py.

close_position()

ShadePosition homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.close_position

(

self

)

Return the close position and required additional positions.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedFront, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedBase, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltOnClosed.

Definition at line 164 of file cover.py.

current_cover_position()

int homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.current_cover_position

(

self

)

Return the current position of cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombined, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTopDown, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTiltOnly.

Definition at line 149 of file cover.py.

extra_state_attributes()

dict[str, str] homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.extra_state_attributes

(

self

)

Return the state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 139 of file cover.py.

is_closed()

bool homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.is_closed

(

self

)

Return if the cover is closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombined, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTopDown, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTiltOnly.

Definition at line 144 of file cover.py.

open_position()

ShadePosition homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.open_position

(

self

)

Return the open position and required additional positions.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedBase, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltOnClosed.

Definition at line 159 of file cover.py.

should_poll()

bool homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.should_poll

(

self

)

Only poll if the device is hard wired.

We cannot poll battery powered devices
as it would drain their batteries in a matter
of days.

Reimplemented from homeassistant.helpers.entity.Entity.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedRear, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedFront, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTDBUTop.

Definition at line 129 of file cover.py.

transition_steps()

int homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase.transition_steps

(

self

)

Return the steps to make a move.

Reimplemented in homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedCombinedTilt, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualOverlappedBase, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeDualRailBase, homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeTiltOnly, and homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeWithTiltBase.

Definition at line 154 of file cover.py.

Member Data Documentation

_attr_device_class

homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._attr_device_class = CoverDeviceClass.SHADE

staticprivate

Definition at line 95 of file cover.py.

_attr_is_closing

homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._attr_is_closing

private

Definition at line 173 of file cover.py.

_attr_is_opening

homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._attr_is_opening

private

Definition at line 172 of file cover.py.

_attr_supported_features

tuple homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._attr_supported_features

staticprivate

Initial value:

=  (
        CoverEntityFeature.OPEN
        | CoverEntityFeature.CLOSE
        | CoverEntityFeature.SET_POSITION
    )

Definition at line 96 of file cover.py.

_forced_resync

homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._forced_resync

private

Definition at line 245 of file cover.py.

_scheduled_transition_update

homeassistant.components.hunterdouglas_powerview.cover.PowerViewShadeBase._scheduled_transition_update

private

Definition at line 242 of file cover.py.

---

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

• core/homeassistant/components/hunterdouglas_powerview/cover.py