homeassistant.components.device_tracker.config_entry.TrackerEntity Class Reference

Inheritance diagram for homeassistant.components.device_tracker.config_entry.TrackerEntity:

Collaboration diagram for homeassistant.components.device_tracker.config_entry.TrackerEntity:

Public Member Functions
bool	force_update (self)
float|None	latitude (self)
int	location_accuracy (self)
str|None	location_name (self)
float|None	longitude (self)
bool	should_poll (self)
str|None	state (self)
dict[str, StateType]	state_attributes (self)
Public Member Functions inherited from homeassistant.components.device_tracker.config_entry.BaseTrackerEntity
int|None	battery_level (self)
SourceType	source_type (self)
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)
str|None	device_class (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)
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)
str|UndefinedType|None	name (self)
None	schedule_update_ha_state (self, bool force_refresh=False)
str|None	suggested_object_id (self)
int|None	supported_features (self)
str|None	translation_key (self)
Mapping[str, str]	translation_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)

Static Public Attributes
	int
	None
	SourceType
Static Public Attributes inherited from homeassistant.components.device_tracker.config_entry.BaseTrackerEntity
	None
Static Public Attributes inherited from homeassistant.helpers.entity.Entity
	bool
	EntityPlatform
	HomeAssistant
	None
	StateInfo
	StateType
	str

Additional Inherited Members
Public Attributes inherited from homeassistant.helpers.entity.Entity
	device_entry
	entity_id
	hass
	parallel_updates
	platform
	registry_entry

Detailed Description

Base class for a tracked device.

Definition at line 214 of file config_entry.py.

Member Function Documentation

force_update()

bool homeassistant.components.device_tracker.config_entry.TrackerEntity.force_update

(

self

)

All updates need to be written to the state machine if we're not polling.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 232 of file config_entry.py.

latitude()

float | None homeassistant.components.device_tracker.config_entry.TrackerEntity.latitude

(

self

)

Return latitude value of the device.

Reimplemented in homeassistant.components.tessie.device_tracker.TessieDeviceTrackerRouteEntity, homeassistant.components.tessie.device_tracker.TessieDeviceTrackerLocationEntity, homeassistant.components.teslemetry.device_tracker.TeslemetryDeviceTrackerEntity, and homeassistant.components.subaru.device_tracker.SubaruDeviceTracker.

Definition at line 250 of file config_entry.py.

location_accuracy()

int homeassistant.components.device_tracker.config_entry.TrackerEntity.location_accuracy

(

self

)

Return the location accuracy of the device.

Value in meters.

Definition at line 237 of file config_entry.py.

location_name()

str | None homeassistant.components.device_tracker.config_entry.TrackerEntity.location_name

(

self

)

Return a location name for the current location of the device.

Reimplemented in homeassistant.components.teslemetry.device_tracker.TeslemetryDeviceTrackerRouteEntity, and homeassistant.components.tesla_fleet.device_tracker.TeslaFleetDeviceTrackerRouteEntity.

Definition at line 245 of file config_entry.py.

longitude()

float | None homeassistant.components.device_tracker.config_entry.TrackerEntity.longitude

(

self

)

Return longitude value of the device.

Reimplemented in homeassistant.components.tessie.device_tracker.TessieDeviceTrackerRouteEntity, homeassistant.components.tessie.device_tracker.TessieDeviceTrackerLocationEntity, homeassistant.components.teslemetry.device_tracker.TeslemetryDeviceTrackerEntity, and homeassistant.components.subaru.device_tracker.SubaruDeviceTracker.

Definition at line 255 of file config_entry.py.

should_poll()

bool homeassistant.components.device_tracker.config_entry.TrackerEntity.should_poll

(

self

)

No polling for entities that have location pushed.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 227 of file config_entry.py.

state()

str | None homeassistant.components.device_tracker.config_entry.TrackerEntity.state

(

self

)

Return the state of the device.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 260 of file config_entry.py.

state_attributes()

dict[str, StateType] homeassistant.components.device_tracker.config_entry.TrackerEntity.state_attributes

(

self

)

Return the device state attributes.

Reimplemented from homeassistant.components.device_tracker.config_entry.BaseTrackerEntity.

Definition at line 281 of file config_entry.py.

Member Data Documentation

int

homeassistant.components.device_tracker.config_entry.TrackerEntity.int

static

Definition at line 221 of file config_entry.py.

None

homeassistant.components.device_tracker.config_entry.TrackerEntity.None

static

Definition at line 220 of file config_entry.py.

SourceType

homeassistant.components.device_tracker.config_entry.TrackerEntity.SourceType

static

Definition at line 224 of file config_entry.py.

---

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

• core/homeassistant/components/device_tracker/config_entry.py