From a6ade458c70b8c05aa65e3c5dbf8fe14258735cb Mon Sep 17 00:00:00 2001
From: Fabian Affolter <mail@fabian-affolter.ch>
Date: Thu, 5 Apr 2018 18:45:20 +0200
Subject: [PATCH] Add new configuration variable (#5117)

---
 .../device_tracker.asuswrt.markdown           | 49 +++++++++++++++----
 1 file changed, 40 insertions(+), 9 deletions(-)

diff --git a/source/_components/device_tracker.asuswrt.markdown b/source/_components/device_tracker.asuswrt.markdown
index 4d809108e90..7889253ce98 100644
--- a/source/_components/device_tracker.asuswrt.markdown
+++ b/source/_components/device_tracker.asuswrt.markdown
@@ -19,6 +19,8 @@ The `asuswrt` platform offers presence detection by looking at connected devices
 This platform is **NOT** available for [Microsoft Windows installations](http://pexpect.readthedocs.io/en/stable/overview.html#pexpect-on-windows).
 </p>
 
+### {% linkable_title Configuration %}
+
 To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file:
 
 ```yaml
@@ -29,15 +31,44 @@ device_tracker:
     username: YOUR_ADMIN_USERNAME
 ```
 
-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** (*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`.
-- **port** (*Optional*): SSH port to use. Defaults to `22`.
-- **mode** (*Optional*): The operating mode of the router (`router` or `ap`). Defaults to `router`.
-- **ssh_key** (*Optional*): The path to your SSH private key file associated with your given admin account (instead of password).
+{% configuration %}
+host:
+  description: "The IP address of your router, eg. `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 (use this if no SSH key is given)."
+  required: false
+  type: string
+protocol:
+  description: "The protocol (`ssh` or `telnet`) to use."
+  required: false
+  type: string
+  default: ssh
+port:
+  description: SSH port to use.
+  required: false
+  type: int
+  default: 22
+mode:
+  description: "The operating mode of the router (`router` or `ap`)."
+  required: false
+  type: string
+  default: router
+ssh_key:
+  description: The path to your SSH private key file associated with your given admin account (instead of password).
+  required: false
+  type: string
+require_ip:
+  description: If the router is in access point mode.
+  required: false
+  type: boolean
+  default: true
+{% endconfiguration %}
 
 <p class='note warning'>
 You need to [enable telnet](https://www.asus.com/support/faq/1005449/) on your router if you choose to use `protocol: telnet`.