Skip to main content

CircuitPython library for the Adafruit SGP40 Air Quality Sensor / VOC Index Sensor Breakouts

Project description

Introduction

Documentation Status Discord Build Status Code Style: Ruff

CircuitPython library for the Adafruit SGP40 Air Quality Sensor / VOC Index Sensor Breakouts

Dependencies

This driver depends on:

Please ensure all dependencies are available on the CircuitPython filesystem. This is easily achieved by downloading the Adafruit library and driver bundle.

Installing from PyPI

On supported GNU/Linux systems like the Raspberry Pi, you can install the driver locally from PyPI. To install for current user:

pip3 install adafruit-circuitpython-sgp40

To install system-wide (this may be required in some cases):

sudo pip3 install adafruit-circuitpython-sgp40

To install in a virtual environment in your current project:

mkdir project-name && cd project-name
python3 -m venv .venv
source .venv/bin/activate
pip3 install adafruit-circuitpython-sgp40

Usage Example

import time
import board
import adafruit_sgp40

i2c = board.I2C()  # uses board.SCL and board.SDA
sgp = adafruit_sgp40.SGP40(i2c)

while True:
    print("Measurement: ", sgp.raw)
    print("")
    sleep(1)

For humidity compensated raw gas and voc index readings, we’ll need a secondary sensor such as the bme280

import time
import board
import adafruit_sgp40
import adafruit_bme280

i2c = board.I2C()  # uses board.SCL and board.SDA
sgp = adafruit_sgp40.SGP40(i2c)
bme280 = adafruit_bme280.Adafruit_BME280_I2C(i2c)

while True:
    temperature = bme280.temperature
    humidity = bme280.relative_humidity

    # For compensated raw gas readings
    """
    compensated_raw_gas = sgp.measure_raw(
        temperature=temperature, relative_humidity=humidity
    )
    print("Raw Data:", compensated_raw_gas)
    """

    # For Compensated voc index readings
    voc_index = sgp.measure_index(
    temperature=temperature, relative_humidity=humidity)

    print("VOC Index:", voc_index)
    print("")
    time.sleep(1)

It may take several minutes for the VOC index to start changing as it calibrates the baseline readings. The voc algorithm expects a 1 hertz sampling rate. Run measure_index() once per second.

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

Contributions are welcome! Please read our Code of Conduct before contributing to help this project stay welcoming.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

adafruit_circuitpython_sgp40-1.3.21.tar.gz (30.3 kB view details)

Uploaded Source

Built Distribution

adafruit_circuitpython_sgp40-1.3.21-py3-none-any.whl (12.4 kB view details)

Uploaded Python 3

File details

Details for the file adafruit_circuitpython_sgp40-1.3.21.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_sgp40-1.3.21.tar.gz
Algorithm Hash digest
SHA256 aa983905c2dc6b89e5323dc1d8cb1e09065d7f351e619342fbd8baab3a5d365e
MD5 8c33f8850a4bb015b3de43ea736dd3d2
BLAKE2b-256 e5ac9f37ecd327525cd10a9fbd54902974dc341c86e3f35bc3fbf99f6c8f5086

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_sgp40-1.3.21-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_sgp40-1.3.21-py3-none-any.whl
Algorithm Hash digest
SHA256 aac7799d59e5004356072551b2638c757dc3728684199d043f3d69d3d62cd76c
MD5 50148f3dbe67245dc7ccff9df3e4045b
BLAKE2b-256 a841b4f5b7aae2a94ef7c0457d185c6f6eb2fa1e3100e539e231ae441d0155af

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page