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-22 00:36:29 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add device tracker entity page (#776)

Browse Source 
* Add device tracker entity page

* Fix casing

Co-authored-by: Philip Allgaier <mail@spacegaier.de>

* Fix source type values

Co-authored-by: Philip Allgaier <mail@spacegaier.de>

Co-authored-by: Philip Allgaier <mail@spacegaier.de>
This commit is contained in:
Martin Hjelmare 2021-01-19 12:35:55 +01:00 committed by GitHub
parent c608a08865
commit 7fd9204648
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 45 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
docs/core/entity/device-tracker.md Normal file
View File

@ -0,0 +1,44 @@
---
title: Device Tracker Entity
sidebar_label: Device Tracker
---
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`.
### 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.
:::
| Name | Type | Default | Description |
| ------------- | ------- | ------------ | ------------------------------------------------- |
| source_type | string | **Required** | The source type, eg `gps` or `router`, of the device. |
| is_connected | boolean | **Required** | The connection state of the device. |
| battery_level | integer | `None` | The battery level of the device. |
| ip_address | string | `None` | The IP address of the device. |
| mac_address | string | `None` | The MAC address of the device. |
| hostname | string | `None` | The hostname of the device. |
## 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.
### 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.
:::
| Name | Type | Default | Description |
| ----------------- | ------- | ------------ | ------------------------------------------------- |
| source_type | string | **Required** | The source type, eg `gps` or `router`, of the device. |
| latitude | string | **Required** | The latitude coordinate of the device. |
| longitude | string | **Required** | The longitude coordinate of the device. |
| battery_level | integer | `None` | The battery level of the device. |
| location_accuracy | integer | `None` | The location accuracy (m) of the device. |
| location_name | string | `None` | The location name of the device. |

1
sidebars.js
View File

@ -141,6 +141,7 @@ module.exports = {
"core/entity/binary-sensor",
"core/entity/climate",
"core/entity/cover",
"core/entity/device-tracker",
"core/entity/fan",
"core/entity/humidifier",
"core/entity/light",