jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-10 10:56:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Expand device tracker docs

Browse Source
This commit is contained in:
J. Nick Koston 2021-01-30 14:38:56 -06:00
parent 005e033b4a
commit f654a0fabd
1 changed files with 10 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/core/entity/device-tracker.md
View File

@ -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`. 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 ### Properties
:::tip :::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. | | mac_address | string | `None` | The MAC address of the device. |
| hostname | string | `None` | The hostname 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 ## 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. 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 ### Properties
:::tip :::tip