Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData Class Reference
Inheritance diagram for homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData:
[legend]

Public Member Functions

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)
 

Private Attributes

 _raw_data_by_id
 
 _shade_group_data_by_id
 

Detailed Description

Coordinate shade data between multiple api calls.

Definition at line 23 of file shade_data.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.__init__ (   self)
Init the shade data.

Definition at line 26 of file shade_data.py.

Member Function Documentation

◆ get_all_raw_data()

dict[int, dict[str | int, Any]] homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.get_all_raw_data (   self)
Get data for all shades.

Definition at line 36 of file shade_data.py.

◆ get_raw_data()

dict[str | int, Any] homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.get_raw_data (   self,
int  shade_id 
)
Get data for the shade.

Definition at line 32 of file shade_data.py.

◆ get_shade()

BaseShade homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.get_shade (   self,
int  shade_id 
)
Get specific shade from the coordinator.

Definition at line 40 of file shade_data.py.

◆ get_shade_position()

ShadePosition homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.get_shade_position (   self,
int  shade_id 
)
Get positions for a shade.

Definition at line 44 of file shade_data.py.

◆ store_group_data()

None homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.store_group_data (   self,
PowerviewData  shade_data 
)
Store data from the all shades endpoint.

This does not update the shades or positions (self.positions)
as the data may be stale. update_from_group_data
with a shade_id will update a specific shade
from the group data.

Definition at line 59 of file shade_data.py.

◆ update_from_group_data()

None homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.update_from_group_data (   self,
int  shade_id 
)
Process an update from the group data.

Definition at line 54 of file shade_data.py.

◆ update_shade_position()

None homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.update_shade_position (   self,
int  shade_id,
ShadePosition  new_position 
)
Update a single shades position.

Definition at line 70 of file shade_data.py.

◆ update_shade_velocity()

None homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData.update_shade_velocity (   self,
int  shade_id,
ShadePosition  shade_data 
)
Update a single shades velocity.

Definition at line 74 of file shade_data.py.

Member Data Documentation

◆ _raw_data_by_id

homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData._raw_data_by_id
private

Definition at line 68 of file shade_data.py.

◆ _shade_group_data_by_id

homeassistant.components.hunterdouglas_powerview.shade_data.PowerviewShadeData._shade_group_data_by_id
private

Definition at line 67 of file shade_data.py.


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