3. Awair2 Configuration Options

Configuration Options

The Developer Token is the only item required to perform initial setup of homebridge-awair2 as this will add your registered device(s) to Homebridge and in turn to HomeKit. The default Configuration values are recommended setting for the average/home user, however, there are a number of optional configuration settings as detailed below.

(*) Parameters introduced with v5.9.x

Parameter	Description
userType	The type of user account, default = users/self which is the proper type for the typical home Awair air quality sensor user. Options: users/self or orgs/###, where ### is the Awair Organization orgId.
airQualityMethod	Air quality calculation method used to define the Air Quality Chracteristic, default = awair-aqi, options: * awair-aqi method follow the U.S. EPA AQI methodology using VOC, pm2.5 and dust levels reported from the Awair device to calculate an aqi store. * awair-pm method only reflects the particulates value, which is useful for automating air purifiers. * awair-score method reports the score as is shown on your Awair device display taking into account your endpoint and limit settings. * nowcast-aqi is a weighted average of hourly air monitoring data for reporting of the Air Quality Index (AQI) for PM (PM10 or PM2.5). The PM NowCast is computed from the most recent 12 hours of PM monitoring data, but the NowCast weights the most recent hours of data more heavily than an ordinary 12-hour average when pollutant levels are changing. NOTES: * When nowcast-api is selected, endpoint defaults to 15-min-avg and data points returned to 48.
endpoint	The air-data endpoint to use, default = 15-min-avg. Options: 15-min-avg, 5-min-avg, raw or latest. NOTE: If nowcast-aqi selected, endpoint defaults to 15-min-avg.
limit	Number of consecutive data points returned per request, used for custom averaging of sensor values, default = 1. Maximum limit for each endpoint is: * 15-min-avg: 7 days (~672 data points of 15 minute averaged blocks), * 5-min-avg: 24 hours (~288 data points of 5 minute blocks), * raw: 1 hour (~360 data points of 10 second intervals), and * latest: 1 (1 data point, most recent 10 second interval). NOTE: If nowcast-aqi selected, limit defaults to 48 which equals provides 12 hours of data.
carbonDioxideThreshold	The level at which HomeKit will trigger an alert for the CO2 in ppm, default = 1000. High CO2 levels, generally over 1000 ppm, indicate a potential problem with air circulation and fresh air in a room.
carbonDioxideThresholdOff	The level at which HomeKit will turn off the trigger alert for the CO2 in ppm, default = 800. To ensure that CO2 doesn't trigger on/off too frequently choose a number lower than carbonDioxideThreshold.
enableTvocPm25(*)	Whether to enable Total VOC and PM2.5 level detection, default = false.
tvocThreshold(*)	Total VOC level at which HomeKit will trigger an alert in µg/m³. (Default = 1000)
tvocThresholdOff(*)	Total VOC level at which HomeKit will turn off the trigger alert in µg/m³, to ensure that it doesn't trigger on/off too frequently. Choose a number less than tvocThreshold. (Default = 800)
pm25Threshold(*)	The level at which HomeKit will trigger an alert for PM2.5 in µg/m³. (Default = 35)
pm25ThresholdOff(*)	The level at which HomeKit will turn off the trigger alert for pm2.5 in µg/m³, to ensure that it doesn't trigger on/off too frequently. Choose a number less than pm25Threshold. (Default = 20)
vocMw	The Molecular Weight (g/mol) of a reference gas or mixture that you use to convert from ppb to µg/m&sup3. (Default = 72.66578273019740)
occupancyDetection	Omni only - Enables Omni occupancy detection based on minimum environmental sound level detected, default = false. The awair2 plugin checks ambient sound level every 30 seconds and updates the minimum level detected if a lower level is measured to determine a minimum for the room that the Omni is installed in. The Omni device dust fan sets the minimum at 50dBA (±3).
occupancyOffset	Omni only - Used when occupancy detection enabled. Offset value in dBA (default = 2) above minimum sound level to set upper limit for not occupied. Lower limit for occupied is 0.5dBA higher. For example if minimum sound level is determined to be 50dB with 2dBA default, sound levels less than 52dBA would be classified as not occupied and sound levels above 52.5dBA would be classified as occupied. Sound levels between 52dBA and 52.5dBA would be classified as transitional with no change in occupancy state.
occupancyRestart	Omni only - When false historical occupancy sound limits are used. When true, values are set to default and occupancy detection algorithm restarts on Homebridge reboot. Default = false.
logging	Whether to output Awair2 logs to the Homebridge logs, default = false.
enableModes	Applies to Omni, Awair-R2 & Element - Enables creation of Display Mode and LED Mode accessories, default = false.
verbose	Whether to log Awair2 results from API data calls, default = false. Requires logging to be true.
development	Allow use of test Awair devices lacking Awair OUI formatted Serial numbers, default = false. This option supports non-production devices used for testing. If you receive an error does not match Awair OUI "708xxx" after installation, it is recommended that you reach out to [email protected] with your macAddress so that Awair can confirm that your device has been added to their database.
ignoredDevices	Array of Awair device macAddresses (12 characters in length) to be excluded from HomeKit. End user devices with begin with Awair OUI 70886B, test devices are concatenation of 0's with the deviceId to result in 12 characters. For example, a test device with deviceId of 1234 would be assigned a macAddress of 000000001234.