mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-11-11 12:01:28 +00:00
Xiaomi Aquara: move lock docs to hub (#35115)
This commit is contained in:
@@ -1,22 +0,0 @@
|
|||||||
---
|
|
||||||
title: "Xiaomi Aqara Lock"
|
|
||||||
description: "Instructions on how to setup the Xiaomi Aqara Lock within Home Assistant."
|
|
||||||
ha_category:
|
|
||||||
- Lock
|
|
||||||
ha_release: 0.71
|
|
||||||
ha_iot_class: Local Push
|
|
||||||
ha_domain: xiaomi_aqara
|
|
||||||
---
|
|
||||||
|
|
||||||
|
|
||||||
The `xiaomi aqara` lock platform allows you to get data (`changed_by` property, `verified_wrong_times` attribute) from your [Xiaomi](https://www.mi.com/en/) Aqara locks.
|
|
||||||
|
|
||||||
An Aqara lock cannot be controlled by Home Assistant.
|
|
||||||
|
|
||||||
The property `changed_by` provides the user/key ID of the last successful unlock.
|
|
||||||
|
|
||||||
If someone tries to unlock the device but fails more than 3 times the `verified_wrong_times` attribute will be incremented. The counter resets on a successful unlock.
|
|
||||||
|
|
||||||
Use of this platform requires that you have set up the [Xiaomi Aqara](/integrations/xiaomi_aqara/) component.
|
|
||||||
|
|
||||||
|
|
||||||
@@ -84,19 +84,31 @@ name:
|
|||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### Actions
|
## Entities
|
||||||
|
|
||||||
|
The Xiaomi Gateway (Aqara) integration supports the following entities.
|
||||||
|
|
||||||
|
### Locks
|
||||||
|
|
||||||
|
An Aqara lock cannot be controlled by Home Assistant. However, the lock entity allows you to view the following data:
|
||||||
|
|
||||||
|
- The property `changed_by` provides the user/key ID of the last successful unlock.
|
||||||
|
|
||||||
|
- If someone tries to unlock the device but fails more than 3 times, the `verified_wrong_times` attribute will be incremented. The counter resets on a successful unlock.
|
||||||
|
|
||||||
|
## Actions
|
||||||
|
|
||||||
The gateway provides the following actions:
|
The gateway provides the following actions:
|
||||||
|
|
||||||
#### Action `xiaomi_aqara.play_ringtone`
|
### Action `xiaomi_aqara.play_ringtone`
|
||||||
|
|
||||||
Play a specific ringtone. The version of the gateway firmware must be `1.4.1_145` at least. Take a look at the examples below.
|
Play a specific ringtone. The version of the gateway firmware must be `1.4.1_145` at least. Take a look at the examples below.
|
||||||
|
|
||||||
| Data attribute | Optional | Description |
|
| Data attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------------------------------------|
|
| -------------- | -------- | --------------------------------------- |
|
||||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
| `ringtone_id` | no | One of the allowed ringtone ids |
|
| `ringtone_id` | no | One of the allowed ringtone ids |
|
||||||
| `ringtone_vol` | yes | The volume in percent |
|
| `ringtone_vol` | yes | The volume in percent |
|
||||||
|
|
||||||
Allowed values of the `ringtone_id` are:
|
Allowed values of the `ringtone_id` are:
|
||||||
|
|
||||||
@@ -128,30 +140,30 @@ Allowed values of the `ringtone_id` are:
|
|||||||
- 29 - Thinker
|
- 29 - Thinker
|
||||||
- Custom ringtones (uploaded by the Mi Home app) starting from 10001
|
- Custom ringtones (uploaded by the Mi Home app) starting from 10001
|
||||||
|
|
||||||
#### Action `xiaomi_aqara.stop_ringtone`
|
### Action `xiaomi_aqara.stop_ringtone`
|
||||||
|
|
||||||
Stops a playing ringtone immediately.
|
Stops a playing ringtone immediately.
|
||||||
|
|
||||||
| Data attribute | Optional | Description |
|
| Data attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------------------------------------|
|
| -------------- | -------- | --------------------------------------- |
|
||||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
|
||||||
#### Action `xiaomi_aqara.add_device`
|
### Action `xiaomi_aqara.add_device`
|
||||||
|
|
||||||
Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.
|
Enables the join permission of the Xiaomi Aqara Gateway for 30 seconds. A new device can be added afterwards by pressing the pairing button once.
|
||||||
|
|
||||||
| Data attribute | Optional | Description |
|
| Data attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------------------------------------|
|
| -------------- | -------- | --------------------------------------- |
|
||||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
|
||||||
#### Action `xiaomi_aqara.remove_device`
|
### Action `xiaomi_aqara.remove_device`
|
||||||
|
|
||||||
Removes a specific device. The removal is required if a device shall be paired with another gateway.
|
Removes a specific device. The removal is required if a device shall be paired with another gateway.
|
||||||
|
|
||||||
| Data attribute | Optional | Description |
|
| Data attribute | Optional | Description |
|
||||||
|---------------------------|----------|-------------------------------------------------------|
|
| -------------- | -------- | ---------------------------------------- |
|
||||||
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
| `device_id` | no | Hardware address of the device to remove |
|
| `device_id` | no | Hardware address of the device to remove |
|
||||||
|
|
||||||
## Examples
|
## Examples
|
||||||
|
|
||||||
|
|||||||
@@ -174,6 +174,7 @@ layout: null
|
|||||||
/integrations/light.knx /integrations/knx#light
|
/integrations/light.knx /integrations/knx#light
|
||||||
/integrations/light.mysensors /integrations/mysensors#light
|
/integrations/light.mysensors /integrations/mysensors#light
|
||||||
/integrations/light.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-philips-light
|
/integrations/light.xiaomi_miio /integrations/xiaomi_miio/#xiaomi-philips-light
|
||||||
|
/integrations/lock.xiaomi_aqara/ /integrations/xiaomi_aqara/#locks
|
||||||
/integrations/media_player.group /integrations/group
|
/integrations/media_player.group /integrations/group
|
||||||
/integrations/notify.command_line /integrations/command_line#Notify
|
/integrations/notify.command_line /integrations/command_line#Notify
|
||||||
/integrations/notify.group /integrations/group#notify-groups
|
/integrations/notify.group /integrations/group#notify-groups
|
||||||
|
|||||||
Reference in New Issue
Block a user