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

Public Member Functions

None __init__ (self, TeslaFleetVehicleDataCoordinator|TeslaFleetEnergySiteLiveCoordinator|TeslaFleetEnergySiteInfoCoordinator coordinator, VehicleSpecific|EnergySpecific api, str key)
 
bool available (self)
 
Any|None get (self, str key, Any|None default=None)
 
float get_number (self, str key, float default)
 
bool has (self)
 
bool is_none (self)
 
None raise_for_read_only (self, Scope scope)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
- Public Member Functions inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetVehicleDataCoordinator
None __init__ (self, HomeAssistant hass, VehicleSpecific api, dict product)
 
- 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 Member Functions inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetEnergySiteLiveCoordinator
None __init__ (self, HomeAssistant hass, EnergySpecific api)
 
- Public Member Functions inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetEnergySiteInfoCoordinator
None __init__ (self, HomeAssistant hass, EnergySpecific api, dict product)
 

Public Attributes

 api
 
 key
 
- Public Attributes inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetVehicleDataCoordinator
 api
 
 data
 
 last_active
 
 rate
 
 update_interval
 
 updated_once
 
- 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
 
- Public Attributes inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetEnergySiteLiveCoordinator
 api
 
 data
 
 update_interval
 
 updated_once
 
- Public Attributes inherited from homeassistant.components.tesla_fleet.coordinator.TeslaFleetEnergySiteInfoCoordinator
 api
 
 data
 
 update_interval
 
 updated_once
 

Private Member Functions

None _async_update_attrs (self)
 
None _handle_coordinator_update (self)
 
Any|None _value (self)
 

Private Attributes

 _attr_translation_key
 

Static Private Attributes

bool _attr_has_entity_name = True
 

Detailed Description

Parent class for all TeslaFleet entities.

Definition at line 23 of file entity.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.__init__ (   self,
TeslaFleetVehicleDataCoordinator | TeslaFleetEnergySiteLiveCoordinator | TeslaFleetEnergySiteInfoCoordinator  coordinator,
VehicleSpecific | EnergySpecific  api,
str  key 
)
Initialize common aspects of a TeslaFleet entity.

Definition at line 36 of file entity.py.

Member Function Documentation

◆ _async_update_attrs()

None homeassistant.components.tesla_fleet.entity.TeslaFleetEntity._async_update_attrs (   self)
private
Update the attributes of the entity.

Reimplemented in homeassistant.components.tesla_fleet.switch.TeslaFleetStormModeSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetChargeFromGridSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetChargeSwitchEntity, homeassistant.components.tesla_fleet.switch.TeslaFleetVehicleSwitchEntity, homeassistant.components.tesla_fleet.sensor.TeslaFleetEnergyInfoSensorEntity, homeassistant.components.tesla_fleet.sensor.TeslaFleetWallConnectorSensorEntity, homeassistant.components.tesla_fleet.sensor.TeslaFleetEnergyLiveSensorEntity, homeassistant.components.tesla_fleet.sensor.TeslaFleetVehicleTimeSensorEntity, homeassistant.components.tesla_fleet.sensor.TeslaFleetVehicleSensorEntity, homeassistant.components.tesla_fleet.select.TeslaFleetExportRuleSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetOperationSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetWheelHeaterSelectEntity, homeassistant.components.tesla_fleet.select.TeslaFleetSeatHeaterSelectEntity, homeassistant.components.tesla_fleet.number.TeslaFleetEnergyInfoNumberSensorEntity, homeassistant.components.tesla_fleet.number.TeslaFleetVehicleNumberEntity, homeassistant.components.tesla_fleet.media_player.TeslaFleetMediaEntity, homeassistant.components.tesla_fleet.lock.TeslaFleetCableLockEntity, homeassistant.components.tesla_fleet.lock.TeslaFleetVehicleLockEntity, homeassistant.components.tesla_fleet.device_tracker.TeslaFleetDeviceTrackerRouteEntity, homeassistant.components.tesla_fleet.device_tracker.TeslaFleetDeviceTrackerLocationEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetSunroofEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetRearTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetFrontTrunkEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetChargePortEntity, homeassistant.components.tesla_fleet.cover.TeslaFleetWindowEntity, homeassistant.components.tesla_fleet.climate.TeslaFleetCabinOverheatProtectionEntity, homeassistant.components.tesla_fleet.climate.TeslaFleetClimateEntity, homeassistant.components.tesla_fleet.button.TeslaFleetButtonEntity, homeassistant.components.tesla_fleet.binary_sensor.TeslaFleetEnergyInfoBinarySensorEntity, homeassistant.components.tesla_fleet.binary_sensor.TeslaFleetEnergyLiveBinarySensorEntity, and homeassistant.components.tesla_fleet.binary_sensor.TeslaFleetVehicleBinarySensorEntity.

Definition at line 87 of file entity.py.

◆ _handle_coordinator_update()

None homeassistant.components.tesla_fleet.entity.TeslaFleetEntity._handle_coordinator_update (   self)
private
Handle updated data from the coordinator.

Definition at line 81 of file entity.py.

◆ _value()

Any | None homeassistant.components.tesla_fleet.entity.TeslaFleetEntity._value (   self)
private
Return a specific value from coordinator data.

Reimplemented in homeassistant.components.tesla_fleet.entity.TeslaFleetWallConnectorEntity, and homeassistant.components.tesla_fleet.entity.TeslaFleetVehicleEntity.

Definition at line 57 of file entity.py.

◆ available()

bool homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.available (   self)
Return if sensor is available.

Reimplemented from homeassistant.helpers.update_coordinator.CoordinatorEntity.

Definition at line 52 of file entity.py.

◆ get()

Any | None homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.get (   self,
str  key,
Any | None   default = None 
)
Return a specific value from coordinator data.

Definition at line 61 of file entity.py.

◆ get_number()

float homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.get_number (   self,
str  key,
float  default 
)
Return a specific number from coordinator data.

Definition at line 65 of file entity.py.

◆ has()

bool homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.has (   self)
Return True if a specific value is in coordinator data.

Definition at line 77 of file entity.py.

◆ is_none()

bool homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.is_none (   self)
Return if the value is a literal None.

Definition at line 72 of file entity.py.

◆ raise_for_read_only()

None homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.raise_for_read_only (   self,
Scope  scope 
)
Raise an error if a scope is not available.

Definition at line 90 of file entity.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.tesla_fleet.entity.TeslaFleetEntity._attr_has_entity_name = True
staticprivate

Definition at line 32 of file entity.py.

◆ _attr_translation_key

homeassistant.components.tesla_fleet.entity.TeslaFleetEntity._attr_translation_key
private

Definition at line 48 of file entity.py.

◆ api

homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.api

Definition at line 46 of file entity.py.

◆ key

homeassistant.components.tesla_fleet.entity.TeslaFleetEntity.key

Definition at line 47 of file entity.py.


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