Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.owntracks.device_tracker.OwnTracksEntity Class Reference
Inheritance diagram for homeassistant.components.owntracks.device_tracker.OwnTracksEntity:
[legend]
Collaboration diagram for homeassistant.components.owntracks.device_tracker.OwnTracksEntity:
[legend]

Public Member Functions

def __init__ (self, dev_id, data=None)
 
None async_added_to_hass (self)
 
def battery_level (self)
 
DeviceInfo device_info (self)
 
def extra_state_attributes (self)
 
def latitude (self)
 
def location_accuracy (self)
 
def location_name (self)
 
def longitude (self)
 
SourceType source_type (self)
 
def unique_id (self)
 
def update_data (self, data)
 
- Public Member Functions inherited from homeassistant.helpers.restore_state.RestoreEntity
ExtraStoredData|None async_get_last_extra_data (self)
 
State|None async_get_last_state (self)
 
None async_internal_added_to_hass (self)
 
None async_internal_will_remove_from_hass (self)
 
ExtraStoredData|None extra_restore_state_data (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_device_update (self, bool warning=True)
 
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)
 
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)
 
bool force_update (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)
 
bool should_poll (self)
 
StateType state (self)
 
dict[str, Any]|None state_attributes (self)
 
str|None suggested_object_id (self)
 
int|None supported_features (self)
 
str|None translation_key (self)
 
Mapping[str, strtranslation_placeholders (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)
 

Public Attributes

 entity_id
 
- Public Attributes inherited from homeassistant.helpers.entity.Entity
 device_entry
 
 entity_id
 
 hass
 
 parallel_updates
 
 platform
 
 registry_entry
 

Private Attributes

 _data
 
 _dev_id
 

Static Private Attributes

bool _attr_has_entity_name = True
 
 _attr_name = None
 

Additional Inherited Members

- Static Public Attributes inherited from homeassistant.helpers.entity.Entity
 bool
 
 EntityPlatform
 
 HomeAssistant
 
 None
 
 StateInfo
 
 StateType
 
 str
 

Detailed Description

Represent a tracked device.

Definition at line 59 of file device_tracker.py.

Constructor & Destructor Documentation

◆ __init__()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.__init__ (   self,
  dev_id,
  data = None 
)
Set up OwnTracks entity.

Definition at line 65 of file device_tracker.py.

Member Function Documentation

◆ async_added_to_hass()

None homeassistant.components.owntracks.device_tracker.OwnTracksEntity.async_added_to_hass (   self)
Call when entity about to be added to Home Assistant.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 127 of file device_tracker.py.

◆ battery_level()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.battery_level (   self)
Return the battery level of the device.

Definition at line 77 of file device_tracker.py.

◆ device_info()

DeviceInfo homeassistant.components.owntracks.device_tracker.OwnTracksEntity.device_info (   self)
Return the device info.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 120 of file device_tracker.py.

◆ extra_state_attributes()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.extra_state_attributes (   self)
Return device specific attributes.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 82 of file device_tracker.py.

◆ latitude()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.latitude (   self)
Return latitude value of the device.

Definition at line 92 of file device_tracker.py.

◆ location_accuracy()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.location_accuracy (   self)
Return the gps accuracy of the device.

Definition at line 87 of file device_tracker.py.

◆ location_name()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.location_name (   self)
Return a location name for the current location of the device.

Definition at line 110 of file device_tracker.py.

◆ longitude()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.longitude (   self)
Return longitude value of the device.

Definition at line 101 of file device_tracker.py.

◆ source_type()

SourceType homeassistant.components.owntracks.device_tracker.OwnTracksEntity.source_type (   self)
Return the source type, eg gps or router, of the device.

Definition at line 115 of file device_tracker.py.

◆ unique_id()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.unique_id (   self)
Return the unique ID.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 72 of file device_tracker.py.

◆ update_data()

def homeassistant.components.owntracks.device_tracker.OwnTracksEntity.update_data (   self,
  data 
)
Mark the device as seen.

Definition at line 148 of file device_tracker.py.

Member Data Documentation

◆ _attr_has_entity_name

bool homeassistant.components.owntracks.device_tracker.OwnTracksEntity._attr_has_entity_name = True
staticprivate

Definition at line 62 of file device_tracker.py.

◆ _attr_name

homeassistant.components.owntracks.device_tracker.OwnTracksEntity._attr_name = None
staticprivate

Definition at line 63 of file device_tracker.py.

◆ _data

homeassistant.components.owntracks.device_tracker.OwnTracksEntity._data
private

Definition at line 68 of file device_tracker.py.

◆ _dev_id

homeassistant.components.owntracks.device_tracker.OwnTracksEntity._dev_id
private

Definition at line 67 of file device_tracker.py.

◆ entity_id

homeassistant.components.owntracks.device_tracker.OwnTracksEntity.entity_id

Definition at line 69 of file device_tracker.py.


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