diff --git a/source/_integrations/air_quality.xiaomi_miio.markdown b/source/_integrations/air_quality.xiaomi_miio.markdown new file mode 100644 index 00000000000..84ed346c516 --- /dev/null +++ b/source/_integrations/air_quality.xiaomi_miio.markdown @@ -0,0 +1,48 @@ +--- +title: "Xiaomi Air Quality Monitor" +description: "Instructions how to integrate your Xiaomi Mi Air Quality Monitor within Home Assistant." +logo: xiaomi.png +ha_category: + - Health +ha_iot_class: Local Polling +ha_release: 0.102 +--- + +The `xiaomi_miio` sensor platform is observing your Xiaomi Mi Air Quality Monitor and reporting the air quality values. + +Currently, the supported features are: + +- Particulate matter 2.5 +- Attributes + - carbon_dioxide_equivalent + - total_volatile_organic_compounds + +Please follow the instructions on [Retrieving the Access Token](/integrations/vacuum.xiaomi_miio/#retrieving-the-access-token) to get the API token. + +## Configuration + +To add a Xiaomi Mi Air Quality Monitor to your installation, add the following to your `configuration.yaml` file: + +```yaml +# Example configuration.yaml entry +air_quality: + - platform: xiaomi_miio + host: IP_ADDRESS + token: YOUR_TOKEN +``` + +{% configuration %} +host: + description: The IP address of your miio device. + required: true + type: string +token: + description: The API token of your miio device. + required: true + type: string +name: + description: The name of your miio device. + required: false + type: string + default: Xiaomi Miio Air Quality Monitor +{% endconfiguration %} diff --git a/source/_integrations/sensor.xiaomi_miio.markdown b/source/_integrations/sensor.xiaomi_miio.markdown index 2c0fc265f9a..04f18298eeb 100644 --- a/source/_integrations/sensor.xiaomi_miio.markdown +++ b/source/_integrations/sensor.xiaomi_miio.markdown @@ -1,6 +1,6 @@ --- -title: "Xiaomi Air Quality Monitor" -description: "Instructions how to integrate your Xiaomi Mi Air Quality Monitor within Home Assistant." +title: "Xiaomi Air Quality Index Monitor" +description: "Instructions how to integrate your Xiaomi Mi Air Quality Index Monitor within Home Assistant." logo: xiaomi.png ha_category: - Health @@ -29,8 +29,7 @@ To add a Xiaomi Mi Air Quality Monitor to your installation, add the following t # Example configuration.yaml entry sensor: - platform: xiaomi_miio - name: Xiaomi Air Quality Monitor - host: 192.168.130.73 + host: IP_ADDRESS token: YOUR_TOKEN ```