https://github.com/homebridge-plugins/homebridge-air
Homebridge plugin for AirNow Web-API Air Quality Sensor
https://github.com/homebridge-plugins/homebridge-air
Last synced: 4 months ago
JSON representation
Homebridge plugin for AirNow Web-API Air Quality Sensor
- Host: GitHub
- URL: https://github.com/homebridge-plugins/homebridge-air
- Owner: homebridge-plugins
- License: isc
- Created: 2024-09-06T03:55:49.000Z (almost 2 years ago)
- Default Branch: latest
- Last Pushed: 2025-03-05T04:19:37.000Z (over 1 year ago)
- Last Synced: 2025-04-14T10:06:06.035Z (about 1 year ago)
- Language: TypeScript
- Size: 486 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# Homebridge Air
The Homebridge Air
plugin allows you monitor the current AirQuality for your Zip Code from HomeKit and Siri.
## Installation
1. Search for "Air" on the plugin screen of [Homebridge Config UI X](https://github.com/oznu/homebridge-config-ui-x).
2. Click **Install**.
## Configuration
1. Login / create an account at https://www.airnow.gov/ or at https://aqicn.org/api/ as applicable for your location
2. Select your Provider: AirNow or Apicn
3. Enter your AirNow.gov or Aqicn API Key
4. Enter your City and Latitude / Longitude (4 decimal places is sufficient). Note that City may be ambiguous, so you should always enter Latitude and Longitude for location accuracy
5. Click Save
6. Restart Homebridge
## Supported Air Quality Providers
Currently supports AQI Services:
- [AirNow](https://www.airnow.gov/) which is limited to the USA. A valid ZipCode is required.
- [Aqicn](https://www.aqicn.org/) which has international support, provided by the [World Air Quality Index Project](http://waqi.info/).
Depending on where exactly you would like to monitor AQI, one service may be more appropriate than the other.
## Supported Air Quality Features
This plugin will create an AirQualitySensor element. The Home app works well, but the Eve app seems to show more measurements. Measurements retrieved are PM2.5, PM10, & O3 for AirNow. Aqicn adds NO2, SO2, CO...
## Contributing
We welcome contributions! Please note our **beta branch strategy**:
- **All PRs must target a beta branch first** (format: `beta-X.Y.Z`)
- **Issues must have semantic versioning labels** (`patch`, `minor`, `major`) before assignment
- **Use our helper script** to create beta branches: `./scripts/create-beta-branch.sh`
- **See our [Contributing Guide](./CONTRIBUTING.md)** for detailed instructions
For GitHub Copilot users, please review our [Copilot Instructions](./.github/copilot-instructions.md).
## Thanks
Thank you to [ToddGreenfield](https://github.com/ToddGreenfield) for the the work done on the accesorry based plugin [homebridge-airnow](https://github.com/ToddGreenfield/homebridge-airnow/blob/master/README.md).