Skip to main content

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.

Metadata

Release files for adafruit-circuitpython-sgp40 1.3.24

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-sgp40 1.3.24
File Size Uploaded
adafruit_circuitpython_sgp40-1.3.24.tar.gz 30.4 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-sgp40 1.3.24
File Interpreter ABI Platform
adafruit_circuitpython_sgp40-1.3.24-py3-none-any.whl Python 3 none any Details

Total release size: 42.8 kB

Release files / adafruit_circuitpython_sgp40-1.3.24.tar.gz

Download URL adafruit_circuitpython_sgp40-1.3.24.tar.gz
Size 30.4 kB
Tags Source
SHA-256 checksum
How to use checksums
fe038258a2a9720be6dcf53e4bed2ebc9bd66aa066b4c23d0e6b38ba45dcddd3
BLAKE2b-256 checksum
How to use checksums
60f5edc65fb0ebb6a9fba151111254925a474a181ab73f559d04fe8a5e4d503b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release files / adafruit_circuitpython_sgp40-1.3.24-py3-none-any.whl

Download URL adafruit_circuitpython_sgp40-1.3.24-py3-none-any.whl
Size 12.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d3f0fb1ac3ab95c65aea01c172be378807b7772964da063fa8949822cfb80689
BLAKE2b-256 checksum
How to use checksums
32d8da067a88ba1c84fe7cddfe381d5fe7803b4f9515ad45166949db3e663044
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.2.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.3.24 This release

2 release files

1.3.23

2 release files

1.3.22

2 release files

1.3.21

2 release files

1.3.20

2 release files

1.3.19

2 release files

1.3.16

2 release files

1.3.15

2 release files

1.3.14

2 release files

1.3.13

2 release files

1.3.12

2 release files

1.3.11

2 release files

1.3.10

2 release files

1.3.9

2 release files

1.3.8

2 release files

1.3.7

2 release files

1.3.6

2 release files

1.3.5

1 release file

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.0

1 release file

1.0.3

1 release file

1.0.2

1 release file

1.0.1

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page