Skip to content

Minimizing of the configuration sample (Device tracker) #1040

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Oct 2, 2016
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions source/_components/device_tracker.actiontec.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -27,16 +27,16 @@ To use this device tracker in your installation, add the following to your `conf
```yaml
# Example configuration.yaml entry
device_tracker:
platform: actiontec
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
- platform: actiontec
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```

Configuration variables:

- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*.
- **host** (*Required*): The IP address of your router, eg. `192.168.1.1`.
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account.

See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
Expand Down
14 changes: 7 additions & 7 deletions source/_components/device_tracker.aruba.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -28,17 +28,17 @@ To use this device tracker in your installation, add the following to your `conf
```yaml
# Example configuration.yaml entry
device_tracker:
platform: aruba
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
- platform: aruba
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```

Configuration variables:

- **host** *Required*: The IP address of your router, e.g. 192.168.1.1.
- **username** *Required*: The username of an user with administrative privileges, usually *admin*.
- **password** *Required*: The password for your given admin account.
- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`.
- **username** (*Required*): The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account.

See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

15 changes: 6 additions & 9 deletions source/_components/device_tracker.asuswrt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,21 +20,18 @@ To use an ASUSWRT router in your installation, add the following to your `config
```yaml
# Example configuration.yaml entry
device_tracker:
platform: asuswrt
host: YOUR_ROUTER_IP
protocol: telnet
mode: router
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
- platform: asuswrt
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
```

Configuration variables:

- **host** (*Required*): The IP address of your router, eg. 192.168.1.1.
- **host** (*Required*): The IP address of your router, eg. `192.168.1.1`.
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Optional*): The password for your given admin account (use this if no SSH key is given).
- **protocol** (*Optional*): The protocol (`ssh` or `telnet`) to use. Defaults to `ssh`.
- **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*.
- **password** (*Optional*): The password for your given admin account (use this if no SSH key is given).
- **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password).

<p class='note warning'>
Expand Down
18 changes: 9 additions & 9 deletions source/_components/device_tracker.automatic.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,20 +20,20 @@ To use an Automatic ODB reader in your installation, add the following to your `
```yaml
# Example configuration.yaml entry
device_tracker:
platform: automatic
client_id: 1234567
secret: 0987654321
username: your@email.com
password: your_password
devices:
- 2007 Honda Element
- 2004 Subaru Impreza
- platform: automatic
client_id: 1234567
secret: 0987654321
username: your@email.com
password: your_password
devices:
- 2007 Honda Element
- 2004 Subaru Impreza
```

Configuration variables:

- **client_id** (*Required*): The OAuth client id (get from https://developer.automatic.com/).
- **secret** (*Require*): The OAuth client secret (get from https://developer.automatic.com/).
- **secret** (*Required*): The OAuth client secret (get from https://developer.automatic.com/).
- **username** (*Required*): The username associated with your ODB reader.
- **password** (*Required*): The password for your given ODB reader account.
- **devices** (*Optional*): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,8 +23,9 @@ Requires PyBluez. If you are on Raspbian, make sure you first install `bluetooth
To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
device_tracker:
platform: bluetooth_le_tracker
- platform: bluetooth_le_tracker
```

As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times.
Expand All @@ -35,8 +36,8 @@ BTLE tracking requires root privileges.
For running Home Assistant as non root user we can give python3 the missing capabilities to access the bluetooth stack. Quite like setting the setuid bit (see [Stack Exchange](http://unix.stackexchange.com/questions/96106/bluetooth-le-scan-as-non-root) for more information).

```bash
sudo apt-get install libcap2-bin
sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\``
$ sudo apt-get install libcap2-bin
$ sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\``
```

A restart of Home Assistant is required.
Expand Down
10 changes: 5 additions & 5 deletions source/_components/device_tracker.bluetooth_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,20 +9,20 @@ sharing: true
footer: true
logo: bluetooth.png
ha_category: Presence Detection
ha_iot_class: "Local Poll"
ha_iot_class: "Local Polling"
ha_release: 0.18
---

This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. It is not required to pair the devices with each other!
Devices discovered are stored with 'bt_' as the prefix for device mac addresses in `known_devices.yaml`.
This tracker discovers new devices on boot and tracks bluetooth devices periodically based on interval_seconds value. It is not required to pair the devices with each other! Devices discovered are stored with 'bt_' as the prefix for device mac addresses in `known_devices.yaml`.

To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
device_tracker:
platform: bluetooth_tracker
- platform: bluetooth_tracker
```

