Added documentation for august component (#4696)

This commit is contained in:
Joe Lu 2018-02-23 10:23:16 -08:00 committed by Fabian Affolter
parent ad24a7f8af
commit 454d228710
5 changed files with 108 additions and 0 deletions

View File

@ -0,0 +1,50 @@
---
layout: page
title: "August"
description: "Instructions on how to integrate your August devices into Home Assistant."
date: 2018-02-17 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: august.png
ha_category: Hub
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
The `august` component allows you to integrate your [August](http://august.com) devices in Home Assistant. Currently this component supports August Lock and Doorbell.
You will need your August login information (username (either phone# or email), and password) to use this module.
To set it up, add the following to your `configuration.yaml` file:
```yaml
# Example configuration.yaml entry
august:
login_method: phone
username: "+16041234567"
password: secret
```
{% configuration %}
login_method:
description: Method to login to your August account, either "email" or "phone". A verification code will be sent to your email or phone during setup.
required: true
type: string
username:
description: The username for accessing your August account. This depends on your login_method, if login_method is email, this will be your email of the account. Otherwise, this will be your phone number.
required: true
type: string
password:
description: The password for accessing your August account.
required: true
type: string
timeout:
description: Timeout to wait for connections.
required: false
type: int
default: 10
{% endconfiguration %}
Once Home Assistant is started, a configurator will pop up asking you to enter verification code that is sent to your phone number or email.

View File

@ -0,0 +1,22 @@
---
layout: page
title: "August Binary Sensor"
description: "Instructions on how to integrate your August devices into Home Assistant."
date: 2018-02-17 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: august.png
ha_category: Binary Sensor
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
To get your [August](http://august.com) doorbell binary sensors working within Home Assistant, please follow the instructions for the general [August component](/components/august/).
If you have August Doorbell, once you have enabled the [August component](/components/august/), you should see following sensors:
* Doorbell ding sensor
* Doorbell motion sensor
* Doorbell online sensor

View File

@ -0,0 +1,18 @@
---
layout: page
title: "August Camera"
description: "Instructions on how to integrate your August devices into Home Assistant."
date: 2018-02-17 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: august.png
ha_category: Camera
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
The `august` camera platform allows you to view the latest camera image (triggered by motion) by your [August](http://august.com) device in Home Assistant.
To add `august` camera to your installation, follow instructions in [August component](/components/august/).

View File

@ -0,0 +1,18 @@
---
layout: page
title: "August Lock"
description: "Instructions on how to integrate your August devices into Home Assistant."
date: 2018-02-17 22:00
sidebar: true
comments: false
sharing: true
footer: true
logo: august.png
ha_category: Lock
ha_release: "0.64"
ha_iot_class: "Cloud Polling"
---
The `august` lock platform allows you to control your [August](http://august.com) lock from within Home Assistant.
To add `august` lock to your installation, follow instructions in [August component](/components/august/).

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB