homebridge-purpleair
TypeScript icon, indicating that this package has built-in type declarations

1.0.8 • Public • Published

Homebridge PurpleAir Plugin

verified-by-homebridge github npm

A Homebridge plugin to connect PurpleAir sensors.

  • Exposes humidity, temperature and VOC readings
  • Supports updated US EPA PM2.5 AQI conversion
  • Increased accuracy with Dual Laser readings
  • Can report AQI instead of PM2.5 Density
  • Detects sensor firmware and model
  • Works with multiple and private sensors

This plugin only supports local sensors, if you want to use PurpleAir's paid API use Jacek Suliga's excellent Homebridge PurpleAir Sensor plugin.

Installation

Search for homebridge-purpleair in Homebridge UI, or install it via CLI:

$ sudo npm install -g --unsafe-perm homebridge-purpleair

Configuration

You may configure this plugin using Homebridge UI, or by editing your config.json:

{
    "bridge": {},
    "accessories": [],
    "platforms": [
        {
            "platform": "PurpleAir",
            "conversion": "US_EPA",
            "aqiInsteadOfDensity": true,
            "sensors": [
                { "ip": "192.168.0.42" },
                { "ip": "192.168.0.47", "name": "PurpleAir Garage" }
            ]
        }
    ]
}
Option Type Default Description
conversion string US_EPA The data correction used to determine the air quality index (AQI).
aqiInsteadOfDensity boolean false (Optional) HomeKit doesn't expose the air quality index (AQI). If enabled, the plugin will report the AQI in the "PM2.5 Density (µg/m³)" field.
sensors array [] An array containing the PurpleAir sensors.
sensors[].ip string The IP address of the sensor on the local network.
sensors[].name string (Optional) The name of the sensor. Useful to distinguish multiple sensors.

Conversions

US EPA

Courtesy of the United States Environmental Protection Agency Office of Research and Development, correction equation from their US wide study (updated version from October 22 2021) as applied on the AirNow Fire and Smoke Map.

Readme

Keywords

Package Sidebar

Install

npm i homebridge-purpleair

Weekly Downloads

3

Version

1.0.8

License

Apache-2.0

Unpacked Size

62.8 kB

Total Files

26

Last publish

Collaborators

  • tillkruss