Add Mikrotik hub category and update example config (#10044)

* Updating for Mikrotik Hub

* Add hub category and example config
This commit is contained in:
Robert Dunmire III 2019-08-08 14:30:09 -04:00 committed by Franck Nijhof
parent a904b18d87
commit 429995413c

View File

@ -3,6 +3,7 @@ title: "MikroTik"
description: "Instructions on how to integrate MikroTik/RouterOS based devices into Home Assistant." description: "Instructions on how to integrate MikroTik/RouterOS based devices into Home Assistant."
logo: mikrotik.png logo: mikrotik.png
ha_category: ha_category:
- Hub
- Presence Detection - Presence Detection
ha_release: 0.44 ha_release: 0.44
redirect_from: redirect_from:
@ -11,7 +12,11 @@ redirect_from:
The `mikrotik` platform offers presence detection by looking at connected devices to a [MikroTik RouterOS](http://mikrotik.com) based router. The `mikrotik` platform offers presence detection by looking at connected devices to a [MikroTik RouterOS](http://mikrotik.com) based router.
## Configuring `mikrotik` device tracker There is currently support for the following device types within Home Assistant:
- Presence Detection
## Configuring `mikrotik` hub
You have to enable accessing the RouterOS API on your router to use this platform. You have to enable accessing the RouterOS API on your router to use this platform.
@ -33,9 +38,8 @@ To use a MikroTik router in your installation, add the following to your `config
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
device_tracker: mikrotik:
- platform: mikrotik - host: IP_ADDRESS
host: IP_ADDRESS
username: ROUTEROS_USERNAME username: ROUTEROS_USERNAME
password: ROUTEROS_PASSWORD password: ROUTEROS_PASSWORD
``` ```
@ -70,9 +74,14 @@ ssl:
default: false default: false
type: boolean type: boolean
method: method:
description: Override autodetection of device scanning method. Can be `wireless` to use local wireless registration, `capsman` for capsman wireless registration, or `ip` for DHCP leases. description: Override autodetection of device scanning method. Can be `wireless` to use local wireless registration, `capsman` for capsman wireless registration, or `dhcp` for DHCP leases.
required: false required: false
type: string type: string
arp_ping:
description: Use ARP ping with DHCP method for device scanning.
required: false
default: false
type: boolean
{% endconfiguration %} {% endconfiguration %}
<div class='note info'> <div class='note info'>
@ -113,17 +122,25 @@ To use this device tracker you need restricted privileges only. To enhance the s
/user set password="YOUR_PASSWORD" homeassistant /user set password="YOUR_PASSWORD" homeassistant
``` ```
## Using the additional configuration to the `mikrotik` device tracker entry in your `configuration.yaml` file: ## Using the additional configuration to the `mikrotik` entry in your `configuration.yaml` file:
```yaml ```yaml
device_tracker: mikrotik:
- platform: mikrotik - host: 192.168.88.1
host: 192.168.88.1 username: homeassistant
password: YOUR_PASSWORD
ssl: true
arp_ping: true
method: dhcp
track_devices: true
- host: 192.168.88.2
username: homeassistant username: homeassistant
password: YOUR_PASSWORD password: YOUR_PASSWORD
ssl: true ssl: true
port: 8729 port: 8729
method: capsman method: capsman
track_devices: true
``` ```
See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked. See the [device tracker integration page](/components/device_tracker/) for instructions on how to configure the people to be tracked.