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

Public Member Functions

def __init__ (self, scs_id, name, logger, scsgate)
 
None close_cover (self, **Any kwargs)
 
None is_closed (self)
 
str name (self)
 
None open_cover (self, **Any kwargs)
 
def process_event (self, message)
 
def scs_id (self)
 
None stop_cover (self, **Any kwargs)
 
- 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)
 
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)
 
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)
 
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)
 

Private Attributes

 _logger
 
 _name
 
 _scs_id
 
 _scsgate
 

Static Private Attributes

bool _attr_should_poll = False
 

Additional Inherited Members

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

Definition at line 63 of file cover.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.scsgate.cover.SCSGateCover.__init__ (   self,
  scs_id,
  name,
  logger,
  scsgate 
)
Initialize the cover.

Definition at line 68 of file cover.py.

Member Function Documentation

◆ close_cover()

None homeassistant.components.scsgate.cover.SCSGateCover.close_cover (   self,
**Any  kwargs 
)
Move the cover down.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 94 of file cover.py.

◆ is_closed()

None homeassistant.components.scsgate.cover.SCSGateCover.is_closed (   self)
Return if the cover is closed.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 86 of file cover.py.

◆ name()

str homeassistant.components.scsgate.cover.SCSGateCover.name (   self)
Return the name of the cover.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 81 of file cover.py.

◆ open_cover()

None homeassistant.components.scsgate.cover.SCSGateCover.open_cover (   self,
**Any  kwargs 
)
Move the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 90 of file cover.py.

◆ process_event()

def homeassistant.components.scsgate.cover.SCSGateCover.process_event (   self,
  message 
)
Handle a SCSGate message related with this cover.

Definition at line 102 of file cover.py.

◆ scs_id()

def homeassistant.components.scsgate.cover.SCSGateCover.scs_id (   self)
Return the SCSGate ID.

Definition at line 76 of file cover.py.

◆ stop_cover()

None homeassistant.components.scsgate.cover.SCSGateCover.stop_cover (   self,
**Any  kwargs 
)
Stop the cover.

Reimplemented from homeassistant.components.cover.CoverEntity.

Definition at line 98 of file cover.py.

Member Data Documentation

◆ _attr_should_poll

bool homeassistant.components.scsgate.cover.SCSGateCover._attr_should_poll = False
staticprivate

Definition at line 66 of file cover.py.

◆ _logger

homeassistant.components.scsgate.cover.SCSGateCover._logger
private

Definition at line 72 of file cover.py.

◆ _name

homeassistant.components.scsgate.cover.SCSGateCover._name
private

Definition at line 71 of file cover.py.

◆ _scs_id

homeassistant.components.scsgate.cover.SCSGateCover._scs_id
private

Definition at line 70 of file cover.py.

◆ _scsgate

homeassistant.components.scsgate.cover.SCSGateCover._scsgate
private

Definition at line 73 of file cover.py.


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