J. Nick Koston c384116e8e
Add config flow to august (#12172)
Co-authored-by: Franck Nijhof <frenck@frenck.nl>
2020-02-27 13:48:42 +01:00

2.9 KiB

title, description, logo, ha_category, ha_release, ha_iot_class, ha_config_flow, ha_codeowners
title description logo ha_category ha_release ha_iot_class ha_config_flow ha_codeowners
August Instructions on how to integrate your August devices into Home Assistant. august.png
Doorbell
Binary Sensor
Sensor
Camera
Lock
0.64 Cloud Polling true
@bdraco

The august integration allows you to integrate your August devices in Home Assistant.

There is currently support for the following device types within Home Assistant:

  • Doorbell
  • Binary Sensor
  • Sensor
  • Camera
  • Lock
August Lock 2nd Gen will need either August Connect or Doorbell to connect to Home Assistant.

Configuration

You will need your August login information (username (either phone# or email), and password) to use this module.

To add August to your installation, go to Configuration >> Integrations in the UI, click the button with + sign and from the list of integrations select August.

Alternatively, add the following to your configuration.yaml file:

# Example configuration.yaml entry
august:
  login_method: phone
  username: "+16041234567"
  password: YOUR_PASSWORD

{% 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: integer 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.

Binary Sensor

If you have an August Doorbell, once you have enabled the August component, you should see following sensors:

  • Doorbell ding sensor
  • Doorbell motion sensor
  • Doorbell online sensor

If you have an August Smart Lock with DoorSense, once you have enabled the August component, you should see the following sensors:

  • Door sensor

Camera

The august camera platform allows you to view the latest camera image (triggered by motion) by your August device in Home Assistant.

Sensor

If you have an August Doorbell with a battery, once you have enabled the August component, you should see the following sensors:

  • Doorbell Battery

If you have an August Smart Lock, once you have enabled the August component, you should see the following sensors:

  • Lock Battery

If you have an August Keypad, once you have enabled the August component, you should see the following sensors:

  • Keypad Battery