Lock

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 actions lock.lock, lock.unlock, and lock.open (unlatch) to control locks.

Note

构建模块集成

这个 lock 是一个构建模块集成,无法直接添加到你的 Home Assistant 中,但可以被其他集成使用和提供。

构建模块集成不同于典型的与设备或服务连接的集成。相反,其他将设备或服务集成到 Home Assistant 中的集成使用这个 lock 构建模块来提供实体、服务和其他你可以在自动化或仪表板中使用的功能。

如果你的某个集成具有这个构建模块,这个页面记录了 lock 构建模块所提供的功能。

The state of a lock entity

A lock entity can have the following states:

  • Jammed: The lock is currently jammed.
  • Open: Indication of whether the lock is currently open.
  • Opening: Indication of whether the lock is currently opening.
  • Locked: The lock is currently locked.
  • Locking: The lock is in the process of being locked.
  • Unlocked: The lock is currently unlocked.
  • Unlocking: The lock is in the process of being unlocked.
  • Unavailable: The entity is currently unavailable.
  • Unknown: The state is not yet known.

Actions

A lock integration provides the following actions:

Action lock.lock

Lock your door, the attribute should appear under a ‘data’ attribute for the action.

Data attribute Optional Description
entity_id no Entity of the relevant lock.

Example

actions:
  action: lock.lock
  target:
    entity_id: lock.my_place

Action lock.unlock

Unlock your door, the attribute should appear under a ‘data’ attribute for the action.

Data attribute Optional Description
entity_id no Entity of the relevant lock.

Example

actions:
  action: lock.unlock
  target:
    entity_id: lock.my_place

Use the actions

Go to the Developer Tools, then to Actions in the frontend, and choose lock.lock, lock.unlock or lock.open from the list of available actions. Enter something like the sample below into the data field and select Perform action.

{"entity_id":"lock.front_door"}
Data attribute Optional Description
entity_id yes Only act on specific lock. Use entity_id: all to target all.