home-assistant.io/source/_components/lock.markdown

layout, title, description, date, sidebar, comments, sharing, footer

layout	title	description	date	sidebar	comments	sharing	footer
page	Locks	Instructions on how to setup your locks with Home Assistant.	2015-11-21 08:10	true	false	true	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, lock.unlock and lock.open (unlatch) to control locks.

{% linkable_title Services %}

A lock component provides the following services:

{% linkable_title Service lock.lock %}

Lock your door, the attribute should appear under a 'data' attribute for the service.

Service data attribute	Optional	Description
entity_id	no	Entity of the relevant lock.

{% linkable_title Example %}

action:
  service: lock.lock
  data:
    entity_id: lock.my_place

{% linkable_title Service lock.unlock %}

Unlock your door, the attribute should appear under a 'data' attribute for the service.

Service data attribute	Optional	Description
entity_id	no	Entity of the relevant lock.

{% linkable_title Example %}

action:
  service: lock.unlock
  data:
    entity_id: lock.my_place

{% linkable_title Use the services %}

Go to the Developer Tools, then to Call Service in the frontend, and choose lock.lock, lock.unlock or lock.open from the list of available services (Services: on the left). Enter something like the sample below into the Service Data field and hit CALL SERVICE.

{"entity_id":"lock.front_door"}

Service data attribute	Optional	Description
entity_id	yes	Only act on specific lock. Else targets all.