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

Public Member Functions

None __init__ (self, ConfigEntry config_entry, PingUpdateCoordinator coordinator)
 
bool entity_registry_enabled_default (self)
 
str ip_address (self)
 
bool is_connected (self)
 
str unique_id (self)
 
- Public Member Functions inherited from homeassistant.helpers.update_coordinator.CoordinatorEntity
None __init__ (self, _DataUpdateCoordinatorT coordinator, Any context=None)
 
None async_update (self)
 
bool available (self)
 
- Public Member Functions inherited from homeassistant.components.ping.coordinator.PingUpdateCoordinator
None __init__ (self, HomeAssistant hass, PingDataSubProcess|PingDataICMPLib ping)
 
- 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 Attributes

 config_entry
 
- Public Attributes inherited from homeassistant.components.ping.coordinator.PingUpdateCoordinator
 ping
 
- 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
 

Static Public Attributes

 None
 

Private Attributes

 _attr_name
 
 _consider_home_interval
 
 _last_seen
 

Detailed Description

Representation of a Ping device tracker.

Definition at line 30 of file device_tracker.py.

Constructor & Destructor Documentation

◆ __init__()

None homeassistant.components.ping.device_tracker.PingDeviceTracker.__init__ (   self,
ConfigEntry  config_entry,
PingUpdateCoordinator   coordinator 
)
Initialize the Ping device tracker.

Definition at line 35 of file device_tracker.py.

Member Function Documentation

◆ entity_registry_enabled_default()

bool homeassistant.components.ping.device_tracker.PingDeviceTracker.entity_registry_enabled_default (   self)
Return if entity is enabled by default.

Definition at line 71 of file device_tracker.py.

◆ ip_address()

str homeassistant.components.ping.device_tracker.PingDeviceTracker.ip_address (   self)
Return the primary ip address of the device.

Definition at line 50 of file device_tracker.py.

◆ is_connected()

bool homeassistant.components.ping.device_tracker.PingDeviceTracker.is_connected (   self)
Return true if ping returns is_alive or considered home.

Definition at line 60 of file device_tracker.py.

◆ unique_id()

str homeassistant.components.ping.device_tracker.PingDeviceTracker.unique_id (   self)
Return a unique ID.

Definition at line 55 of file device_tracker.py.

Member Data Documentation

◆ _attr_name

homeassistant.components.ping.device_tracker.PingDeviceTracker._attr_name
private

Definition at line 41 of file device_tracker.py.

◆ _consider_home_interval

homeassistant.components.ping.device_tracker.PingDeviceTracker._consider_home_interval
private

Definition at line 43 of file device_tracker.py.

◆ _last_seen

homeassistant.components.ping.device_tracker.PingDeviceTracker._last_seen
private

Definition at line 63 of file device_tracker.py.

◆ config_entry

homeassistant.components.ping.device_tracker.PingDeviceTracker.config_entry

Definition at line 42 of file device_tracker.py.

◆ None

homeassistant.components.ping.device_tracker.PingDeviceTracker.None
static

Definition at line 33 of file device_tracker.py.


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