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: Black

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 .env
source .env/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(i2c)

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

For humidity compensated raw gas 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
    compensated_raw_gas = sgp.measure_raw(temperature = temperature, relative_humidity = humidity)
    print(compensated_raw_gas)
    print("")
    time.sleep(1)

Contributing

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

Documentation

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

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.2.1.tar.gz (29.7 kB view details)

Uploaded Source

File details

Details for the file adafruit-circuitpython-sgp40-1.2.1.tar.gz.

File metadata

  • Download URL: adafruit-circuitpython-sgp40-1.2.1.tar.gz
  • Upload date:
  • Size: 29.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.2 importlib_metadata/4.8.1 pkginfo/1.7.1 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.2 CPython/3.9.6

File hashes

Hashes for adafruit-circuitpython-sgp40-1.2.1.tar.gz
Algorithm Hash digest
SHA256 2e4e4f8e1664a2d1124a8d5d60ab76bf3ada64e4f5ee546d4691d90eafbb0d09
MD5 07ec636ecc7f8a24bcc92434d65f4199
BLAKE2b-256 ec3b5b6988a1c0526b0bbe2fe884876b26184de0eb3ccc2133a68e471dd7982a

See more details on using hashes here.

Supported by

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