home-assistant.github.io/source/_components/lock.lockitron.markdown
Alok Saboo 1aca7b08cf Misc fixes: e.g. -> e.g., and proper case for Home Assistant (#4942)
* e.g. to e.g., and proper case for Home Assistant

* Instructions how to -> Instructions on how to
2018-03-17 20:20:37 +01:00

31 lines
1 KiB
Markdown

---
layout: page
title: "Lockitron Lock"
description: "Instructions on how to integrate Lockitron locks into Home Assistant."
date: 2017-03-24 00:00
sidebar: true
comments: false
sharing: true
footer: true
logo: lockitron.png
ha_category: Lock
ha_iot_class: "Cloud Polling"
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).
```yaml
lock:
- platform: lockitron
access_token: asdf
id: fdsa
```
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).