Flair Smart Vent plug-in for Homebridge using the Flair API.

1. Install homebridge using: npm install -g homebridge
2. Install this plug-in using: npm install -g homebridge-flair
3. Update your configuration file. See example config.json snippet below.

Configuration sample (edit ~/.homebridge/config.json):

{
    "platforms": [
        {
            "clientId": "client_id",
            "clientSecret": "client_secret",
            "username": "user",
            "password": "pass",
            "pollInterval": 60,
            "platform": "Flair",
            "ventAccessoryType": "windowCovering"
        }
    ]
}

In order to use this plugin you will need to obtain a client id and client secret from Flair.

Follow the instructions here.

Specifically you need to:

1. Create a Flair account with a developer email address at my.flair.co.
2. Provide this email address to [email protected] and they will send you a set of developer credentials.

You will use the client id and secret they send you in the config block above.

When you use Pucks with your setup the pucks will appear in the app as a Thermostat. If you turn those thermostats off it will put the Flair system into Manual mode. If you turn the thermostat to any other setting it will set your system to Flair's Auto mode.

You can specify how vent accessories are shown in HomeKit with the ventAccessoryType property.

windowCovering - Window Covering fan - Fan airPurifier - Air Purifier

Commits should be formatted as type(scope): message

The following types are allowed:

A new version is released when a merge or push to main occurs.

We use the rules at default-release-rules.js as our guide to when a series of commits should create a release.