Skip to content

Commit

Permalink
Update readme to reflect HACS default
Browse files Browse the repository at this point in the history
  • Loading branch information
aijayadams committed May 11, 2022
1 parent 7748e66 commit 9dfc44c
Showing 1 changed file with 28 additions and 7 deletions.
35 changes: 28 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -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)

0 comments on commit 9dfc44c

Please sign in to comment.