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

Public Member Functions

None __init__ (self, str vin, str component, str attribute, str slug_attr, VolvoUpdateCoordinator coordinator)
 
def assumed_state (self)
 
DeviceInfo device_info (self)
 
def extra_state_attributes (self)
 
def icon (self)
 
def instrument (self)
 
def name (self)
 
str unique_id (self)
 
def vehicle (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.volvooncall.coordinator.VolvoUpdateCoordinator
None __init__ (self, HomeAssistant hass, VolvoData volvo_data)
 
- 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 Attributes

 attribute
 
 component
 
 slug_attr
 
 vin
 
- Public Attributes inherited from homeassistant.components.volvooncall.coordinator.VolvoUpdateCoordinator
 volvo_data
 
- 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
 

Private Member Functions

def _entity_name (self)
 
def _vehicle_name (self)
 

Detailed Description

Base class for all VOC entities.

Definition at line 10 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.volvooncall.entity.VolvoEntity.__init__ (   self,
str  vin,
str  component,
str  attribute,
str  slug_attr,
VolvoUpdateCoordinator  coordinator 
)
Initialize the entity.

Definition at line 13 of file entity.py.

Member Function Documentation

◆ _entity_name()

def homeassistant.components.volvooncall.entity.VolvoEntity._entity_name (   self)
private

Definition at line 47 of file entity.py.

◆ _vehicle_name()

def homeassistant.components.volvooncall.entity.VolvoEntity._vehicle_name (   self)
private

Definition at line 51 of file entity.py.

◆ assumed_state()

def homeassistant.components.volvooncall.entity.VolvoEntity.assumed_state (   self)
Return true if unable to access real state of entity.

Definition at line 60 of file entity.py.

◆ device_info()

DeviceInfo homeassistant.components.volvooncall.entity.VolvoEntity.device_info (   self)
Return a inique set of attributes for each vehicle.

Definition at line 65 of file entity.py.

◆ extra_state_attributes()

def homeassistant.components.volvooncall.entity.VolvoEntity.extra_state_attributes (   self)
Return device specific state attributes.

Definition at line 75 of file entity.py.

◆ icon()

def homeassistant.components.volvooncall.entity.VolvoEntity.icon (   self)
Return the icon.

Definition at line 37 of file entity.py.

◆ instrument()

def homeassistant.components.volvooncall.entity.VolvoEntity.instrument (   self)
Return corresponding instrument.

Definition at line 30 of file entity.py.

◆ name()

def homeassistant.components.volvooncall.entity.VolvoEntity.name (   self)
Return full name of the entity.

Definition at line 55 of file entity.py.

◆ unique_id()

str homeassistant.components.volvooncall.entity.VolvoEntity.unique_id (   self)
Return a unique ID.

Definition at line 83 of file entity.py.

◆ vehicle()

def homeassistant.components.volvooncall.entity.VolvoEntity.vehicle (   self)
Return vehicle.

Definition at line 42 of file entity.py.

Member Data Documentation

◆ attribute

homeassistant.components.volvooncall.entity.VolvoEntity.attribute

Definition at line 26 of file entity.py.

◆ component

homeassistant.components.volvooncall.entity.VolvoEntity.component

Definition at line 25 of file entity.py.

◆ slug_attr

homeassistant.components.volvooncall.entity.VolvoEntity.slug_attr

Definition at line 27 of file entity.py.

◆ vin

homeassistant.components.volvooncall.entity.VolvoEntity.vin

Definition at line 24 of file entity.py.


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