homebridge-flair

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

Installation

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

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

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

Obtaining Credentials

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

Start by creating a Flair account at my.flair.co (if you haven't already), then use this web form to request credentials.

More API docs and details

Auto Vs Manual Mode

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.~~ As of Version 1.3.0 homekit does not do any switching from Auto to Manual mode. This must be done through the flair app, the Puck thermostats now respect the "off" setting.

Vent Accessory Type

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

windowCovering - Window Covering fan - Fan airPurifier - Air Purifier hidden - Hidden, this is useful if you have a puck in each room and want to only expose the room "thermostats"

Commit format

Commits should be formatted as type(scope): message

The following types are allowed:

| Type | Description | |---|---| | feat | A new feature | | fix | A bug fix | | docs | Documentation only changes | | style | Changes that do not affect the meaning of the code (white-space, formatting,missing semi-colons, etc) | | refactor | A code change that neither fixes a bug nor adds a feature | | perf | A code change that improves performance | | test | Adding missing or correcting existing tests | | chore | Changes to the build process or auxiliary tools and libraries such as documentation generation |

Releasing

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.