homebridge-air

Homebridge plugin to integrate air quality data into HomeKit

Plugin Information

• This plugin allows you to view live air quality data for your location within HomeKit. The plugin:
  • creates a HomeKit air quality sensor for each city you configure
  • retrieves its data from AirNow (USA) or Aqicn (international)
  • requires a free API key from the provider you choose

Prerequisites

• To use this plugin, you will need to already have:
  • Node: latest version of v22 or v24 - any other major version is not supported.
  • Homebridge: v2 - refer to link for more information and installation instructions.

Setup

• Installation
• Configuration
• Beta Version
• Node Version

Features

• Measurements retrieved are PM2.5, PM10 and O3 for AirNow. AQICN adds NO2, SO2 and CO.
  • The Home app shows the overall air quality; the Eve app shows more of the individual measurements.
• Matter support is available when running Homebridge v2.0+ with Matter enabled:
  • options.enableMatter: true explicitly requests Matter. If Matter is unavailable or disabled, the plugin logs a warning and falls back to HAP.
  • options.preferMatter: true uses Matter when available and enabled, but silently falls back to HAP otherwise.
  • Switching between HAP and Matter removes stale cached accessories from the previous mode.

Help/About

• Common Errors
• Support Request
• Changelog
• About Me

Credits

• To @donavanbecker: the original creator and maintainer of this plugin.
• To @ToddGreenfield: the author of the original accessory-based plugin homebridge-airnow.
• To the creators/contributors of Homebridge who make this plugin possible.

Disclaimer

• I am in no way affiliated with AirNow, AQICN or the World Air Quality Index Project, and this plugin is a personal project that I maintain in my free time.
• Use this plugin entirely at your own risk - please see licence for more information.