|
| 1 | +--- |
| 2 | +layout: page |
| 3 | +title: "Xiaomi Gateway” |
| 4 | +description: "Instructions how to integrate your Xiaomi Gateway within Home Assistant." |
| 5 | +date: 2017-07-21 16:34 |
| 6 | +sidebar: true |
| 7 | +comments: false |
| 8 | +sharing: true |
| 9 | +footer: true |
| 10 | +logo: xiaomi.png |
| 11 | +ha_category: Hub |
| 12 | +ha_release: 0.50 |
| 13 | +--- |
| 14 | + |
| 15 | +The `xiaomi_gw` platform allows you to integrate the following devices into HA |
| 16 | + |
| 17 | +- Temperature and Humidity Sensor (old and new version) |
| 18 | +- Motion Sensor (old and new version) |
| 19 | +- Door and Window Sensor (old and new version) |
| 20 | +- Button (old and new version) |
| 21 | +- Plug aka Socket (ZigBee version, reports power consumed, power load, state and if device in use) |
| 22 | +- Wall Plug (reports power consumed, power load and state) |
| 23 | +- Aqara Wall Switch (Single) |
| 24 | +- Aqara Wall Switch (Double) |
| 25 | +- Aqara Wall Switch LN (Single) |
| 26 | +- Aqara Wall Switch LN (Double) |
| 27 | +- Aqara Wireless Switch (Single) |
| 28 | +- Aqara Wireless Switch (Double) |
| 29 | +- Cube |
| 30 | +- Gas Leak Detector (reports alarm and density) |
| 31 | +- Smoke Detector (reports alarm and density) |
| 32 | +- Gateway (Light, Illumination Sensor, Ringtone play) |
| 33 | +- Intelligent Curtain |
| 34 | +- Battery |
| 35 | + |
| 36 | + |
| 37 | +What's not available? |
| 38 | + |
| 39 | +- Gateway Radio |
| 40 | +- Gateway Button |
| 41 | +- Water Sensor |
| 42 | +- Aqara Air Conditioning Companion |
| 43 | +- Aqara Intelligent Air Conditioner Controller Hub |
| 44 | +- Decoupled mode of the Aqara Wall Switches (Single & Double) |
| 45 | +- Additional alarm events of the Gas and Smoke Detector: Analog alarm, battery fault alarm (smoke detector only), sensitivity fault alarm, I2C communication failure |
| 46 | + |
| 47 | +{% linkable_title Getting started %} |
| 48 | + |
| 49 | +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) |
| 50 | + |
| 51 | +{% linkable_title Configuration %} |
| 52 | + |
| 53 | +One Gateway |
| 54 | + ```yaml |
| 55 | + # You can leave mac empty if you only have one gateway |
| 56 | + xiaomi: |
| 57 | + gateways: |
| 58 | + - mac: |
| 59 | + key: xxxxxxxxxxxxxxxx |
| 60 | + ``` |
| 61 | +
|
| 62 | + Multiple Gateway |
| 63 | + ```yaml |
| 64 | + # 12 characters mac can be obtained from the gateway. |
| 65 | + xiaomi: |
| 66 | + gateways: |
| 67 | + - mac: xxxxxxxxxxxx |
| 68 | + key: xxxxxxxxxxxxxxxx |
| 69 | + - mac: xxxxxxxxxxxx |
| 70 | + key: xxxxxxxxxxxxxxxx |
| 71 | + ``` |
| 72 | +
|
| 73 | +Configuration variables: |
| 74 | +- **mac** (*Optional*): The MAC of your gateway. Required if you have more than one. |
| 75 | +- **key** (*Optional*): The key of your gateway. Required if you also want to control lights and switches; sensors and binary sensors will still work. |
| 76 | +- **discovery_retry** (*Optional*): Amount of times Home Assitant should try to reconnect to the Xiaomi Gateway. Default is 3. |
| 77 | +- **interface** (*Optional*): Which network interface to use. Default to any. |
0 commit comments