Minimizing of the configuration sample (#1040)

This commit is contained in:
Fabian Affolter 2016-10-02 17:13:58 +02:00 committed by GitHub
parent 1ee63170cf
commit be80d1bb7b
23 changed files with 151 additions and 130 deletions

View File

@ -27,16 +27,16 @@ To use this device tracker in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: actiontec - platform: actiontec
host: YOUR_ROUTER_IP host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: 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*. - **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account. - **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. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -28,17 +28,17 @@ To use this device tracker in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: aruba - platform: aruba
host: YOUR_ROUTER_IP host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: Configuration variables:
- **host** *Required*: The IP address of your router, e.g. 192.168.1.1. - **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*. - **username** (*Required*): The username of an user with administrative privileges, usually `admin`.
- **password** *Required*: The password for your given admin account. - **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. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -20,21 +20,18 @@ To use an ASUSWRT router in your installation, add the following to your `config
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: asuswrt - platform: asuswrt
host: YOUR_ROUTER_IP host: YOUR_ROUTER_IP
protocol: telnet username: YOUR_ADMIN_USERNAME
mode: router
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: 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`. - **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`. - **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). - **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password).
<p class='note warning'> <p class='note warning'>

View File

@ -20,20 +20,20 @@ To use an Automatic ODB reader in your installation, add the following to your `
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: automatic - platform: automatic
client_id: 1234567 client_id: 1234567
secret: 0987654321 secret: 0987654321
username: your@email.com username: your@email.com
password: your_password password: your_password
devices: devices:
- 2007 Honda Element - 2007 Honda Element
- 2004 Subaru Impreza - 2004 Subaru Impreza
``` ```
Configuration variables: Configuration variables:
- **client_id** (*Required*): The OAuth client id (get from https://developer.automatic.com/). - **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. - **username** (*Required*): The username associated with your ODB reader.
- **password** (*Required*): The password for your given ODB reader account. - **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. - **devices** (*Optional*): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.

View File

@ -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: To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry
device_tracker: 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. 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). 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 ```bash
sudo apt-get install libcap2-bin $ sudo apt-get install libcap2-bin
sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\`` $ sudo setcap 'cap_net_raw,cap_net_admin+eip' `readlink -f \`which python3\``
``` ```
A restart of Home Assistant is required. A restart of Home Assistant is required.

View File

@ -9,20 +9,20 @@ sharing: true
footer: true footer: true
logo: bluetooth.png logo: bluetooth.png
ha_category: Presence Detection ha_category: Presence Detection
ha_iot_class: "Local Poll" ha_iot_class: "Local Polling"
ha_release: 0.18 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! 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`.
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: To use the Bluetooth tracker in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry
device_tracker: 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/). For additional configuration variables check the [Device tracker page](/components/device_tracker/).

View File

@ -19,11 +19,8 @@ To use a BT Home Hub 5 router in your installation, add the following to your `c
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: bt_home_hub_5 - platform: bt_home_hub_5
host: 192.168.1.254 host: 192.168.1.254
interval_seconds: 10
consider_home: 180
track_new_devices: yes
``` ```
Configuration variables: Configuration variables:

View File

@ -19,16 +19,16 @@ To use a DD-WRT router in your installation, add the following to your `configur
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: ddwrt - platform: ddwrt
host: ROUTER_IP_ADDRESS host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. - **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*. - **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account. - **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. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -24,16 +24,13 @@ To use an Fritz!Box router in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: fritz - platform: fritz
host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: 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. - **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*. - **username** (*Optional*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Optional*): The password for your given admin account. - **password** (*Optional*): The password for your given admin account.
<p class='note'> <p class='note'>

View File

@ -22,9 +22,9 @@ To integrate iCloud in Home Assistant, add the following section to your `config
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: icloud - platform: icloud
username: USERNAME username: USERNAME
password: PASSWORD password: PASSWORD
``` ```
Configuration variables: Configuration variables:

View File

@ -18,7 +18,7 @@ To integrate Locative in Home Assistant, add the following section to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: locative - platform: locative
``` ```
Install on your smartphone: Install on your smartphone:

View File

@ -9,6 +9,7 @@ sharing: true
footer: true footer: true
logo: openwrt.png logo: openwrt.png
ha_category: Presence Detection 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/)._ _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: Before this scanner can be used you have to install the luci RPC package on OpenWRT:
```bash ```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: 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 ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: luci - platform: luci
host: ROUTER_IP_ADDRESS host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. - **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*. - **username** (*Required*): The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account. - **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. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -20,10 +20,10 @@ To get started add the following lines to your `configuration.yaml` (example for
```yaml ```yaml
# Example configuration.yaml entry for Netgear device # Example configuration.yaml entry for Netgear device
device_tracker: device_tracker:
platform: netgear - platform: netgear
host: 192.168.1.1 host: 192.168.1.1
username: admin username: admin
password: YOUR_PASSWORD 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: 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 | | `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. | | `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. 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` %} # {% linkable_title `known_devices.yaml` %}

View File

@ -19,11 +19,10 @@ To use this device tracker in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: mqtt - platform: mqtt
qos: 1 devices:
devices: paulus_oneplus: /location/paulus
paulus_oneplus: /location/paulus annetherese_n4: /location/annetherese
annetherese_n4: /location/annetherese
``` ```
Configuration variables: Configuration variables:

View File

@ -21,17 +21,16 @@ To use this device tracker in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: netgear - platform: netgear
host: YOUR_ROUTER_IP host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
port: YOUR_ROUTER_PORT
``` ```
Configuration variables: Configuration variables:
- **host** (*Required*): The IP address of your router, e.g. 192.168.1.1. - **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*. - **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account. - **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) - **port** (*Optional*): The port your router communicates with (defaults to 5000, but 80 is also known to be used on some models)

View File

@ -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`). 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: To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: nmap_tracker - platform: nmap_tracker
hosts: 192.168.1.1/24 hosts: 192.168.1.1/24
home_interval: 10
exclude:
- 192.168.1.12
- 192.168.1.13
``` ```
Configuration variables: 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. - **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. - **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. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

