mirror of
https://github.com/home-assistant/home-assistant.io.git
synced 2025-07-19 15:26:59 +00:00
Xiaomi Aqara: New services added and description of the existing services updated (#3836)
* New services added and description of the existing services updated. * Make title linkable
This commit is contained in:
parent
257dea75e6
commit
6d4f765366
@ -47,7 +47,7 @@ The `xiaomi_aqara` component allows you to integrate [Xiaomi](http://www.mi.com/
|
|||||||
- Decoupled mode of the Aqara Wall Switches (Single & Double)
|
- Decoupled mode of the Aqara Wall Switches (Single & Double)
|
||||||
- Additional alarm events of the Gas and Smoke Detector: Analog alarm, battery fault alarm (smoke detector only), sensitivity fault alarm, I2C communication failure
|
- Additional alarm events of the Gas and Smoke Detector: Analog alarm, battery fault alarm (smoke detector only), sensitivity fault alarm, I2C communication failure
|
||||||
|
|
||||||
## Setup
|
## {% linkable_title Setup %}
|
||||||
|
|
||||||
Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key from within the app following [this tutorial](https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832).
|
Follow the setup process using your phone and Mi-Home app. From here you will be able to retrieve the key from within the app following [this tutorial](https://community.home-assistant.io/t/beta-xiaomi-gateway-integration/8213/1832).
|
||||||
|
|
||||||
@ -109,24 +109,90 @@ xiaomi_aqara:
|
|||||||
host:
|
host:
|
||||||
description: The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
description: The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
|
||||||
required: false
|
required: false
|
||||||
type: string
|
type: string
|
||||||
{% endconfiguration %}
|
{% endconfiguration %}
|
||||||
|
|
||||||
### {% linkable_title Services %}
|
### {% linkable_title Services %}
|
||||||
|
|
||||||
The gateway provides two services: `xiaomi_aqara.play_ringtone` and `xiaomi_aqara.stop_ringtone`. To play ringtones by Home Assistant, the version of the gateway firmware must be `1.4.1_145` at least. A `ringtone_id` and `gw_mac` must be supplied. The parameter `ringtone_vol` (percent) is optional. Allowed values of the `ringtone_id` are:
|
The gateway provides the following services:
|
||||||
|
|
||||||
- alarm ringtones [0-8]
|
#### {% linkable_title Service xiaomi_aqara.play_ringtone %}
|
||||||
- doorbell ring [10-13]
|
|
||||||
- alarm clock [20-29]
|
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.
|
||||||
- custom ringtones (uploaded by the Mi Home app) starting from 10001
|
|
||||||
|
| Service data attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------|
|
||||||
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
| `ringtone_id` | no | One of the allowed ringtone ids |
|
||||||
|
| `ringtone_vol` | yes | The volume in percent |
|
||||||
|
|
||||||
|
Allowed values of the `ringtone_id` are:
|
||||||
|
|
||||||
|
- Alarms
|
||||||
|
- 0 - Police car 1
|
||||||
|
- 1 - Police car 2
|
||||||
|
- 2 - Accident
|
||||||
|
- 3 - Countdown
|
||||||
|
- 4 - Ghost
|
||||||
|
- 5 - Sniper rifle
|
||||||
|
- 6 - Battle
|
||||||
|
- 7 - Air raid
|
||||||
|
- 8 - Bark
|
||||||
|
- Doorbells
|
||||||
|
- 10 - Doorbell
|
||||||
|
- 11 - Knock at a door
|
||||||
|
- 12 - Amuse
|
||||||
|
- 13 - Alarm clock
|
||||||
|
- Alarm clock
|
||||||
|
- 20 - MiMix
|
||||||
|
- 21 - Enthusiastic
|
||||||
|
- 22 - GuitarClassic
|
||||||
|
- 23 - IceWorldPiano
|
||||||
|
- 24 - LeisureTime
|
||||||
|
- 25 - ChildHood
|
||||||
|
- 26 - MorningStreamLiet
|
||||||
|
- 27 - MusicBox
|
||||||
|
- 28 - Orange
|
||||||
|
- 29 - Thinker
|
||||||
|
- Custom ringtones (uploaded by the Mi Home app) starting from 10001
|
||||||
|
|
||||||
|
#### {% linkable_title Service xiaomi_aqara.stop_ringtone %}
|
||||||
|
|
||||||
|
Stops a playing ringtone immediately.
|
||||||
|
|
||||||
|
| Service data attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------|
|
||||||
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
|
||||||
|
#### {% linkable_title Service xiaomi_aqara.add_device %}
|
||||||
|
|
||||||
|
| Service data attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------|
|
||||||
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
|
||||||
|
#### {% linkable_title Service 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.
|
||||||
|
|
||||||
|
| Service data attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------|
|
||||||
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
|
||||||
|
#### {% linkable_title Service xiaomi_aqara.remove_device %}
|
||||||
|
|
||||||
|
Removes a specific device. The removal is required if a device shall be paired with another gateway.
|
||||||
|
|
||||||
|
| Service data attribute | Optional | Description |
|
||||||
|
|---------------------------|----------|-------------------------------------------------------|
|
||||||
|
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
|
||||||
|
| `device_id` | no | Hardware address of the device to remove |
|
||||||
|
|
||||||
## {% linkable_title Examples %}
|
## {% linkable_title Examples %}
|
||||||
|
|
||||||
### Long Press on Smart Button
|
### {% linkable_title Long Press on Smart Button %}
|
||||||
|
|
||||||
|
This example plays the sound of a dog barking when the button is held down, and stops the sound when the button is pressed once.
|
||||||
|
|
||||||
This example plays the sound of a dog barking when the button is held down,
|
|
||||||
and stops the sound when the button is pressed once.
|
|
||||||
*Note: The sound will stop playing automatically when it has ended.*
|
*Note: The sound will stop playing automatically when it has ended.*
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
|
Loading…
x
Reference in New Issue
Block a user