From 9dfc44c86df3488849d7f52605e3a403b7caa1cc Mon Sep 17 00:00:00 2001 From: Aijay Adams Date: Wed, 11 May 2022 08:55:33 -0700 Subject: [PATCH] Update readme to reflect HACS default --- README.md | 35 ++++++++++++++++++++++++++++------- 1 file changed, 28 insertions(+), 7 deletions(-) diff --git a/README.md b/README.md index 0047c49..f4d4dc9 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,34 @@ -# hass-blueair +[![hacs_badge](https://img.shields.io/badge/HACS-Default-orange.svg?style=for-the-badge)](https://hacs.xyz) +# Blueair Filter Integration for Home Assistant A simple BlueAir sensor and fan integration for HomeAssistant. -The basic sensor integration uses the [unofficial BlueAir client](https://github.com/thedjinn/blueair-py) by @thedjinn gather information from the sensors and control the fan with @spikeyGG's implimentation on BlueAir filters - -## Compatibility -A note on compatibility and testing, I only have 280i filters. The API response from blueair is different for other series of filters, and these differences may break the integration. Several people have contributed patches to make this integration work with other BlueAir models, and I'm really grateful for that help. +The basic sensor integration uses a modified [unofficial BlueAir client](https://github.com/thedjinn/blueair-py) by @thedjinn gather information from the sensors and control the fan with @spikeyGG's implementation on BlueAir filters ## Installation +### Recommended +- Install with [HACS](https://hacs.xyz/). +### Manual - Copy custom_components/blueair to your HomeAssistant base config directory (the place where configuration.yaml lives) -- Add the "BlueAir" integration in the configuration. -![HASS BlueAir Device](https://github.com/aijayadams/hass-blueair/blob/main/device.png) + +## Configuration +The integration is configured through the Home Assistant UI. No need to edit yaml files today. + +- Configuration -> Devices and Services -> Add Integration +- Search BlueAir, and enter your username and password + +## Compatibility +A note on compatibility and testing, I only have 280i filters. The API response from Blueair is different for other series of filters, and these differences may break the integration. Several people have contributed patches to make this integration work with other BlueAir models, and I'm really grateful for that help. + +I'm relatively confident we are correctly supporting + +:heavy_check_mark: Classic 280i + +:heavy_check_mark: Classic 605 + +Other classic, and classic i models should be similar enough that I would expect them to work (Classic 480i, Classic 505 etc.). + +If you have a filter from the [Protect](https://www.blueair.com/us/protect-family.html), [Dust Magnet](https://www.blueair.com/us/dustmagnet-family.html) or [Blue](https://www.blueair.com/us/blue-family.html) product lines (I'm not even sure if these are all connected devices) and are willing to share API responses and help up build support for these products please feel free to open an [Issue](https://github.com/aijayadams/hass-blueair/issues) :) + + +![HASS BlueAir Device](https://raw.githubusercontent.com/aijayadams/hass-blueair/main/device.png) \ No newline at end of file