View File

@ -23,12 +23,7 @@ To integrate Owntracks in Home Assistant, add the following section to your `con
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: owntracks - platform: owntracks
max_gps_accuracy: 200
waypoints: True
waypoint_whitelist:
- jon
- ram
``` ```
Configuration variables: 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`. - **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. - **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 %} ### {% 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 `<username>_<device-id>` and could be set in app configuration. More details about this config can found in [device tracker](/components/device_tracker/). 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 `<username>_<device-id>` and could be set in app configuration. More details about this config can found in [device tracker](/components/device_tracker/).

View File

@ -20,6 +20,7 @@ This device tracker needs SNMP to be enabled on the router.
</p> </p>
OID examples: OID examples:
- Mikrotik: `1.3.6.1.4.1.14988.1.1.1.2.1.1` (confirmed, unknown RouterOS version/model) - Mikrotik: `1.3.6.1.4.1.14988.1.1.1.2.1.1` (confirmed, unknown RouterOS version/model)
- Mikrotik: `1.3.6.1.2.1.4.22.1.2` (confirmed, RouterOS 6.x on RB2011) - Mikrotik: `1.3.6.1.2.1.4.22.1.2` (confirmed, RouterOS 6.x on RB2011)
- Aruba: `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2` (untested) - Aruba: `1.3.6.1.4.1.14823.2.3.3.1.2.4.1.2` (untested)
@ -32,10 +33,10 @@ To use the SNMP platform in your installation, add the following to your `config
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: snmp - platform: snmp
host: 192.168.1.1 host: 192.168.1.1
community: public community: public
baseoid: 1.3.6.1.4.1.14988.1.1.1.2.1.1 baseoid: 1.3.6.1.4.1.14988.1.1.1.2.1.1
``` ```
Configuration variables: Configuration variables:

View File

@ -21,10 +21,10 @@ To use this device tracker in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: thomson - platform: thomson
host: YOUR_ROUTER_IP host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: Configuration variables:

View File

@ -8,21 +8,22 @@ comments: false
sharing: true sharing: true
footer: true footer: true
ha_category: Presence Detection ha_category: Presence Detection
ha_release: pre 0.7
--- ---
Tomato requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code. The `tomato` platform requires an extra config variable called `http_id`. The value can be obtained by logging in to the Tomato admin interface and search for `http_id` in the page source code.
To use this device tracker in your installation, add the following to your `configuration.yaml` file: To use this device tracker in your installation, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: tomato - platform: tomato
host: YOUR_ROUTER_IP_ADDRESS host: YOUR_ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
http_id: YOUR_HTTP_ID http_id: YOUR_HTTP_ID
``` ```
Configuration variables: Configuration variables:

View File

@ -13,15 +13,15 @@ ha_release: pre 0.7
--- ---
This platform allows you to detect presence by looking at connected devices to a [TP-Link](https://www.tp-link.com) device. This includes the ArcherC9 line. The `tplink` platform allows you to detect presence by looking at connected devices to a [TP-Link](https://www.tp-link.com) device. This includes the ArcherC9 line.
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: tplink - platform: tplink
host: YOUR_ROUTER_IP host: YOUR_ROUTER_IP
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: Configuration variables:

View File

@ -57,10 +57,10 @@ After this is done, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: ubus - platform: ubus
host: ROUTER_IP_ADDRESS host: ROUTER_IP_ADDRESS
username: YOUR_ADMIN_USERNAME username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD password: YOUR_ADMIN_PASSWORD
``` ```
Configuration variables: Configuration variables:

View File

@ -20,20 +20,17 @@ To use this device tracker in your installation, add the following to your `conf
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: device_tracker:
platform: unifi - platform: unifi
host: CONTROLLER username: YOUR_ADMIN_USERNAME
port: PORT password: YOUR_ADMIN_PASSWORD
username: YOUR_ADMIN_USERNAME
password: YOUR_ADMIN_PASSWORD
site_id: SITE_ID
``` ```
Configuration variables: Configuration variables:
- **host** (*Optional*): The hostname or IP address of your controller. Defaults to localhost. - **host** (*Optional*): The hostname or IP address of your controller. Defaults to `localhost`.
- **port** (*Optional*): The port of your controller's web interface. Defaults to 8443. - **port** (*Optional*): The port of your controller's web interface. Defaults to `8443`.
- **username** (*Required*: The username of an user with administrative privileges, usually *admin*. - **username** (*Required*: The username of an user with administrative privileges, usually `admin`.
- **password** (*Required*): The password for your given admin account. - **password** (*Required*): The password for your given admin account.
- **site_id** (*Optional*): Allows you to specify a site_id for device tracking. Defaults to "default". Found in the URL of the controller (i.e. https://CONTROLLER:PORT/manage/site/SITE_ID/dashboard) - **site_id** (*Optional*): Allows you to specify a `site_id` for device tracking. Defaults to `default`. Found in the URL of the controller (i.e. https://CONTROLLER:PORT/manage/site/SITE_ID/dashboard)
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked. See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.