Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.person.Person Class Reference
Inheritance diagram for homeassistant.components.person.Person:
[legend]
Collaboration diagram for homeassistant.components.person.Person:
[legend]

Public Member Functions

None __init__ (self, dict[str, Any] config)
 
None async_added_to_hass (self)
 
None async_update_config (self, ConfigType config)
 
Self from_storage (cls, ConfigType config)
 
Self from_yaml (cls, ConfigType config)
 
- 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)
 
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)
 
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 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)
 

Public Attributes

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

Private Member Functions

None _async_handle_tracker_update (self, Event[EventStateChangedData] event)
 
None _async_update_config (self, ConfigType config)
 
None _parse_source_state (self, State state)
 
None _set_attrs_from_config (self)
 
None _update_extra_state_attributes (self)
 
None _update_state (self)
 

Private Attributes

 _attr_entity_picture
 
 _attr_extra_state_attributes
 
 _attr_name
 
 _attr_state
 
 _attr_unique_id
 
 _config
 
 _gps_accuracy
 
 _latitude
 
 _longitude
 
 _source
 
 _unsub_track_device
 

Static Private Attributes

bool _attr_should_poll = False
 
 _entity_component_unrecorded_attributes = frozenset({ATTR_DEVICE_TRACKERS})
 

Additional Inherited Members

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

Detailed Description

Represent a tracked person.

Definition at line 419 of file __init__.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.person.Person.__init__ (   self,
dict[str, Any]  config 
)
Set up person.

Definition at line 430 of file __init__.py.

Member Function Documentation

◆ _async_handle_tracker_update()

None homeassistant.components.person.Person._async_handle_tracker_update (   self,
Event[EventStateChangedData event 
)
private
Handle the device tracker state changes.

Definition at line 511 of file __init__.py.

◆ _async_update_config()

None homeassistant.components.person.Person._async_update_config (   self,
ConfigType  config 
)
private
Handle when the config is updated.

Definition at line 492 of file __init__.py.

◆ _parse_source_state()

None homeassistant.components.person.Person._parse_source_state (   self,
State  state 
)
private
Parse source state and set person attributes.

This is a device tracker state or the restored person state.

Definition at line 552 of file __init__.py.

◆ _set_attrs_from_config()

None homeassistant.components.person.Person._set_attrs_from_config (   self)
private
Set attributes from config.

Definition at line 444 of file __init__.py.

◆ _update_extra_state_attributes()

None homeassistant.components.person.Person._update_extra_state_attributes (   self)
private
Update extra state attributes.

Definition at line 564 of file __init__.py.

◆ _update_state()

None homeassistant.components.person.Person._update_state (   self)
private
Update the state.

Definition at line 516 of file __init__.py.

◆ async_added_to_hass()

None homeassistant.components.person.Person.async_added_to_hass (   self)
Register device trackers.

Reimplemented from homeassistant.helpers.entity.Entity.

Definition at line 464 of file __init__.py.

◆ async_update_config()

None homeassistant.components.person.Person.async_update_config (   self,
ConfigType  config 
)
Handle when the config is updated.

Definition at line 487 of file __init__.py.

◆ from_storage()

Self homeassistant.components.person.Person.from_storage (   cls,
ConfigType  config 
)
Return entity instance initialized from storage.

Definition at line 451 of file __init__.py.

◆ from_yaml()

Self homeassistant.components.person.Person.from_yaml (   cls,
ConfigType  config 
)
Return entity instance initialized from yaml.

Definition at line 458 of file __init__.py.

Member Data Documentation

◆ _attr_entity_picture

homeassistant.components.person.Person._attr_entity_picture
private

Definition at line 447 of file __init__.py.

◆ _attr_extra_state_attributes

homeassistant.components.person.Person._attr_extra_state_attributes
private

Definition at line 583 of file __init__.py.

◆ _attr_name

homeassistant.components.person.Person._attr_name
private

Definition at line 446 of file __init__.py.

◆ _attr_should_poll

bool homeassistant.components.person.Person._attr_should_poll = False
staticprivate

Definition at line 427 of file __init__.py.

◆ _attr_state

homeassistant.components.person.Person._attr_state
private

Definition at line 542 of file __init__.py.

◆ _attr_unique_id

homeassistant.components.person.Person._attr_unique_id
private

Definition at line 441 of file __init__.py.

◆ _config

homeassistant.components.person.Person._config
private

Definition at line 432 of file __init__.py.

◆ _entity_component_unrecorded_attributes

homeassistant.components.person.Person._entity_component_unrecorded_attributes = frozenset({ATTR_DEVICE_TRACKERS})
staticprivate

Definition at line 425 of file __init__.py.

◆ _gps_accuracy

homeassistant.components.person.Person._gps_accuracy
private

Definition at line 546 of file __init__.py.

◆ _latitude

homeassistant.components.person.Person._latitude
private

Definition at line 544 of file __init__.py.

◆ _longitude

homeassistant.components.person.Person._longitude
private

Definition at line 545 of file __init__.py.

◆ _source

homeassistant.components.person.Person._source
private

Definition at line 543 of file __init__.py.

◆ _unsub_track_device

homeassistant.components.person.Person._unsub_track_device
private

Definition at line 499 of file __init__.py.

◆ device_trackers

homeassistant.components.person.Person.device_trackers

Definition at line 448 of file __init__.py.


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