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

Public Member Functions

def __del__ (self)
 
def __init__ (self, hass, args)
 
bool available (self)
 
None close_cover (self, **Any kwargs)
 
dict[str, Any] extra_state_attributes (self)
 
def get_token (self)
 
bool|None is_closed (self)
 
str name (self)
 
None open_cover (self, **Any kwargs)
 
def remove_token (self)
 
None stop_cover (self, **Any kwargs)
 
None update (self)
 
- Public Member Functions inherited from homeassistant.components.cover.CoverEntity
None async_close_cover (self, **Any kwargs)
 
None async_close_cover_tilt (self, **Any kwargs)
 
None async_open_cover (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 (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_tilt (self, **Any kwargs)
 
int|None current_cover_position (self)
 
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_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_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)
 
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)
 
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 Attributes

 access_token
 
 device_id
 
 hass
 
 obtained_token
 
 particle_url
 
 sensor
 
 signal
 
 time_in_state
 
- 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
 

Private Member Functions

def _check_state (self, now)
 
def _get_variable (self, var)
 
def _put_command (self, func, arg=None)
 
def _start_watcher (self, command)
 

Private Attributes

 _available
 
 _name
 
 _obtained_token
 
 _password
 
 _state
 
 _unsub_listener_cover
 
 _username
 

Static Private Attributes

 _attr_device_class = CoverDeviceClass.GARAGE
 

Additional Inherited Members

- 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 Garadget cover.

Definition at line 90 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.garadget.cover.GaradgetCover.__init__ (   self,
  hass,
  args 
)
Initialize the cover.

Definition at line 95 of file cover.py.

◆ __del__()

def homeassistant.components.garadget.cover.GaradgetCover.__del__ (   self)
Try to remove token.

Definition at line 136 of file cover.py.

Member Function Documentation

◆ _check_state()

def homeassistant.components.garadget.cover.GaradgetCover._check_state (   self,
  now 
)
private
Check the state of the service during an operation.

Definition at line 206 of file cover.py.

◆ _get_variable()

def homeassistant.components.garadget.cover.GaradgetCover._get_variable (   self,
  var 
)
private
Get latest status.

Definition at line 255 of file cover.py.

◆ _put_command()

def homeassistant.components.garadget.cover.GaradgetCover._put_command (   self,
  func,
  arg = None 
)
private
Send commands to API.

Definition at line 265 of file cover.py.

◆ _start_watcher()

def homeassistant.components.garadget.cover.GaradgetCover._start_watcher (   self,
  command 
)
private
Start watcher.

Definition at line 198 of file cover.py.

◆ available()

bool homeassistant.components.garadget.cover.GaradgetCover.available (   self)
Return True if entity is available.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 147 of file cover.py.

◆ close_cover()

None homeassistant.components.garadget.cover.GaradgetCover.close_cover (   self,
**Any  kwargs 
)
Close the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 210 of file cover.py.

◆ extra_state_attributes()

dict[str, Any] homeassistant.components.garadget.cover.GaradgetCover.extra_state_attributes (   self)
Return the device state attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 152 of file cover.py.

◆ get_token()

def homeassistant.components.garadget.cover.GaradgetCover.get_token (   self)
Get new token for usage during this session.

Definition at line 177 of file cover.py.

◆ is_closed()

bool | None homeassistant.components.garadget.cover.GaradgetCover.is_closed (   self)
Return if the cover is closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 171 of file cover.py.

◆ name()

str homeassistant.components.garadget.cover.GaradgetCover.name (   self)
Return the name of the cover.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 142 of file cover.py.

◆ open_cover()

None homeassistant.components.garadget.cover.GaradgetCover.open_cover (   self,
**Any  kwargs 
)
Open the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 216 of file cover.py.

◆ remove_token()

def homeassistant.components.garadget.cover.GaradgetCover.remove_token (   self)
Remove authorization token from API.

Definition at line 192 of file cover.py.

◆ stop_cover()

None homeassistant.components.garadget.cover.GaradgetCover.stop_cover (   self,
**Any  kwargs 
)
Stop the door where it is.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 222 of file cover.py.

◆ update()

None homeassistant.components.garadget.cover.GaradgetCover.update (   self)
Get updated status from API.

Definition at line 228 of file cover.py.

Member Data Documentation

◆ _attr_device_class

homeassistant.components.garadget.cover.GaradgetCover._attr_device_class = CoverDeviceClass.GARAGE
staticprivate

Definition at line 93 of file cover.py.

◆ _available

homeassistant.components.garadget.cover.GaradgetCover._available
private

Definition at line 110 of file cover.py.

◆ _name

homeassistant.components.garadget.cover.GaradgetCover._name
private

Definition at line 99 of file cover.py.

◆ _obtained_token

homeassistant.components.garadget.cover.GaradgetCover._obtained_token
private

Definition at line 114 of file cover.py.

◆ _password

homeassistant.components.garadget.cover.GaradgetCover._password
private

Definition at line 104 of file cover.py.

◆ _state

homeassistant.components.garadget.cover.GaradgetCover._state
private

Definition at line 105 of file cover.py.

◆ _unsub_listener_cover

homeassistant.components.garadget.cover.GaradgetCover._unsub_listener_cover
private

Definition at line 109 of file cover.py.

◆ _username

homeassistant.components.garadget.cover.GaradgetCover._username
private

Definition at line 103 of file cover.py.

◆ access_token

homeassistant.components.garadget.cover.GaradgetCover.access_token

Definition at line 101 of file cover.py.

◆ device_id

homeassistant.components.garadget.cover.GaradgetCover.device_id

Definition at line 100 of file cover.py.

◆ hass

homeassistant.components.garadget.cover.GaradgetCover.hass

Definition at line 98 of file cover.py.

◆ obtained_token

homeassistant.components.garadget.cover.GaradgetCover.obtained_token

Definition at line 102 of file cover.py.

◆ particle_url

homeassistant.components.garadget.cover.GaradgetCover.particle_url

Definition at line 97 of file cover.py.

◆ sensor

homeassistant.components.garadget.cover.GaradgetCover.sensor

Definition at line 108 of file cover.py.

◆ signal

homeassistant.components.garadget.cover.GaradgetCover.signal

Definition at line 107 of file cover.py.

◆ time_in_state

homeassistant.components.garadget.cover.GaradgetCover.time_in_state

Definition at line 106 of file cover.py.


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