Updated sesame component docs

This commit is contained in:
Jerry Chong 2019-04-30 16:48:10 +08:00
parent 0e4cc5e1dd
commit 611df65d75

View File

@ -21,23 +21,20 @@ The `sesame` platform allows you to control your [Sesame](https://candyhouse.co/
Your Sesame needs to be paired with a mobile device running the app in *virtual station* mode, or a standalone [Wi-Fi Access Point](https://candyhouse.co/collections/frontpage/products/wi-fi-access-point). Your Sesame needs to be paired with a mobile device running the app in *virtual station* mode, or a standalone [Wi-Fi Access Point](https://candyhouse.co/collections/frontpage/products/wi-fi-access-point).
You will also need to generate an API key from [my.candyhouse.co](https://my.candyhouse.co/#/credentials).
Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file: Once you have remote access enabled using one of the above AND the Integration - cloud option enabled on the Sesame app for that lock settings, add the following to your `configuration.yaml` file:
```yaml ```yaml
# Example configuration.yaml entry # Example configuration.yaml entry
lock: lock:
- platform: sesame - platform: sesame
email: YOUR_E_MAIL_ADDRESS api_key: YOUR_API_KEY
password: YOUR_PASSWORD
``` ```
{% configuration %} {% configuration %}
email: api_key:
description: The email address for your Sesame account. description: The API key for your Sesame account.
required: true
type: string
password:
description: The password for your Sesame account.
required: true required: true
type: string type: string
{% endconfiguration %} {% endconfiguration %}