From f689e39b570c11854438d40ef8211db12d79ddd6 Mon Sep 17 00:00:00 2001 From: miniconfig Date: Sat, 21 Nov 2015 09:43:47 -0500 Subject: [PATCH] Added documentation for new lock support --- source/_components/lock.markdown | 27 +++++++++++++++++++++++++++ source/_components/lock.wink.markdown | 18 ++++++++++++++++++ source/_components/wink.markdown | 2 +- source/components/lock.html | 1 + source/components/lock.wink.html | 1 + 5 files changed, 48 insertions(+), 1 deletion(-) create mode 100644 source/_components/lock.markdown create mode 100644 source/_components/lock.wink.markdown create mode 100644 source/components/lock.html create mode 100644 source/components/lock.wink.html diff --git a/source/_components/lock.markdown b/source/_components/lock.markdown new file mode 100644 index 00000000000..a905a990b9a --- /dev/null +++ b/source/_components/lock.markdown @@ -0,0 +1,27 @@ +--- +layout: component +title: "Locks" +description: "Instructions how to setup your locks with Home Assistant." +date: 2015-11-21 08:10 +sidebar: true +comments: false +sharing: true +footer: true +--- + +Keeps track which locks are in your environment, their state and allows you to control them. + + * Maintains a state per lock and a combined state `all_locks`. + * Registers services `lock/lock` and `lock/unlock` to control locks. + +### {% linkable_title Use the services %} + +Go the the **Developer Tools**, then to **Call Service** in the frontend, and choose `lock/lock` or `lock/unlock` from the list of available services (**Available services:** on the left). Enter something like the sample below into the **Service Data** field and hit **CALL SERVICE**. + +```json +{"entity_id":"lock.front_door"} +``` + +| Service data attribute | Optional | Description | +| ---------------------- | -------- | ----------- | +| `entity_id` | yes | Only act on specific lock. Else targets all. diff --git a/source/_components/lock.wink.markdown b/source/_components/lock.wink.markdown new file mode 100644 index 00000000000..656c149151c --- /dev/null +++ b/source/_components/lock.wink.markdown @@ -0,0 +1,18 @@ +--- +layout: component +title: "Wink lock" +description: "Instructions how to setup the Wink locks within Home Assistant." +date: 2015-11-20 12:00 +sidebar: true +comments: false +sharing: true +footer: true +logo: wink.png +ha_category: Lock +--- + + +The wink lock platform allows you to control your [Wink](http://www.wink.com/) locks. + +The requirement is that you have setup your [Wink hub](/components/wink/). + diff --git a/source/_components/wink.markdown b/source/_components/wink.markdown index 5f7ecf0cbe3..bebe9368ac2 100644 --- a/source/_components/wink.markdown +++ b/source/_components/wink.markdown @@ -18,7 +18,7 @@ featured: true Wink offers one, quick and simple way to connect people with the products they rely on every day in their home. -Home Assistant integrates the Wink hub and allows you to get the status and control connected switches, lights and sensors. +Home Assistant integrates the Wink hub and allows you to get the status and control connected switches, lights, locks, and sensors. To get started with the Wink API, you will first need to get yourself an API access token. Because it is very difficult right now to get access to their API, John McLaughlin has created the form below to get you one. diff --git a/source/components/lock.html b/source/components/lock.html new file mode 100644 index 00000000000..6c9ac303d78 --- /dev/null +++ b/source/components/lock.html @@ -0,0 +1 @@ + diff --git a/source/components/lock.wink.html b/source/components/lock.wink.html new file mode 100644 index 00000000000..2c1c7d2917b --- /dev/null +++ b/source/components/lock.wink.html @@ -0,0 +1 @@ +