Skip to content

Commit a06391b

Browse files
committed
Update format
1 parent 2c08379 commit a06391b

File tree

1 file changed

+13
-12
lines changed

1 file changed

+13
-12
lines changed

source/_components/xiaomi_aqara.markdown

Lines changed: 13 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ To enable {{ page.title }} in your installation, add the following to your `conf
5656
### {% linkable_title One Gateway %}
5757

5858
```yaml
59-
# You can leave mac empty if you only have one gateway.
59+
# You can leave MAC empty if you only have one gateway.
6060
xiaomi_aqara:
6161
discovery_retry: 5
6262
gateways:
@@ -66,7 +66,7 @@ xiaomi_aqara:
6666
### {% linkable_title Multiple Gateways %}
6767
6868
```yaml
69-
# 12 characters mac can be obtained from the gateway.
69+
# 12 characters MAC can be obtained from the gateway.
7070
xiaomi_aqara:
7171
gateways:
7272
- mac: xxxxxxxxxxxx
@@ -106,7 +106,7 @@ xiaomi_aqara:
106106
type: string
107107
default: any
108108
host:
109-
description: The host / ip address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
109+
description: The host/IP address of the gateway. If this parameter is used the multicast discovery of the gateway is skipped.
110110
required: false
111111
type: string
112112
{% endconfiguration %}
@@ -115,7 +115,7 @@ xiaomi_aqara:
115115
116116
The gateway provides the following services:
117117
118-
#### {% linkable_title Service xiaomi_aqara.play_ringtone %}
118+
#### {% linkable_title Service `xiaomi_aqara.play_ringtone` %}
119119

120120
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.
121121

@@ -155,29 +155,29 @@ Allowed values of the `ringtone_id` are:
155155
- 29 - Thinker
156156
- Custom ringtones (uploaded by the Mi Home app) starting from 10001
157157

158-
#### {% linkable_title Service xiaomi_aqara.stop_ringtone %}
158+
#### {% linkable_title Service `xiaomi_aqara.stop_ringtone` %}
159159

160160
Stops a playing ringtone immediately.
161161

162162
| Service data attribute | Optional | Description |
163163
|---------------------------|----------|-------------------------------------------------------|
164164
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
165165

166-
#### {% linkable_title Service xiaomi_aqara.add_device %}
166+
#### {% linkable_title Service `xiaomi_aqara.add_device` %}
167167

168168
| Service data attribute | Optional | Description |
169169
|---------------------------|----------|-------------------------------------------------------|
170170
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
171171

172-
#### {% linkable_title Service xiaomi_aqara.add_device %}
172+
#### {% linkable_title Service `xiaomi_aqara.add_device` %}
173173

174174
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.
175175

176176
| Service data attribute | Optional | Description |
177177
|---------------------------|----------|-------------------------------------------------------|
178178
| `gw_mac` | no | MAC address of the Xiaomi Aqara Gateway |
179179

180-
#### {% linkable_title Service xiaomi_aqara.remove_device %}
180+
#### {% linkable_title Service `xiaomi_aqara.remove_device` %}
181181

182182
Removes a specific device. The removal is required if a device shall be paired with another gateway.
183183

@@ -190,7 +190,7 @@ Removes a specific device. The removal is required if a device shall be paired w
190190

191191
### {% linkable_title Long Press on Smart Button %}
192192

193-
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.
193+
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.
194194

195195
*Note: The sound will stop playing automatically when it has ended.*
196196

@@ -226,7 +226,7 @@ This example plays the sound of a dog barking when the button is held down, and
226226

227227
### {% linkable_title Initial setup problem %}
228228

229-
If you run into trouble initializing the gateway with your app, try another smartphone. I had trouble with the OnePlus 3, but it worked with a Nexus 5.
229+
If you run into trouble initializing the gateway with your app, try another smartphone. E.g., it didn't work on an OnePlus 3, but it worked with a Nexus 5.
230230

231231
### {% linkable_title Connection problem %}
232232

@@ -238,11 +238,12 @@ If you run into trouble initializing the gateway with your app, try another smar
238238
That means that Home Assistant is not getting any response from your Xiaomi gateway. Might be a local network problem or your firewall.
239239
- Make sure you have [enabled LAN access](https://www.domoticz.com/wiki/Xiaomi_Gateway_(Aqara)#Adding_the_Xiaomi_Gateway_to_Domoticz).
240240
- Turn off the firewall on the system where Home Assistant is running.
241-
- Ensure your router supports multicast as this is a requirement of the Xiaomi GW
241+
- Ensure your router supports multicast as this is a requirement of the Xiaomi Gateway.
242242
- Try to leave the MAC address `mac:` blank.
243243
- Try to set `discovery_retry: 10`.
244244
- Try to disable and then enable LAN access.
245245
- Hard reset the gateway: Press the button of the gateway 30 seconds and start again from scratch.
246246
- If you are using Home Assistant in [Docker](/docs/installation/docker/), make sure to use `--net=host`.
247247
- If you receive an `{"error":"Invalid key"}` in your log while trying to control the gateway light, you should generate the key again using an Android Phone or alternativly an emulator such as [bluestacks](https://www.bluestacks.com). In some instances there is an issue with keys being generated using the iOS application.
248-
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g. `sudo apt-get install python3-dev libssl-dev libffi-dev`).
248+
- If the required library "PyXiaomiGateway" cannot be installed you will need to install some missing system dependencies `python3-dev`, `libssl-dev`, `libffi-dev` manually (e.g., `$ sudo apt-get install python3-dev libssl-dev libffi-dev`).
249+

0 commit comments

Comments
 (0)