In some cases it can be that your device is not discovered. In that case let your phone scan for BT devices while you restart HA. Just hit Scan on your phone all the time until HA is fully restarted and the device should appear in `known_devices.yaml`.
In some cases it can be that your device is not discovered. In that case let your phone scan for BT devices while you restart Home Assistant. Just hit `Scan` on your phone all the time until Home Assisstant is fully restarted and the device should appear in `known_devices.yaml`.

For additional configuration variables check the [Device tracker page](/components/device_tracker/).
7 changes: 2 additions & 5 deletions source/_components/device_tracker.bt_home_hub_5.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,8 @@ To use a BT Home Hub 5 router in your installation, add the following to your `c
```yaml
# Example configuration.yaml entry
device_tracker:
platform: bt_home_hub_5
host: 192.168.1.254
interval_seconds: 10
consider_home: 180
track_new_devices: yes
- platform: bt_home_hub_5
host: 192.168.1.254
```

Configuration variables:
Expand Down
12 changes: 6 additions & 6 deletions source/_components/device_tracker.ddwrt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,16 +19,16 @@ To use a DD-WRT router in your installation, add the following to your `configur
```yaml
# Example configuration.yaml entry
device_tracker:
platform: ddwrt
host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
- platform: ddwrt
host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```

Configuration variables:

- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*.
- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`.
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account.

See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
9 changes: 3 additions & 6 deletions source/_components/device_tracker.fritz.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -24,16 +24,13 @@ To use an Fritz!Box router in your installation, add the following to your `conf
```yaml
# Example configuration.yaml entry
device_tracker:
platform: fritz
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
- platform: fritz
```

Configuration variables:

