Device Tracker Entity

A device tracker is a read-only entity that provides presence information. There are two types of device tracker entities, a ScannerEntity and a TrackerEntity.

ScannerEntity#

A ScannerEntity reports the connected state of a device on the local network. If the device is connected the ScannerEntity will have state home and if the device is not connected the state will be not_home.

Derive a platform entity from homeassistant.components.device_tracker.config_entry.ScannerEntity

Properties#

tip

Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.

NameTypeDefaultDescription
source_typestringRequiredThe source type, eg gps or router, of the device.
is_connectedbooleanRequiredThe connection state of the device.
battery_levelintegerNoneThe battery level of the device.
ip_addressstringNoneThe IP address of the device.
mac_addressstringNoneThe MAC address of the device.
hostnamestringNoneThe hostname of the device.

DHCP discovery#

If the device tracker source_type is router and the ip_address, mac_address, and hostname properties have been set, the data will speed up DHCP discovery as the system will not have to wait for DHCP discover packets to find existing devices.

TrackerEntity#

A TrackerEntity tracks the location of a device and reports it either as a location name, a zone name or home or not_home states. A TrackerEntity normally receives GPS coordinates to determine its state.

Derive a platform entity from homeassistant.components.device_tracker.config_entry.TrackerEntity

Properties#

tip

Properties should always only return information from memory and not do I/O (like network requests). Implement update() or async_update() to fetch data.

NameTypeDefaultDescription
source_typestringRequiredThe source type, eg gps or router, of the device.
latitudestringRequiredThe latitude coordinate of the device.
longitudestringRequiredThe longitude coordinate of the device.
battery_levelintegerNoneThe battery level of the device.
location_accuracyintegerNoneThe location accuracy (m) of the device.
location_namestringNoneThe location name of the device.
Last updated on