Updated description for keenetic_ndms2 integration (#14142)

This commit is contained in:
Andrey Kupreychik 2021-02-14 19:27:15 +07:00 committed by GitHub
parent 2100f28af6
commit 45e44ad93d
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -10,43 +10,9 @@ ha_codeowners:
ha_domain: keenetic_ndms2
---
This integration offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/)
Router running NDMS2 firmware.
This platform offers presence detection by examining devices connected to a [Keenetic](https://keenetic.net/)
Router running NDMS firmware versions 2.05 and up. It uses telnet connection so make sure telnet is not disabled on your router.
To use a Keenetic router in your installation, add the following to your `configuration.yaml` file:
## Configuration
```yaml
# Example configuration.yaml entry
device_tracker:
- platform: keenetic_ndms2
host: YOUR_HOST
username: YOUR_USERNAME
password: YOUR_PASSWORD
```
{% 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 integration page](/integrations/device_tracker/) for instructions how to configure the people to be tracked.
To add Keenetic router to your installation, go to **Configuration** >> **Integrations** in the UI, click the button with `+` sign and from the list of integrations select **Keenetic NDMS2 Router**.