From f654a0fabd3ac899b92c3592ec3251c83e939eb9 Mon Sep 17 00:00:00 2001 From: "J. Nick Koston" Date: Sat, 30 Jan 2021 14:38:56 -0600 Subject: [PATCH] Expand device tracker docs --- docs/core/entity/device-tracker.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/core/entity/device-tracker.md b/docs/core/entity/device-tracker.md index f4349550..0cee618c 100644 --- a/docs/core/entity/device-tracker.md +++ b/docs/core/entity/device-tracker.md @@ -9,6 +9,8 @@ A device tracker is a read-only entity that provides presence information. There 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`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/device_tracker/config_entry.py) + ### Properties :::tip @@ -24,10 +26,18 @@ Properties should always only return information from memory and not do I/O (lik | mac_address | string | `None` | The MAC address of the device. | | hostname | string | `None` | The 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`](https://github.com/home-assistant/core/blob/dev/homeassistant/components/device_tracker/config_entry.py) + ### Properties :::tip