homeassistant.components.teslemetry.entity.TeslemetryEntity Class Reference

Inheritance diagram for homeassistant.components.teslemetry.entity.TeslemetryEntity:

Collaboration diagram for homeassistant.components.teslemetry.entity.TeslemetryEntity:

Public Member Functions
None	__init__ (self, TeslemetryVehicleDataCoordinator|TeslemetryEnergyHistoryCoordinator|TeslemetryEnergySiteLiveCoordinator|TeslemetryEnergySiteInfoCoordinator coordinator, 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)
def	raise_for_scope (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.teslemetry.coordinator.TeslemetryVehicleDataCoordinator
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.teslemetry.coordinator.TeslemetryEnergyHistoryCoordinator
None	__init__ (self, HomeAssistant hass, EnergySpecific api)
Public Member Functions inherited from homeassistant.components.teslemetry.coordinator.TeslemetryEnergySiteLiveCoordinator
None	__init__ (self, HomeAssistant hass, EnergySpecific api)
Public Member Functions inherited from homeassistant.components.teslemetry.coordinator.TeslemetryEnergySiteInfoCoordinator
None	__init__ (self, HomeAssistant hass, EnergySpecific api, dict product)

Public Attributes
	key
Public Attributes inherited from homeassistant.components.teslemetry.coordinator.TeslemetryVehicleDataCoordinator
	api
	data
	last_active
	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.teslemetry.coordinator.TeslemetryEnergyHistoryCoordinator
	api
	updated_once
Public Attributes inherited from homeassistant.components.teslemetry.coordinator.TeslemetryEnergySiteLiveCoordinator
	api
Public Attributes inherited from homeassistant.components.teslemetry.coordinator.TeslemetryEnergySiteInfoCoordinator
	api
	data

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 Teslemetry entities.

Definition at line 24 of file entity.py.

Constructor & Destructor Documentation

__init__()

None homeassistant.components.teslemetry.entity.TeslemetryEntity.__init__	(		self,
		TeslemetryVehicleDataCoordinator | TeslemetryEnergyHistoryCoordinator | TeslemetryEnergySiteLiveCoordinator | TeslemetryEnergySiteInfoCoordinator	coordinator,
		str	key
	)

Initialize common aspects of a Teslemetry entity.

Definition at line 37 of file entity.py.

Member Function Documentation

_async_update_attrs()

None homeassistant.components.teslemetry.entity.TeslemetryEntity._async_update_attrs (   self )

private

Update the attributes of the entity.

Reimplemented in homeassistant.components.teslemetry.update.TeslemetryUpdateEntity, homeassistant.components.teslemetry.switch.TeslemetryStormModeSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryChargeFromGridSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryChargeSwitchEntity, homeassistant.components.teslemetry.switch.TeslemetryVehicleSwitchEntity, homeassistant.components.teslemetry.sensor.TeslemetryEnergyHistorySensorEntity, homeassistant.components.teslemetry.sensor.TeslemetryEnergyInfoSensorEntity, homeassistant.components.teslemetry.sensor.TeslemetryWallConnectorSensorEntity, homeassistant.components.teslemetry.sensor.TeslemetryEnergyLiveSensorEntity, homeassistant.components.teslemetry.sensor.TeslemetryVehicleTimeSensorEntity, homeassistant.components.teslemetry.sensor.TeslemetryVehicleSensorEntity, homeassistant.components.teslemetry.select.TeslemetryExportRuleSelectEntity, homeassistant.components.teslemetry.select.TeslemetryOperationSelectEntity, homeassistant.components.teslemetry.select.TeslemetryWheelHeaterSelectEntity, homeassistant.components.teslemetry.select.TeslemetrySeatHeaterSelectEntity, homeassistant.components.teslemetry.number.TeslemetryEnergyInfoNumberSensorEntity, homeassistant.components.teslemetry.number.TeslemetryVehicleNumberEntity, homeassistant.components.teslemetry.media_player.TeslemetryMediaEntity, homeassistant.components.teslemetry.lock.TeslemetryCableLockEntity, homeassistant.components.teslemetry.lock.TeslemetryVehicleLockEntity, homeassistant.components.teslemetry.device_tracker.TeslemetryDeviceTrackerEntity, homeassistant.components.teslemetry.cover.TeslemetrySunroofEntity, homeassistant.components.teslemetry.cover.TeslemetryRearTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetryFrontTrunkEntity, homeassistant.components.teslemetry.cover.TeslemetryChargePortEntity, homeassistant.components.teslemetry.cover.TeslemetryWindowEntity, homeassistant.components.teslemetry.climate.TeslemetryCabinOverheatProtectionEntity, homeassistant.components.teslemetry.climate.TeslemetryClimateEntity, homeassistant.components.teslemetry.button.TeslemetryButtonEntity, homeassistant.components.teslemetry.binary_sensor.TeslemetryEnergyInfoBinarySensorEntity, homeassistant.components.teslemetry.binary_sensor.TeslemetryEnergyLiveBinarySensorEntity, and homeassistant.components.teslemetry.binary_sensor.TeslemetryVehicleBinarySensorEntity.

Definition at line 87 of file entity.py.

_handle_coordinator_update()

None homeassistant.components.teslemetry.entity.TeslemetryEntity._handle_coordinator_update (   self )

private

Handle updated data from the coordinator.

Definition at line 81 of file entity.py.

_value()

Any | None homeassistant.components.teslemetry.entity.TeslemetryEntity._value (   self )

private

Return a specific value from coordinator data.

Reimplemented in homeassistant.components.teslemetry.entity.TeslemetryWallConnectorEntity, and homeassistant.components.teslemetry.entity.TeslemetryVehicleEntity.

Definition at line 57 of file entity.py.

available()

bool homeassistant.components.teslemetry.entity.TeslemetryEntity.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.teslemetry.entity.TeslemetryEntity.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.teslemetry.entity.TeslemetryEntity.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.teslemetry.entity.TeslemetryEntity.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.teslemetry.entity.TeslemetryEntity.is_none

(

self

)

Return if the value is a literal None.

Definition at line 72 of file entity.py.

raise_for_scope()

def homeassistant.components.teslemetry.entity.TeslemetryEntity.raise_for_scope	(		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.teslemetry.entity.TeslemetryEntity._attr_has_entity_name = True

staticprivate

Definition at line 34 of file entity.py.

_attr_translation_key

homeassistant.components.teslemetry.entity.TeslemetryEntity._attr_translation_key

private

Definition at line 48 of file entity.py.

key

homeassistant.components.teslemetry.entity.TeslemetryEntity.key

Definition at line 47 of file entity.py.

---

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

• core/homeassistant/components/teslemetry/entity.py