mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-24 01:37:23 +00:00
Update Lockitron lock component configuration (#7178)
* Update Lockitron lock component configuration * Minor changes
This commit is contained in:
parent
48be6d87c7
commit
ced3a4325f
@ -14,18 +14,29 @@ ha_release: "0.42"
|
||||
---
|
||||
|
||||
The `lockitron` platform allows you to control your [Lockitron](https://lockitron.com/) lock from within Home Assistant.
|
||||
In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you.
|
||||
Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you).
|
||||
|
||||
## {% linkable_title Setup %}
|
||||
|
||||
In order to get the correct `access_token` and `id`, log on to their [developer page](https://api.lockitron.com/), create a new app, and get the access_token they give you. Then, call the retrieve all locks function on the page and get the id of your lock (make sure you get your lock's id and not the virtual lock they create for you).
|
||||
|
||||
## {% linkable_title Configuration %}
|
||||
|
||||
To enable the lock, add the following lines to your `configuration.yaml` file:
|
||||
|
||||
```yaml
|
||||
lock:
|
||||
- platform: lockitron
|
||||
access_token: asdf
|
||||
id: fdsa
|
||||
access_token: YOUR_ACCESS_TOKEN
|
||||
id: YOUR_ID
|
||||
```
|
||||
|
||||
Configuration variables:
|
||||
|
||||
- **access_token** (*Required*): The usernThe security token provided by Lockitron to lock and unlock your lock.
|
||||
- **id** (*Required*): The lock id given by Lockitron (should be a GUID).
|
||||
|
||||
{% configuration %}
|
||||
access_token:
|
||||
description: The security token provided by Lockitron to lock and unlock your lock.
|
||||
required: true
|
||||
type: string
|
||||
id:
|
||||
description: The lock id given by Lockitron (should be a GUID).
|
||||
required: true
|
||||
type: string
|
||||
{% endconfiguration %}
|
||||
|
Loading…
x
Reference in New Issue
Block a user