mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-23 01:06:52 +00:00
Add Asuswrt component and sensor (#7324)
* Adding component and sensor to Asuswrt * Changes * fix * Right * Better grammar and correct category * title
This commit is contained in:
kennedyshead
Martin Hjelmare
parent
b171ab5e65
commit
8a837c527a
70
source/_components/asuswrt.markdown
Normal file
70
source/_components/asuswrt.markdown
Normal file
@ -0,0 +1,70 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Asuswrt"
|
||||
description: "Instructions on how to integrate Asuswrt into Home Assistant."
|
||||
date: 2017-01-05 17:30
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: asus.png
|
||||
ha_category: Hub
|
||||
ha_release: 0.83
|
||||
ha_iot_class: "Local Polling"
|
||||
---
|
||||
|
||||
The `asuswrt` component is the main component to connect to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
asuswrt:
|
||||
host: YOUR_ROUTER_IP
|
||||
username: YOUR_ADMIN_USERNAME
|
||||
```
|
||||
|
||||
{% configuration %}
|
||||
host:
|
||||
description: "The IP address of your router, eg. `192.168.1.1`."
|
||||
required: true
|
||||
type: string
|
||||
username:
|
||||
description: "The username of a 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: integer
|
||||
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`.
|
||||
</p>
|
||||
@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: page
|
||||
title: "ASUSWRT"
|
||||
description: "Instructions on how to integrate ASUSWRT based routers into Home Assistant."
|
||||
title: "Asuswrt Device Tracker"
|
||||
description: "Instructions on how to integrate Asuswrt device tracker into Home Assistant."
|
||||
date: 2015-08-06 19:00
|
||||
sidebar: true
|
||||
comments: false
|
||||
@ -15,63 +15,8 @@ ha_release: pre 0.7
|
||||
|
||||
The `asuswrt` platform offers presence detection by looking at connected devices to a [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) based router.
|
||||
|
||||
<p class='note warning'>
|
||||
This platform is **NOT** available for [Microsoft Windows installations](http://pexpect.readthedocs.io/en/stable/overview.html#pexpect-on-windows).
|
||||
</p>
|
||||
The platform will be automatically configured if Asuswrt component is configured.
|
||||
|
||||
### {% linkable_title Configuration %}
|
||||
For more configuration information see the [Asuswrt component](/components/asuswrt/) documentation.
|
||||
|
||||
To use an ASUSWRT router in your installation, add the following to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
# Example configuration.yaml entry
|
||||
device_tracker:
|
||||
- platform: asuswrt
|
||||
host: YOUR_ROUTER_IP
|
||||
username: YOUR_ADMIN_USERNAME
|
||||
```
|
||||
|
||||
{% 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: integer
|
||||
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`.
|
||||
</p>
|
||||
|
||||
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.
|
||||
20
source/_components/sensor.asuswrt.markdown
Normal file
20
source/_components/sensor.asuswrt.markdown
Normal file
@ -0,0 +1,20 @@
|
||||
---
|
||||
layout: page
|
||||
title: "Asuswrt Sensor"
|
||||
description: "Instructions on how to integrate Asuswrt sensors into Home Assistant."
|
||||
date: 2017-08-30 12:21
|
||||
sidebar: true
|
||||
comments: false
|
||||
sharing: true
|
||||
footer: true
|
||||
logo: asus.png
|
||||
ha_category: System Monitor
|
||||
ha_iot_class: "Local Polling"
|
||||
ha_release: 0.83
|
||||
---
|
||||
|
||||
The `asuswrt` platform allows you to get data from your [ASUSWRT](http://event.asus.com/2013/nw/ASUSWRT/) sensors from within Home Assistant.
|
||||
|
||||
The sensor platform will be automatically configured if Asuswrt component is configured.
|
||||
|
||||
For more configuration information see the [Asuswrt component](/components/asuswrt/) documentation.
|
||||
Loading…
x
Reference in New Issue
Block a user