jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 01:37:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update all device tracker configuration variables (#6635)

Browse Source 
* Update all device tracker configuration variables

* Fix ubus

* fix ubus add missing quotes

* Fix build

* Fix owntracks build

* Update after review

automatic & netgear
This commit is contained in:
Emeric 2018-10-10 09:50:00 +02:00 committed by Franck Nijhof
parent 0ab12a0b07
commit 8d92afe7f6
25 changed files with 415 additions and 161 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
source/_components/device_tracker.aruba.markdown
View File

@ -34,11 +34,19 @@ device_tracker:
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.
{% configuration %}
host:
description: The IP address of your router, e.g., `192.168.1.1`.
required: true
type: string
username:
description: The username of an user with administrative privileges, usually `admin`.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

29
source/_components/device_tracker.automatic.markdown
View File

@ -37,20 +37,32 @@ device_tracker:
- 2004 Subaru Impreza
```
Configuration variables:
- **client_id** (*Required*): The OAuth client id (get from https://developer.automatic.com/).
- **secret** (*Required*): The OAuth client secret (get from https://developer.automatic.com/).
- **current_location** (*Optional*): Set to `true` if you have requested `scope:current_location` for your account. Home Assistant will then be able to receive periodic location updates during trips.
- **devices** (*Optional*): The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.
{% configuration %}
client_id:
description: "The OAuth client id (get from https://developer.automatic.com/)."
required: true
type: string
secret:
description: "The OAuth client secret (get from https://developer.automatic.com/)."
required: true
type: string
current_location:
description: "Set to `true` if you have requested `scope:current_location` for your account. Home Assistant will then be able to receive periodic location updates during trips."
required: false
default: false
type: boolean
devices:
description: The list of vehicle display names you wish to track. If not provided, all vehicles will be tracked.
required: false
type: list
{% endconfiguration %}
Home Assistant will also fire events when an update is received from Automatic. These can be used to trigger automations, as shown in the example below. A list of available event types can be found in the [Automatic Real-Time Events documentation](https://developer.automatic.com/api-reference/#real-time-events).
```yaml
# Example automatic event automation
automation:
- trigger:
- trigger:
- platform: event
event_type: automatic_update
event_data:
@ -60,6 +72,7 @@ automation:
action:
- service: light.turn_off
```
<p class='note'>
You can obtain the correct ID for your vehicle from your known_devices.yaml file. Be sure to lower-case any letters contained in your vehicle's ID when using it in an automation trigger.
</p>

16
source/_components/device_tracker.bluetooth_le_tracker.markdown
View File

@ -36,10 +36,18 @@ device_tracker:
- platform: bluetooth_le_tracker
```
Configuration variables:
- **track_new_devices** (*Optional*): If new discovered devices are tracked by default. Defaults to `True`.
- **interval_seconds** (*Optional*): Seconds between each scan for new devices. Defaults to `12` seconds.
{% configuration %}
track_new_devices:
description: If new discovered devices are tracked by default.
required: false
default: true
type: boolean
interval_seconds:
description: Seconds between each scan for new devices.
required: false
default: 12
type: integer
{% endconfiguration %}
As some BT LE devices change their MAC address regularly, a new device is only discovered when it has been seen 5 times.
Some BTLE devices (e.g., fitness trackers) are only visible to the devices that they are paired with. In this case, the BTLE tracker won't see this device.

11
source/_components/device_tracker.bt_home_hub_5.markdown
View File

@ -11,7 +11,6 @@ logo: bt.png
ha_category: Presence Detection
---
This platform offers presence detection by looking at connected devices to a [BT Home Hub 5](https://en.wikipedia.org/wiki/BT_Home_Hub) based router.
To use a BT Home Hub 5 router in your installation, add the following to your `configuration.yaml` file:
@ -23,8 +22,12 @@ device_tracker:
host: 192.168.1.254
```
Configuration variables:
- **host** (*Optional*): The IP address of your router, Default: 192.168.1.254.
{% configuration %}
host:
description: The IP address of your router.
required: false
default: 192.168.1.254
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

25
source/_components/device_tracker.cisco_ios.markdown
View File

@ -18,7 +18,7 @@ This is a presence detection scanner for [Cisco](http://www.cisco.com) IOS devic
This device tracker needs SSH to be enabled on the router.
</p>
Before using this scanner it is recommended that you lower the ARP cache timeout on your router, as Cisco IOS normally comes with a 4 hour default ARP cache timeout.
Before using this scanner it is recommended that you lower the ARP cache timeout on your router, as Cisco IOS normally comes with a 4 hour default ARP cache timeout.
For example, the following commands will lower the timeout to 2 minutes on Vlan1:
@ -43,7 +43,7 @@ copy running-config startup-config
```
<p class='note warning'>
If you have a very large number of devices on your VLan (+1000), then you may want to adjust the ARP cache timeout to suit your needs. See [this discussion](https://supportforums.cisco.com/discussion/10169296/arp-timeout) to learn more.
If you have a very large number of devices on your VLan (+1000), then you may want to adjust the ARP cache timeout to suit your needs. See [this discussion](https://supportforums.cisco.com/discussion/10169296/arp-timeout) to learn more.
</p>
To use this device tracker in your installation, add the following to your `configuration.yaml` file:
@ -57,12 +57,19 @@ device_tracker:
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.
- **password** (*Required*): The password for your given admin account.
{% configuration %}
host:
description: The IP address of your router, e.g., 192.168.1.1.
required: true
type: string
username:
description: The username of an user with administrative privileges.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

19
source/_components/device_tracker.ddwrt.markdown
View File

@ -25,11 +25,20 @@ device_tracker:
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.
{% configuration %}
host:
description: The IP address of your router, e.g., `192.168.1.1`.
required: true
type: string
username:
description: The username of an user with administrative privileges, usually `admin`.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
{% endconfiguration %}
By default Home Assistant pulls information about connected devices from DD-WRT every 5 seconds.
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

20
source/_components/device_tracker.fritz.markdown
View File

@ -31,15 +31,23 @@ device_tracker:
- 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`.
- **password** (*Optional*): The password for your given admin account.
{% configuration %}
host:
description: The IP address of your router, e.g., `192.168.1.1`. It is optional since every fritzbox is also reachable by using the IP address 169.254.1.1.
required: false
type: string
username:
description: The username of an user with administrative privileges, usually `admin`.
required: false
type: string
password:
description: The password for your given admin account.
required: false
type: string
{% endconfiguration %}
<p class='note'>
It seems that it is not necessary to use it in current generation Fritz!Box routers because the necessary data can be retrieved anonymously.
</p>
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

11
source/_components/device_tracker.geofency.markdown
View File

@ -22,9 +22,12 @@ device_tracker:
- platform: geofency
```
Configuration variables:
- **mobile_beacons** (*Optional*): List of beacon names that are to be treated as *mobile*. The name must match the name you configure in Geofency. By default, beacons will be treated as *stationary*.
{% configuration %}
mobile_beacons:
description: List of beacon names that are to be treated as *mobile*. The name must match the name you configure in Geofency. By default, beacons will be treated as *stationary*.
required: false
type: list
{% endconfiguration %}
A full sample configuration for the `geofency` platform is shown below:
@ -43,4 +46,4 @@ Geofency will automatically generate the device tracker name used for geofences,
When you enter a geofence or stationary beacon, your location name in Home Assistant will be set to the name of the geofence or beacon location in Geofency. When you exit a geofence or stationary beacon, your location name in Home Assistant will be set to 'not home'. For mobile beacons, the location name will be 'not_home' whenever the beacon is entered or exited outside of a [zone](/components/zone/), otherwise, it will be set to the name of the zone.
To make Geofency work better with the [proximity](/components/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.
To make Geofency work better with the [proximity](/components/proximity/) component, you should enable the 'Send Current Location' feature in the Webhook configuration screen. This ensures that the _current_ GPS coordinates are included in exit events instead of the coordinates of the (center of) the zone that was exited.

33
source/_components/device_tracker.icloud.markdown
View File

@ -13,7 +13,7 @@ ha_release: "0.10"
---
The `icloud` platform allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices.
The `icloud` platform allows you to detect presence using the [iCloud](https://www.icloud.com/) service. iCloud allows users to track their location on iOS devices.
It does require that your device is registered with "Find My iPhone".
@ -28,13 +28,30 @@ device_tracker:
account_name: accountname
```
Configuration variables:
- **username** (*Required*): The username for the iCloud account.
- **password** (*Required*): The password for your given username.
- **account_name** (*Optional*): The friendly name for the account_name. If this isn't given, it will use the account_name of the username (so the part before the `@` in the email address).
- **max_interval** (*Optional*): Maximum interval in minutes between subsequent location upates. This tracker uses dynamic intervals for requesting location updates. When iphone is stationary, interval will eventually be set to `max_interval` to save battery. When iphone starts moving again interval will be dynamically updated to 1 min. Note that updating interval to 1 min might be delayed by maximum `max_interval` minutes. Default is 30 min. Minimum value is 1 min.
- **gps_accuracy_threshold** (*Optional*): iCloud location updates come with some gps_accuracy varying from 10 to 5000 meters. This setting defines the accuracy threshold in meters for a location update. Less accurate updates will be discarded by this tracker. This allows more precise location monitoring and fewer false positive zone changes. Default is 1000 meters.
{% configuration %}
username:
description: The username for the iCloud account.
required: true
type: string
password:
description: The password for your given username.
required: true
type: string
account_name:
description: The friendly name for the account_name. If this isn't given, it will use the account_name of the username (so the part before the `@` in the email address).
required: false
type: string
max_interval:
description: Maximum interval in minutes between subsequent location upates. This tracker uses dynamic intervals for requesting location updates. When iphone is stationary, interval will eventually be set to `max_interval` to save battery. When iphone starts moving again interval will be dynamically updated to 1 min. Note that updating interval to 1 min might be delayed by maximum `max_interval` minutes. Minimum value is 1 min.
required: false
default: 30
type: integer
gps_accuracy_threshold:
description: iCloud location updates come with some gps_accuracy varying from 10 to 5000 meters. This setting defines the accuracy threshold in meters for a location update. Less accurate updates will be discarded by this tracker. This allows more precise location monitoring and fewer false positive zone changes.
required: false
default: 1000
type: integer
{% endconfiguration %}
<p class='note warning'>
Low `max_interval` may cause battery drainage as it wakes up your device to get the current location.

38
source/_components/device_tracker.keenetic_ndms2.markdown
View File

@ -21,18 +21,34 @@ To use a Keenetic router in your installation, add the following to your `config
# Example configuration.yaml entry
device_tracker:
- platform: keenetic_ndms2
host: !secret router_ip
username: !secret router_username
password: !secret router_password
host: YOUR_HOST
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
Configuration variables:
- **host** (*Required*): The IP address of your router, e.g., 192.168.1.1.
- **port** (*Optional*): The Telnet port of your router. Default is 23.
- **username** (*Required*): The username to login into the router (user should have read access to telnet interface of the router).
- **password** (*Required*): The password for the specified username.
- **interface** (*Optional*): Ihe internal name of the interface to get devices connected to. Default is 'Home'. For expert users only.
{% configuration %}
host:
description: The IP address of your router, e.g., 192.168.1.1.
required: true
type: string
port:
description: The Telnet port of your router.
required: false
default: 23
type: integer
username:
description: The username to login into the router (user should have read access to telnet interface of the router).
required: true
type: string
password:
description: The password for the specified username.
required: true
type: string
interface:
description: Ihe internal name of the interface to get devices connected to. For expert users only.
required: false
default: Home
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

25
source/_components/device_tracker.linksys_ap.markdown
View File

@ -29,12 +29,25 @@ device_tracker:
password: YOUR_PASSWORD
```
Configuration variables:
- **host** (*Required*): The hostname or IP address of your access point, eg. `192.168.1.1`.
- **username** (*Required*): The username of an user with administrative privileges (read-only is sufficient).
- **password** (*Required*): The password for your given admin account.
- **verify_ssl** (*Optional*): Verify SSL certificate for HTTPS request. Defaults to true.
{% configuration %}
host:
description: The hostname or IP address of your access point, e.g., `192.168.1.1`.
required: true
type: string
username:
description: The username of an user with administrative privileges (read-only is sufficient).
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
verify_ssl:
description: Verify SSL certificate for HTTPS request.
required: false
default: true
type: boolean
{% endconfiguration %}
## {% linkable_title Example %}

9
source/_components/device_tracker.linksys_smart.markdown
View File

@ -34,8 +34,11 @@ device_tracker:
host: 192.168.1.1
```
Configuration variables:
- **host** (*Required*): The hostname or IP address of your router, eg. `192.168.1.1`.
{% configuration %}
host:
description: The hostname or IP address of your router, e.g., `192.168.1.1`.
required: true
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

28
source/_components/device_tracker.luci.markdown
View File

@ -37,16 +37,28 @@ device_tracker:
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.
- **ssl** (*Optional*): If your router enforces SSL connections, set to `true`. Defaults to `false`.
{% configuration %}
host:
description: The hostname or IP address of your router, e.g., `192.168.1.1`.
required: true
type: string
username:
description: The username of an user with administrative privileges, usually `admin`.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
ssl:
description: If your router enforces SSL connections, set to `true`.
required: false
default: false
type: boolean
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
<p class='note warning'>
Some installations have [a small bug](https://github.com/openwrt/luci/issues/576). The timeout for luci RPC calls is not set and this makes the call fail.
Some installations have [a small bug](https://github.com/openwrt/luci/issues/576). The timeout for luci RPC calls is not set and this makes the call fail.
</p>

25
source/_components/device_tracker.mikrotik.markdown
View File

@ -41,11 +41,24 @@ device_tracker:
password: ADMIN_PASSWORD
```
Configuration variables:
- **host** (*Required*): The IP address of your router.
- **username** (*Required*: The username of an user with administrative privileges.
- **password** (*Required*): The password for your given admin account.
- **port** (*Optional*): Mikrotik API port. Defaults to `8728`.
{% configuration %}
host:
description: The IP address of your router.
required: true
type: string
username:
description: The username of an user with administrative privileges.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
port:
description: Mikrotik API port.
required: false
default: 8728
type: integer
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

15
source/_components/device_tracker.mqtt.markdown
View File

@ -26,11 +26,16 @@ device_tracker:
annetherese_n4: 'location/annetherese'
```
Configuration variables:
- **devices** (*Required*): List of devices with their topic.
- **qos** (*Optional*): The QoS level of the topic.
{% configuration %}
devices:
description: List of devices with their topic.
required: true
type: list
qos:
description: The QoS level of the topic.
required: false
type: integer
{% endconfiguration %}
Example JSON you can publish to the topic (e.g., via mqtt.publish service):

46
source/_components/device_tracker.netgear.markdown
View File

@ -26,16 +26,42 @@ device_tracker:
password: YOUR_ADMIN_PASSWORD
```
Configuration variables:
- **url** (*Optional*): The base URL, e.g., `http://routerlogin.com:5000` for example. If not provided `host` and `port` are used. If none provided autodetection of the URL will be used.
- **host** (*Optional*): The IP address of your router, e.g., `192.168.1.1`.
- **port** (*Optional*): The port your router communicates with.
- **username** (*Optional*): The username of a user with administrative privileges. If not provided `admin` will be used.
- **password** (*Required*): The password for your given admin account.
- **devices** (*Optional*): If provided only specified devices will be reported. Can be MAC address or the device name as reported in the Netgear UI.
- **exclude** (*Optional*): Devices to exclude from the scan.
- **accesspoints** (*Optional*): Also track devices on the specified APs. Only supports MAC address.
{% configuration %}
url:
description: The base URL, e.g., `http://routerlogin.com:5000` for example. If not provided `host` and `port` are used. If none provided autodetection of the URL will be used.
required: false
type: string
host:
description: The IP address of your router, e.g., `192.168.1.1`.
required: false
type: string
port:
description: The port your router communicates with.
required: false
default: 5000
type: integer
username:
description: The username of a user with administrative privileges.
required: false
default: admin
type: string
password:
description: The password for your given admin account.
required: true
type: string
devices:
description: If provided only specified devices will be reported. Can be MAC address or the device name as reported in the Netgear UI.
required: false
type: list
exclude:
description: Devices to exclude from the scan.
required: false
type: list
accesspoints:
description: Also track devices on the specified APs. Only supports MAC address.
required: false
type: list
{% endconfiguration %}
When `accesspoints` is specified an extra device will be reported for each device connected to the APs specified here, as `MY-LAPTOP on RBS40`. `Router` will be reported as AP name for the main AP. Only tested with Orbi.

27
source/_components/device_tracker.nmap_tracker.markdown
View File

@ -19,7 +19,7 @@ As an alternative to the router-based device tracking, it is possible to directl
Please keep in mind that modern smart phones will usually turn off WiFi when they are idle. Simple trackers like this may not be reliable on their own.
</p>
You might have to install the packages for `arp` and `nmap`. On Debian based hosts (for example Hassbian and Raspbian) do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
You might have to install the packages for `arp` and `nmap`. On Debian based hosts (for example Hassbian and Raspbian) do so by running `$ sudo apt-get install net-tools nmap`. On a Fedora host run `$ sudo dnf -y install nmap`.
<p class='note'>
If you are using [Hass.io](/hassio/) then just move forward to the configuration as all requirements are already fulfilled.
@ -36,12 +36,25 @@ device_tracker:
hosts: 192.168.1.0/24
```
Configuration variables:
- **hosts** (*Required*): The network address to scan (in any supported Nmap format). Mixing subnets and IPs is possible.
- **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. Scanning the host where Home Assistant is running can cause problems (websocket error), so excluding that host is a good idea.
- **scan_options** (*Optional*): Configurable scan options for Nmap. Default to `-F --host-timeout 5s`
{% configuration %}
hosts:
description: The network address to scan (in any supported Nmap format). Mixing subnets and IPs is possible.
required: true
type: string
home_interval:
description: The number of minutes Nmap will not scan this device, assuming it is home, in order to preserve the device battery.
required: false
type: integer
exclude:
description: Hosts not to include in Nmap scanning. Scanning the host where Home Assistant is running can cause problems (websocket error), so excluding that host is a good idea.
required: false
type: list
scan_options:
description: Configurable scan options for Nmap.
required: false
default: -F --host-timeout 5s
type: string
{% endconfiguration %}
## {% linkable_title Examples %}

46
source/_components/device_tracker.owntracks.markdown
View File

@ -25,15 +25,39 @@ device_tracker:
- platform: owntracks
```
Configuration variables:
- **max_gps_accuracy** (*Optional*): Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account.
- **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](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. This would be the `username` portion of the Base Topic Name, (e.g., owntracks/**username**/iPhone). Defaults to all users who are connected to Home Assistant via Owntracks.
- **secret** (*Optional*): [Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present.
- **mqtt_topic** (*Optional*): The topic to subscribe for Owntracks updates on your MQTT instance (defaults to `owntracks/#`).
- **events_only** (*Optional*): Home Assistant will ignore all location updates and rely solely on geofence enter/leave events.
- **region_mapping** (*Optional*): Dictionary to remap names of regions as configured in the Owntracks app to Home Assistant zones. Use this if you have multiple homes or Home Assistant instances and want to map a different label to 'home'. `key: value` maps Owntracks region `key` to Home Assistant zone `value`.
{% configuration %}
max_gps_accuracy:
description: Sometimes Owntracks can report GPS location with a very low accuracy (few kilometers). That can trigger false zoning in your Home Assistant installation. With the parameter, you can filter these GPS reports. The number has to be in meter. For example, if you put 200 only GPS report with an accuracy under 200 will be take in account.
required: false
type: integer
waypoints:
description: "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."
required: false
default: true
type: boolean
waypoint_whitelist:
description: "A list of user names (as defined for [Owntracks](/components/device_tracker.owntracks/)) who can export their waypoints from Owntracks to Home Assistant. This would be the `username` portion of the Base Topic Name, (e.g., owntracks/**username**/iPhone)"
required: false
default: All users who are connected to Home Assistant via Owntracks.
type: list
secret:
description: "[Payload encryption key](http://owntracks.org/booklet/features/encrypt/). This is usable when communicating with a third-party untrusted server or a public server (where anybody can subscribe to any topic). By default the payload is assumed to be unencrypted (although the communication between Home Assistant and the server might still be encrypted). This feature requires the `libsodium` library to be present."
required: false
type: string
mqtt_topic:
description: The topic to subscribe for Owntracks updates on your MQTT instance.
required: false
default: owntracks/#
type: string
events_only:
description: Home Assistant will ignore all location updates and rely solely on geofence enter/leave events.
required: false
type: boolean
region_mapping:
description: "Dictionary to remap names of regions as configured in the Owntracks app to Home Assistant zones. Use this if you have multiple homes or Home Assistant instances and want to map a different label to 'home'. `key: value` maps Owntracks region `key` to Home Assistant zone `value`."
required: false
type: list
{% endconfiguration %}
A full sample configuration for the `owntracks` platform is shown below:
@ -42,9 +66,9 @@ A full sample configuration for the `owntracks` platform is shown below:
device_tracker:
- platform: owntracks
max_gps_accuracy: 200
waypoints: True
waypoints: true
mqtt_topic: "owntracks/#"
events_only: True
events_only: true
waypoint_whitelist:
- jon
- ram

11
source/_components/device_tracker.sky_hub.markdown
View File

@ -23,9 +23,12 @@ device_tracker:
- platform: sky_hub
```
Configuration variables:
- **host** (*Optional*): The IP address of your router. Defaults to `192.168.1.254`.
{% configuration %}
host:
description: The IP address of your router.
required: false
default: 192.168.1.254
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

35
source/_components/device_tracker.snmp.markdown
View File

@ -54,18 +54,33 @@ If you want to use encryption, you must enable SNMP version 3 by adding `authkey
device_tracker:
- platform: snmp
host: 192.168.1.1
community: username
authkey: authpass
privkey: privpass
community: USERNAME
authkey: AUTHPASS
privkey: PRIVPASS
baseoid: 1.3.6.1.4.1.14988.1.1.1.2.1.1
```
Configuration variables:
- **host** (*Required*): The IP address of the router, eg. 192.168.1.1.
- **community** (*Required*): The SNMP community which is set for the device. Most devices have a default community set to `public` with read-only permission (which is sufficient).
- **baseoid** (*Required*): The OID prefix where wireless client registrations can be found, usually vendor specific. It's advised to use the numerical notation. To find this base OID, check vendor documentation or check the MIB file for your device.
- **authkey** (*Inclusive*): Authentication key for SNMPv3. Variable privkey must also be set.
- **privkey** (*Inclusive*): Privacy key SNMPv3. Variable authkey must also be set.
{% configuration %}
host:
description: The IP address of the router, e.g., 192.168.1.1.
required: true
type: string
community:
description: The SNMP community which is set for the device. Most devices have a default community set to `public` with read-only permission (which is sufficient).
required: true
type: string
baseoid:
description: The OID prefix where wireless client registrations can be found, usually vendor specific. It's advised to use the numerical notation. To find this base OID, check vendor documentation or check the MIB file for your device.
required: true
type: string
authkey:
description: Authentication key for SNMPv3. Variable privkey must also be set.
required: inclusive
type: string
privkey:
description: Privacy key SNMPv3. Variable authkey must also be set.
required: inclusive
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

10
source/_components/device_tracker.swisscom.markdown
View File

@ -27,8 +27,12 @@ device_tracker:
- platform: swisscom
```
Configuration variables:
- **host** (*Optional*): The IP address of your router. Set it if you are not using `192.168.1.1`.
{% configuration %}
host:
description: The IP address of your router.
required: false
default: 192.168.1.1
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

19
source/_components/device_tracker.thomson.markdown
View File

@ -27,10 +27,19 @@ device_tracker:
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*.
- **password** (*Required*): The password for your given admin account.
{% configuration %}
host:
description: The IP address of your router, e.g., 192.168.1.1.
required: true
type: string
username:
description: The username of an user with administrative privileges, usually *admin*.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

22
source/_components/device_tracker.tplink.markdown
View File

@ -36,11 +36,20 @@ device_tracker:
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 a user with administrative privileges, usually *admin*. The Archer D9 last firmware does not require a username.
- **password** (*Required*): The password for your given admin account.
{% configuration %}
host:
description: The IP address of your router, e.g., 192.168.1.1.
required: true
type: string
username:
description: The username of an user with administrative privileges, usually *admin*. The Archer D9 last firmware does not require a username.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
{% endconfiguration %}
For Archer C9 models running firmware version 150811 or later please use the encrypted password you can retrieve like this:
@ -54,6 +63,3 @@ For Archer C9 models running firmware version 150811 or later please use the enc
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
For Archer D9 model the default ip is 192.168.1.1, the username is not necessary and you can leave that field blank.

25
source/_components/device_tracker.ubus.markdown
View File

@ -63,12 +63,25 @@ device_tracker:
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 *root*.
- **password** (*Required*): The password for your given account.
- **dhcp_software** (*Optional*): The DHCP software used in your router: `dnsmasq`, `dhcpd`, or `none`. Defaults to `dnsmasq`.
{% configuration %}
host:
description: The IP address of your router, e.g., 192.168.1.1.
required: true
type: string
username:
description: The username of an user with administrative privileges, usually `root`.
required: true
type: string
password:
description: The password for your given admin account.
required: true
type: string
dhcp_software:
description: "The DHCP software used in your router: `dnsmasq`, `dhcpd`, or `none`."
required: false
default: dnsmasq
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.

11
source/_components/device_tracker.upc_connect.markdown
View File

@ -23,9 +23,13 @@ device_tracker:
- platform: upc_connect
```
Configuration variables:
- **host** (*Optional*): The IP address of your router. Set it if you are not using `192.168.0.1`.
{% configuration %}
host:
description: The IP address of your router.
required: false
default: 192.168.0.1
type: string
{% endconfiguration %}
See the [device tracker component page](/components/device_tracker/) for instructions how to configure the people to be tracked.
@ -33,4 +37,3 @@ Also known to be working with the following devices:
- Irish Virgin Media Super Hub 3.0
- Ziggo Connectbox NL
- Unitymedia Connect Box (DE)