Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.gogogate2.entity.GoGoGate2Entity Class Reference
Inheritance diagram for homeassistant.components.gogogate2.entity.GoGoGate2Entity:
[legend]
Collaboration diagram for homeassistant.components.gogogate2.entity.GoGoGate2Entity:
[legend]

Public Member Functions

None __init__ (self, ConfigEntry config_entry, DeviceDataUpdateCoordinator data_update_coordinator, AbstractDoor door, str unique_id)
 
DeviceInfo device_info (self)
 
AbstractDoor door (self)
 
AbstractDoor door_status (self)
 
def extra_state_attributes (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.gogogate2.coordinator.DeviceDataUpdateCoordinator
None __init__ (self, HomeAssistant hass, logging.Logger logger, AbstractGateApi api, *str name, timedelta update_interval, Callable[[], Awaitable[GogoGate2InfoResponse|ISmartGateInfoResponse]]|None update_method=None, Debouncer|None request_refresh_debouncer=None)
 
- 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)
 

Private Attributes

 _api
 
 _attr_unique_id
 
 _config_entry
 
 _door
 
 _door_id
 

Additional Inherited Members

- Public Attributes inherited from homeassistant.components.gogogate2.coordinator.DeviceDataUpdateCoordinator
 api
 
- 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
 

Detailed Description

Base class for gogogate2 entities.

Definition at line 16 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.gogogate2.entity.GoGoGate2Entity.__init__ (   self,
ConfigEntry  config_entry,
DeviceDataUpdateCoordinator  data_update_coordinator,
AbstractDoor  door,
str  unique_id 
)
Initialize gogogate2 base entity.

Definition at line 19 of file entity.py.

Member Function Documentation

◆ device_info()

DeviceInfo homeassistant.components.gogogate2.entity.GoGoGate2Entity.device_info (   self)
Device info for the controller.

Definition at line 49 of file entity.py.

◆ door()

AbstractDoor homeassistant.components.gogogate2.entity.GoGoGate2Entity.door (   self)
Return the door object.

Definition at line 35 of file entity.py.

◆ door_status()

AbstractDoor homeassistant.components.gogogate2.entity.GoGoGate2Entity.door_status (   self)
Return the door with status.

Definition at line 42 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.gogogate2.entity.GoGoGate2Entity.extra_state_attributes (   self)
Return the state attributes.

Reimplemented in homeassistant.components.gogogate2.sensor.DoorSensorEntity.

Definition at line 66 of file entity.py.

Member Data Documentation

◆ _api

homeassistant.components.gogogate2.entity.GoGoGate2Entity._api
private

Definition at line 31 of file entity.py.

◆ _attr_unique_id

homeassistant.components.gogogate2.entity.GoGoGate2Entity._attr_unique_id
private

Definition at line 32 of file entity.py.

◆ _config_entry

homeassistant.components.gogogate2.entity.GoGoGate2Entity._config_entry
private

Definition at line 28 of file entity.py.

◆ _door

homeassistant.components.gogogate2.entity.GoGoGate2Entity._door
private

Definition at line 29 of file entity.py.

◆ _door_id

homeassistant.components.gogogate2.entity.GoGoGate2Entity._door_id
private

Definition at line 30 of file entity.py.


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