# Homebridge Airthings
[](https://github.com/homebridge/homebridge/wiki/Verified-Plugins)
[](https://www.npmjs.com/package/homebridge-airthings)
[](https://www.npmjs.com/package/homebridge-airthings)
[](https://www.npmjs.com/package/homebridge-airthings)
[](https://deepwiki.com/michaelahern/homebridge-airthings)
A [Homebridge](https://homebridge.io) plugin for [Airthings](https://www.airthings.com) air quality monitors via the [Airthings Consumer API](https://consumer-api-doc.airthings.com/).
## Requirements
* [Homebridge](https://homebridge.io/)
* One or more supported [Airthings](https://www.airthings.com/) air quality monitors
* At least one Airthings SmartLink Hub ([View Plus](https://www.airthings.com/view-plus), [View Radon](https://www.airthings.com/view-radon))
### Supported Devices
| Airthings Device | Serial Number |
| ------------------------------------------------------------------------ | ------------- |
| [Airthings Corentium Home 2](https://www.airthings.com/corentium-home-2) | 3250xxxxxx |
| [Airthings Renew](https://www.airthings.com/renew) | 4100xxxxxx |
| [Airthings View Plus](https://www.airthings.com/view-plus) | 2960xxxxxx |
| [Airthings View Radon](https://www.airthings.com/view-radon) | 2989xxxxxx |
| [Airthings Wave Enhance](https://www.airthings.com/wave-enhance) | 3210xxxxxx |
| [Airthings Wave Enhance](https://www.airthings.com/wave-enhance) | 3220xxxxxx |
| [Airthings Wave Plus](https://www.airthings.com/wave-plus) | 2930xxxxxx |
| [Airthings Wave Radon](https://www.airthings.com/wave-radon) | 2950xxxxxx |
| [Airthings Wave Mini](https://www.airthings.com/wave-mini) | 2920xxxxxx |
Note: Airthings Wave devices require an Airthings SmartLink Hub ([View Plus](https://www.airthings.com/view-plus), [View Radon](https://www.airthings.com/view-radon)) to continuously push measurement data to the Airthings Cloud.
## Configuration
Example accessory config in the Homebridge config.json:
```json
"accessories": [
{
"accessory": "Airthings",
"name": "Living Room Airthings View Plus",
"clientId": "00000000-0000-0000-0000-000000000000",
"clientSecret": "11111111-1111-1111-1111-111111111111",
"serialNumber": "2960123456",
"batteryDisabled": false,
"co2AirQualityDisabled": false,
"humidityAirQualityDisabled": false,
"pm25AirQualityDisabled": false,
"radonAirQualityDisabled": false,
"vocAirQualityDisabled": false,
"co2DetectedThreshold": 1000,
"radonLeakThreshold": 100,
"debug": false,
"refreshInterval": 150
}
]
```
### Configuration Details
Field | Description
-------------------------------|------------
**accessory** | (required) Must be "Airthings"
**name** | (required) Name for the device in HomeKit
**clientId** | (required) Client ID generated in the [Airthings Dashboard](https://consumer-api-doc.airthings.com/dashboard)
**clientSecret** | (required) Client Secret generated in the [Airthings Dashboard](https://consumer-api-doc.airthings.com/dashboard)
**serialNumber** | (required) Serial number of the device
**co2AirQualityDisabled** | (optional) Disable Carbon Dioxide (CO₂) in Air Quality sensor calculation, default is false
**humidityAirQualityDisabled** | (optional) Disable Humidity in Air Quality sensor calculation. default is false
**pm25AirQualityDisabled** | (optional) Disable Particulate Matter (PM2.5) in Air Quality sensor calculation, default is false
**radonAirQualityDisabled** | (optional) Disable Radon in Air Quality sensor calculation, default is false
**vocAirQualityDisabled** | (optional) Disable VOC in Air Quality sensor calculation, default is false
**co2DetectedThreshold** | (optional) Configure a custom Carbon Dioxide (CO₂) detected threshold, default is 1000 ppm
**radonLeakThreshold** | (optional) Enable a Radon Leak Sensor with a threshold in Bq/m³, see additional notes below, disabled by default
**debug** | (optional) Enable debug logging, disabled by default
**batteryDisabled** | (optional) Disable Battery Service, default is false
**refreshInterval** | (optional) Interval in seconds for refreshing sensor data, default is 150s
_Note: The Airthings Consumer API has a [rate limit of 120 requests per hour](https://consumer-api-doc.airthings.com/docs/api/rate-limit)_
### How to request an Airthings API Client ID & Secret
Login to the [Airthings Dashboard](https://consumer-api-doc.airthings.com/dashboard) and go to *Create New Application*.
## HomeKit Sensors
### Air Quality
Air Quality Sensors are supported and implemented using standard Apple-defined services. Air Quality in this plugin is a composite of Radon, Particulate Matter (PM2.5), Volatile Organic Compound (VOC), Carbon Dioxide (CO₂), and Humidity sensors, depending on the sensors supported by your device and your plugin configuration. Air Quality values (Good, Fair, Poor) are based on [Airthings-defined thresholds](https://help.airthings.com/en/articles/5367327-view-understanding-the-sensor-thresholds) for each sensor.
Sensor | 🟢 Good | 🟠 Fair | 🔴 Poor |
----------------------------------|---------------|------------------------------------|--------------------|
Radon | <100 Bq/m³ | ≥100 and <150 Bq/m³ | ≥150 Bq/m³ |
Particulate Matter (PM2.5) | <10 μg/m³ | ≥10 and <25 μg/m³ | ≥25 μg/m³ |
Volatile Organic Compounds (VOCs) | <250 ppb | ≥250 and <2000 ppb | ≥2000 ppb |
Carbon Dioxide (CO₂) | <800 ppm | ≥800 and <1000 ppm | ≥1000 ppm |
Humidity | ≥30 and <60 % | ≥25 and <30 %
≥60 and <70 % | <25 %
≥70 % |
Notes:
* Radon measurements are not visible in the Apple Home app, but are visible within some third-party HomeKit apps, including [Eve](https://www.evehome.com/en-us/eve-app) and [Home+](https://hochgatterer.me/home+/). See the below section for more details on Radon sensors.
* This plugin converts Volatile Organic Compound (VOC) measurements from ppb (units Airthings devices report) to µg/m³ (units expected by Apple HomeKit).
### Radon
Radon Sensors are not natively supported by Apple HomeKit. However, by default, Radon is used as a factor in the Air Quality Sensor (see above).
This HomeBridge plugin optionally supports a Radon Sensor by implementing a Leak Sensor, which is a standard Apple-defined HomeKit service. To enable this, specify a value for the optional radonLeakThreshold configuration property. Note this value is in Bq/m³, not pCi/L. This will be the Leak Detected threshold for the sensor in HomeKit, which can be used for Notifications and within Automations. The Radon measurement itself will not be visible in the Apple Home app, but is visible within some third-party HomeKit apps, including [Eve](https://www.evehome.com/en-us/eve-app) and [Home+](https://hochgatterer.me/home+/).
### Air Pressure
Air Pressure Sensors are implemented using a custom HomeKit service that is supported by some third-party HomeKit apps, including [Eve](https://www.evehome.com/en-us/eve-app) and [Home+](https://hochgatterer.me/home+/). Air Pressure Sensors are not natively supported by Apple HomeKit and therefore not visible in the Apple Home app.
### Carbon Dioxide (CO₂)
Carbon Dioxide Sensors are supported and implemented using standard Apple-defined services. The Carbon Dioxide Detected threshold is ≥1000 ppm by default and customizable via the co2DetectedThreshold configuration property.
### Temperature & Humidity
Temperature & Humidity Sensors are supported and implemented using standard Apple-defined services.