- **host** (*Optional*): The IP address of your router, eg. 192.168.1.1. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
- **username** (*Optional*: The username of an user with administrative privileges, usually *admin*.
- **host** (*Optional*): The IP address of your router, eg. `192.168.1.1`. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
- **username** (*Optional*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Optional*): The password for your given admin account.

<p class='note'>
Expand Down
6 changes: 3 additions & 3 deletions source/_components/device_tracker.icloud.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ To integrate iCloud in Home Assistant, add the following section to your `config
```yaml
# Example configuration.yaml entry
device_tracker:
platform: icloud
username: USERNAME
password: PASSWORD
- platform: icloud
username: USERNAME
password: PASSWORD
```

Configuration variables:
Expand Down
2 changes: 1 addition & 1 deletion source/_components/device_tracker.locative.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ To integrate Locative in Home Assistant, add the following section to your `conf
```yaml
# Example configuration.yaml entry
device_tracker:
platform: locative
- platform: locative
```

Install on your smartphone:
Expand Down
15 changes: 8 additions & 7 deletions source/_components/device_tracker.luci.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ sharing: true
footer: true
logo: openwrt.png
ha_category: Presence Detection
ha_release: pre 0.7
---

_This is one of the two ways we support OpenWRT. If you encounter problems, try [ubus](/components/device_tracker.ubus/)._
Expand All @@ -18,24 +19,24 @@ This is a presence detection scanner for OpenWRT using [luci](http://wiki.openwr
Before this scanner can be used you have to install the luci RPC package on OpenWRT:

```bash
opkg install luci-mod-rpc
# opkg install luci-mod-rpc
```

To use this device tracker in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
device_tracker:
platform: luci
host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
- platform: luci
host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```

Configuration variables:

- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1.
- **username** (*Required*): The username of an user with administrative privileges, usually *admin*.
- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`.
- **username** (*Required*): The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account.

See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
Expand Down
21 changes: 17 additions & 4 deletions source/_components/device_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@ To get started add the following lines to your `configuration.yaml` (example for
```yaml
# Example configuration.yaml entry for Netgear device
device_tracker:
platform: netgear
host: 192.168.1.1
username: admin
password: YOUR_PASSWORD
- platform: netgear
host: 192.168.1.1
username: admin
password: YOUR_PASSWORD
```

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:
Expand All @@ -34,6 +34,19 @@ The following optional parameters can be used with any platform. However device
| `interval_seconds` | 12 | Seconds between each scan for new devices |
| `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. |

The extended example from above would look like the following sample:

```yaml
# Example configuration.yaml entry for Netgear device
device_tracker:
- platform: netgear
host: 192.168.1.1
username: admin
interval_seconds: 10
consider_home: 180
track_new_devices: yes
```

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.

# {% linkable_title `known_devices.yaml` %}
Expand Down
9 changes: 4 additions & 5 deletions source/_components/device_tracker.mqtt.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -19,11 +19,10 @@ To use this device tracker in your installation, add the following to your `conf
```yaml
# Example configuration.yaml entry
device_tracker:
platform: mqtt
qos: 1
devices:
paulus_oneplus: /location/paulus
annetherese_n4: /location/annetherese
- platform: mqtt
devices:
paulus_oneplus: /location/paulus
annetherese_n4: /location/annetherese
```

Configuration variables:
Expand Down
13 changes: 6 additions & 7 deletions source/_components/device_tracker.netgear.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,16 @@ To use this device tracker in your installation, add the following to your `conf
```yaml
# Example configuration.yaml entry
device_tracker:
platform: netgear
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
port: YOUR_ROUTER_PORT
- platform: netgear
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
```

Configuration variables:

- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*.
- **host** (*Required*): The IP address of your router, e.g. `192.168.1.1`.
- **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account.
- **port** (*Optional*): The port your router communicates with (defaults to 5000, but 80 is also known to be used on some models)

Expand Down
26 changes: 18 additions & 8 deletions source/_components/device_tracker.nmap_tracker.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -15,25 +15,35 @@ featured: false

As an alternative to the router-based device tracking, it is possible to directly scan the network for devices by using Nmap. The IP addresses to scan can be specified in any format that Nmap understands, including the network-prefix notation (`192.168.1.1/24`) and the range notation (`192.168.1.1-255`).

If you're on Debian or Ubuntu, you might have to install the packages for `arp` and `nmap`. Do so by running `apt-get install net-tools nmap`. On a Fedora host run `sudo dnf -y install nmap`.
If you're on Debian or Ubuntu, you might have to install the packages for `arp` and `nmap`. Do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.

To use this device tracker in your installation, add the following to your `configuration.yaml` file:

```yaml
# Example configuration.yaml entry
device_tracker:
platform: nmap_tracker
hosts: 192.168.1.1/24
home_interval: 10
exclude:
- 192.168.1.12
- 192.168.1.13
- platform: nmap_tracker
hosts: 192.168.1.1/24
```

Configuration variables:

- **hosts** (*Required*): The network range to scan in CIDR notation, eg. 192.168.1.1/24
- **hosts** (*Required*): The network range to scan in CIDR notation, eg. `192.168.1.1/24`.
- **home_interval** (*Optional*): The number of minutes nmap will not scan this device, assuming it is home, in order to preserve the device battery.
- **exclude** (*Optional*): Hosts not to include in nmap scanning.

A full example for the `nmap` tracker could look like the following sample:

```yaml
# Example configuration.yaml entry for nmap
device_tracker:
- platform: nmap_tracker
hosts: 192.168.1.1/24
home_interval: 10
exclude:
- 192.168.1.12
- 192.168.1.13
```


See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
Loading