Home Assistant Unofficial Reference 2024.12.1
homeassistant.components.device_tracker.config_entry Namespace Reference

Classes

class  BaseTrackerEntity
 
class  ScannerEntity
 
class  ScannerEntityDescription
 
class  TrackerEntity
 
class  TrackerEntityDescription
 

Functions

None _async_connected_device_registered (HomeAssistant hass, str mac, str|None ip_address, str|None hostname)
 
None _async_register_mac (HomeAssistant hass, str domain, str mac, str unique_id)
 
bool async_setup_entry (HomeAssistant hass, ConfigEntry entry)
 
bool async_unload_entry (HomeAssistant hass, ConfigEntry entry)
 

Variables

dictionary CACHED_SCANNER_PROPERTIES_WITH_ATTR_
 
dictionary CACHED_TRACKER_PROPERTIES_WITH_ATTR_
 

Detailed Description

Code to set up a device tracker platform using a config entry.

Function Documentation

◆ _async_connected_device_registered()

None homeassistant.components.device_tracker.config_entry._async_connected_device_registered ( HomeAssistant  hass,
str  mac,
str | None  ip_address,
str | None   hostname 
)
private
Register a newly seen connected device.

This is currently used by the dhcp integration
to listen for newly registered connected devices
for discovery.

Definition at line 72 of file config_entry.py.

◆ _async_register_mac()

None homeassistant.components.device_tracker.config_entry._async_register_mac ( HomeAssistant  hass,
str  domain,
str  mac,
str  unique_id 
)
private
Register a mac address with a unique ID.

Definition at line 93 of file config_entry.py.

◆ async_setup_entry()

bool homeassistant.components.device_tracker.config_entry.async_setup_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Set up an entry.

Definition at line 51 of file config_entry.py.

◆ async_unload_entry()

bool homeassistant.components.device_tracker.config_entry.async_unload_entry ( HomeAssistant  hass,
ConfigEntry  entry 
)
Unload an entry.

Definition at line 66 of file config_entry.py.

Variable Documentation

◆ CACHED_SCANNER_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.device_tracker.config_entry.CACHED_SCANNER_PROPERTIES_WITH_ATTR_
Initial value:
1 = {
2  "ip_address",
3  "mac_address",
4  "hostname",
5 }

Definition at line 298 of file config_entry.py.

◆ CACHED_TRACKER_PROPERTIES_WITH_ATTR_

dictionary homeassistant.components.device_tracker.config_entry.CACHED_TRACKER_PROPERTIES_WITH_ATTR_
Initial value:
1 = {
2  "latitude",
3  "location_accuracy",
4  "location_name",
5  "longitude",
6 }

Definition at line 206 of file config_entry.py.