1.0.5 • Published 2 years ago
@tillkruss/homebridge-purpleair v1.0.5
Homebridge PurpleAir Plugin
A Homebridge plugin to connect PurpleAir sensors.
- Supports multiple and private sensors
- Supports VOC, humidity and temperature readings
- Supports updated
US EPA PM2.5 AQI
conversion - Supports reporting AQI instead of PM2.5 Density
- Supports sensor firmware and model detection
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 @tillkruss/homebridge-purpleair
in Homebridge UI, or install it via CLI:
$ sudo npm install -g --unsafe-perm @tillkruss/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": "10.0.1.42" },
{ "ip": "10.0.1.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. |