diff --git a/source/_components/device_tracker.automatic.markdown b/source/_components/device_tracker.automatic.markdown index 9d38582459d..638dc63c52b 100644 --- a/source/_components/device_tracker.automatic.markdown +++ b/source/_components/device_tracker.automatic.markdown @@ -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. diff --git a/source/_components/device_tracker.bluetooth_le_tracker.markdown b/source/_components/device_tracker.bluetooth_le_tracker.markdown index 335a38bfb77..bf32000dc5e 100644 --- a/source/_components/device_tracker.bluetooth_le_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_le_tracker.markdown @@ -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. @@ -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. diff --git a/source/_components/device_tracker.bluetooth_tracker.markdown b/source/_components/device_tracker.bluetooth_tracker.markdown index ff4e0e67e6e..807e8e35fb7 100644 --- a/source/_components/device_tracker.bluetooth_tracker.markdown +++ b/source/_components/device_tracker.bluetooth_tracker.markdown @@ -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/). diff --git a/source/_components/device_tracker.bt_home_hub_5.markdown b/source/_components/device_tracker.bt_home_hub_5.markdown index 3318cdc65ee..9fd185eadd8 100644 --- a/source/_components/device_tracker.bt_home_hub_5.markdown +++ b/source/_components/device_tracker.bt_home_hub_5.markdown @@ -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: diff --git a/source/_components/device_tracker.ddwrt.markdown b/source/_components/device_tracker.ddwrt.markdown index 311324a6300..7cb07f3ba6b 100644 --- a/source/_components/device_tracker.ddwrt.markdown +++ b/source/_components/device_tracker.ddwrt.markdown @@ -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. diff --git a/source/_components/device_tracker.fritz.markdown b/source/_components/device_tracker.fritz.markdown index 3d35a033274..fa7ae119426 100644 --- a/source/_components/device_tracker.fritz.markdown +++ b/source/_components/device_tracker.fritz.markdown @@ -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.
diff --git a/source/_components/device_tracker.icloud.markdown b/source/_components/device_tracker.icloud.markdown
index 220eda5d01e..4c19a009cc4 100644
--- a/source/_components/device_tracker.icloud.markdown
+++ b/source/_components/device_tracker.icloud.markdown
@@ -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:
diff --git a/source/_components/device_tracker.locative.markdown b/source/_components/device_tracker.locative.markdown
index 9e4f6b7b0af..2379db6bfb9 100644
--- a/source/_components/device_tracker.locative.markdown
+++ b/source/_components/device_tracker.locative.markdown
@@ -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:
diff --git a/source/_components/device_tracker.luci.markdown b/source/_components/device_tracker.luci.markdown
index 81e60df206c..937193752e5 100644
--- a/source/_components/device_tracker.luci.markdown
+++ b/source/_components/device_tracker.luci.markdown
@@ -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/)._
@@ -18,7 +19,7 @@ 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:
@@ -26,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: 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.
diff --git a/source/_components/device_tracker.markdown b/source/_components/device_tracker.markdown
index 505018e1f4a..b1b0950313f 100644
--- a/source/_components/device_tracker.markdown
+++ b/source/_components/device_tracker.markdown
@@ -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:
@@ -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` %}
diff --git a/source/_components/device_tracker.mqtt.markdown b/source/_components/device_tracker.mqtt.markdown
index 2019f1ef573..b8c4518e04a 100644
--- a/source/_components/device_tracker.mqtt.markdown
+++ b/source/_components/device_tracker.mqtt.markdown
@@ -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:
diff --git a/source/_components/device_tracker.netgear.markdown b/source/_components/device_tracker.netgear.markdown
index 005773f2186..780fc170d11 100644
--- a/source/_components/device_tracker.netgear.markdown
+++ b/source/_components/device_tracker.netgear.markdown
@@ -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)
diff --git a/source/_components/device_tracker.nmap_tracker.markdown b/source/_components/device_tracker.nmap_tracker.markdown
index 6334ab3a0b1..08c8114071d 100644
--- a/source/_components/device_tracker.nmap_tracker.markdown
+++ b/source/_components/device_tracker.nmap_tracker.markdown
@@ -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.
diff --git a/source/_components/device_tracker.owntracks.markdown b/source/_components/device_tracker.owntracks.markdown
index b63c97d8dbf..78eb5a7d5c1 100644
--- a/source/_components/device_tracker.owntracks.markdown
+++ b/source/_components/device_tracker.owntracks.markdown
@@ -23,12 +23,7 @@ To integrate Owntracks in Home Assistant, add the following section to your `con
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: owntracks
- max_gps_accuracy: 200
- waypoints: True
- waypoint_whitelist:
- - jon
- - ram
+ - platform: owntracks
```
Configuration variables:
@@ -37,6 +32,19 @@ Configuration variables:
- **waypoints** (*Optional*): Owntracks users can define [waypoints](http://owntracks.org/booklet/features/waypoints/) (a.k.a regions) which are similar in spirit to Home Assistant zones. If this configuration variable is `True`, the Owntracks users who are in `waypoint_whitelist` can export waypoints from the device and Home Assistant will import them as zone definitions. Defaults to `True`.
- **waypoint_whitelist** (*Optional*): A list of user names (as defined for [Owntracks](https://home-assistant.io/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. Defaults to all users who are connected to Home Assistant via Owntracks.
+A full sample configuration for the `owntracks` plaftfrom is shown below:
+
+```yaml
+# Example configuration.yaml entry
+device_tracker:
+ - platform: owntracks
+ max_gps_accuracy: 200
+ waypoints: True
+ waypoint_whitelist:
+ - jon
+ - ram
+```
+
### {% linkable_title Using Owntracks with other device trackers %}
Owntracks can also be used with other device trackers, such as [Nmap](/components/device_tracker.nmap_scanner/) or [Netgear](/components/device_tracker.netgear/). To do this, fill in the `mac` field to the Owntracks entry in `known_devices.yaml` with the MAC address of the device you want to track. This way the state of the device will be determined by the source that reported last. The naming convention for known device list is `