airaware
A Swift (macOS/iOS) framework for interacting with Awair air monitoring devices.
Project maintained by cheesemaker Hosted on GitHub Pages — Theme by mattgraham
AirAware
AirAware is an open source framework to help developers monitor and understand the air quality around them. Currently, AirAware supports:
- Awair© smart devices for monitoring indoor air quality
- AirNow - the EPA supported AQI (Air Quality Indicator) service
- WeatherFlow - Outdoor weather station readings when configured to use a WF base-station
- PurpleAir - Network of weather stations maintained and owned by private citizens
- OpenWeather - Current localized weather
Accounts and API Keys:
-
For Awair© devices, the library supports both OAuth and direct access token integrations. See https://docs.developer.getawair.com for more information.
-
For WeatherFlow© devices, it supports OAuth via a user account. See https://weatherflow.github.io/Tempest/api/oauth.html for more information.
-
For the AirNow service, it supports both an embedded web login as well as native username/password support. An active user account is required for each user, however retrieval of the access key has been automated. See https://docs.airnowapi.org
-
For the PurpleAir service, no login is required, however an API key must be requested and obtained from Purple contact@purpleair.com
-
For OpenWeather, you must create a login and request an API key See https://openweathermap.org/api for more information.
<img src = “https://raw.githubusercontent.com/cheesemaker/airaware/main/Documents/screenshot.jpeg” width=50%>
Installation
- Swift Package Manager
AirAware has native SPM support.
- Carthage
AirAware may be installed via Carthage. To install it, simply add the following line to your Cartfile:
github "cheesemaker/airaware"
Then, following the instructions for integrating Carthage frameworks into your app, link the UUSwift framework into your project.
Requirements
This library requires a deployment target of iOS 13.0 or greater or OSX 10.10 or greater. AirAware currently supports Swift version 4.0
Contributing
Please open pull requests against the develop branch
Swift
AirAware is written entirely in Swift and currently does not support Objective-C interoperability.
License
AirAware is available under the MIT license. See LICENSE.md for more information.