jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-19 07:17:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Lock: add states (#34689)

Browse Source
This commit is contained in:
c0ffeeca7 2024-09-11 15:31:25 +02:00 committed by GitHub
parent 39ccceabfc
commit 35dc147d7e
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
source/_integrations/lock.markdown
View File

@ -18,19 +18,30 @@ Keeps track which locks are in your environment, their state and allows you to c
{% include integrations/building_block_integration.md %}
### Actions
## 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.
- **Unlocking**: The lock is in the process of being unlocked.
## Actions
A lock integration provides the following actions:
#### Action `lock.lock`
### 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
#### Example
```yaml
action:
@ -39,15 +50,15 @@ action:
entity_id: lock.my_place
```
#### Action `lock.unlock`
### 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
#### Example
```yaml
action:
@ -56,7 +67,7 @@ action:
entity_id: lock.my_place
```
### Use the actions
## 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**.
@ -65,5 +76,5 @@ Go to the **Developer Tools**, then to **Actions** in the frontend, and choose `
```
| Data attribute | Optional | Description |
| ---------------------- | -------- | -------------------------------------------------------------- |
| -------------- | -------- | -------------------------------------------------------------- |
| `entity_id` | yes | Only act on specific lock. Use `entity_id: all` to target all. |