CircuitPython_AirQualityTools: A Python repository from CedarGroveStudios

Introduction

A collection of CircuitPython helpers used for the calculation of PM2.5 and CO2 air quality levels.

CO2_IAQ calculates the Indoor Air Quality Index (IAQ) as derived from a CO2 ppm concentration measurement. Returns a data valid flag, CO2 input concentration value, the RGB warning color integer value, and the corresponding US English description or warning.

PM25_AQI calculates EPA Air Quality Index (AQI) as derived from PM2.5 particulate concentration. Returns a data valid flag, calculated air quality index, the RGB warning color integer value, and the corresponding US English description or warning.

Translate is a collection of description translators. English, Deutsch (German), Español (Spanish), Français (French), and Pirate are currently supported.

Dependencies

This driver depends on:

Adafruit CircuitPython

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle or individual libraries can be installed using circup.

Installing to a Connected CircuitPython Device with Circup

Make sure that you have circup installed in your Python environment. Install it with the following command if necessary:

pip3 install circup

With circup installed and your CircuitPython device connected use the following command to install:

circup install cedargrove_airqualitytools

Or the following command to update an existing version:

circup update

Usage Example

from cedargrove_airqualitytools.pm25_aqi import pm25_ppm_to_quality
from cedargrove_airqualitytools.co2_iaq import co2_ppm_to_quality
from cedargrove_airqualitytools.translate.english_to_francais import interpret

TRANSLATE = True  # Enable language translator

# Read some sensor values
PM25_CONCENTRATION = 10  # PM2.5 concentration of 10ppm; GOOD AQI
CO2_CONCENTRATION = 1450  # CO2 concentration of 1450ppm; POOR IAQ

# Calculate the quality and description
_, aqi_value, _, aqi_desc = pm25_ppm_to_quality(PM25_CONCENTRATION)
_, iaq_value, _, iaq_desc = co2_ppm_to_quality(CO2_CONCENTRATION)

# Print the AQI, description, and translation
print(f"PM2.5 AQI = {aqi_value} : {aqi_desc}")
print(interpret(TRANSLATE, aqi_desc))

# Print the IAQ, description, and translation
print(f"CO2 IAQ = {iaq_value} : {iaq_desc}")
print(interpret(TRANSLATE, iaq_desc))

Documentation

API documentation for this library can be found on Read the Docs.

For information on building library documentation, please check out this guide.

Contributing