Skip to content

Commit 15783bf

Browse files
robbiet480robbiet480
authored
Merge pull request home-assistant#788 from robbiet480/gravatar-email-for-picture-device-tracker
Gravatar as known_devices picture
2 parents 157bd45 + 033bc84 commit 15783bf

File tree

1 file changed

+28
-18
lines changed

1 file changed

+28
-18
lines changed

‎source/_components/device_tracker.markdown

Lines changed: 28 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,11 @@ sharing: true
99
footer: true
1010
---
1111

12-
Home Assistant can get information from your wireless router to track which devices are connected. Please check the sidebar for a list of brands of supported wireless routers.
12+
Home Assistant can get information from your wireless router or third party services like iCloud or OwnTracks to track which devices are connected and considered "in home". Please check the sidebar for a list of brands of supported wireless routers and services.
1313

14-
There are also trackers available which uses different technologies like [MQTT](/components/mqtt/) or [Nmap](/components/device_tracker.nmap_scanner/) to scan the network for devices.
14+
There are also trackers available which use different technologies like [MQTT](/components/mqtt/) or [Nmap](/components/device_tracker.nmap_scanner/) to scan the network for devices.
15+
16+
# {% linkable_title Configuring a `device_tracker` platform %}
1517

1618
To get started add the following lines to your `configuration.yaml` (example for Netgear):
1719

@@ -22,31 +24,39 @@ device_tracker:
2224
host: 192.168.1.1
2325
username: admin
2426
password: YOUR_PASSWORD
27+
```
2528
26-
# Optional configuration
29+
The following optional parameters can be used with any platform. However device tracker will only look for global settings under the configuration of the first configured platform:
2730
28-
# If new discovered devices are tracked by default (default: yes)
29-
track_new_devices: yes
30-
# Seconds between each scan for new devices (default: 12)
31-
interval_seconds: 12
32-
# Seconds to wait till marking someone as not home after not being seen
33-
# (default: 180)
34-
consider_home: 180
35-
```
31+
| Parameter | Default | Description |
32+
|---------------------|---------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
33+
| `track_new_devices` | True | If new discovered devices are tracked by default |
34+
| `interval_seconds` | 12 | Seconds between each scan for new devices |
35+
| `consider_home` | 180 | Seconds to wait till marking someone as not home after not being seen. This parameter is most useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as Nmap. |
3636

37-
Once tracked, a file will be created in your config dir called `known_devices.yaml`. Edit this file to adjust which devices to be tracked. Here you can also setup a URL for each device to be used as the entity picture and set whether the device will be show in the UI when in the away state.
37+
Multiple device trackers can be used in parallel, such as [Owntracks](/components/device_tracker.owntracks/) and [Nmap](/components/device_tracker.nmap_scanner/). The state of the device will be determined by the source that reported last.
3838

39-
Multiple device trackers can be used in parallel, such as [Owntracks](/components/device_tracker.owntracks/) and [Nmap](/components/device_tracker.nmap_scanner/). The state of the device will be determined by the source that reported last. Device tracker will look for global settings (`track_new_devices`, `consider_home`, and `home_interval`) under the configuration of the first platform.
39+
# {% linkable_title `known_devices.yaml` %}
4040

41-
The optional `consider_home` entry is useful for households with Apple iOS devices that go into sleep mode while still at home to conserve battery life. iPhones will occasionally drop off the network and then re-appear. `consider_home` helps prevent false alarms in presence detection when using IP scanners such as nmap.
41+
Once `device_tracker` is enabled, a file will be created in your config dir named `known_devices.yaml`. Edit this file to adjust which devices to be tracked.
4242

43-
To add Nmap tracking just add the MAC address to the OwnTracks or iCloud device `mac:` configuration. To use both OwnTracks and Nmap you could use the following example:
43+
Here's an example configuration for a single device:
4444

4545
```yaml
46-
owntracksdevicename:
47-
name: Friendly Name!
46+
devicename:
47+
name: Friendly Name
4848
mac: EA:AA:55:E7:C6:94
49-
picture:
49+
picture: https://home-assistant.io/images/favicon-192x192.png
50+
gravatar: test@example.com
5051
track: yes
5152
hide_if_away: no
5253
```
54+
55+
| Parameter | Default | Description |
56+
|----------------|-------------------------------|---------------------------------------------------------------------------------------------------------|
57+
| `name` | Host name or "Unnamed Device" | The friendly name of the device |
58+
| `mac` | None | The MAC address of the device. Add this if you are using a network device tracker like Nmap or SNMP |
59+
| `picture` | None | A picture that you can use to easily identify the person or device |
60+
| `gravatar` | None | An email address for the device's owner. If provided, it will override `picture` |
61+
| `track` | False | If `yes`/`on`/`true` then the device will be tracked. Otherwise its location and state will not update |
62+
| `hide_if_away` | False | If `yes`/`on`/`true` then the device will be hidden if it is not at home |

0 commit comments

Comments
 (0)