Skip to main content

CircuitPython library for Sensirion SGP30 gas sensor with eCO2 and TVOC.

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

A CircuitPython driver for the Sensirion SGP30 gas sensor with eCO2 and TVOC output. This sensor uses I2C!

Installation and 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-sgp30

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

sudo pip3 install adafruit-circuitpython-sgp30

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-sgp30

Usage Notes

See the guide for wiring and installation instructions.

First, import the library:

import busio
import adafruit_sgp30

Next, initialize the I2C bus object:

import board
i2c_bus = busio.I2C(board.SCL, board.SDA, frequency=100000)

Since we have the I2C bus object, we can now use it to instantiate the SGP30 object:

sgp30 = adafruit_sgp30.Adafruit_SGP30(i2c_bus)

Reading from the Sensor

To read from the sensor:

eCO2, TVOC = sgp30.iaq_measure()
print("eCO2 = %d ppm \t TVOC = %d ppb" % (eCO2, TVOC))

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-sgp30-3.0.4.tar.gz (29.0 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit-circuitpython-sgp30-3.0.4.tar.gz.

File metadata

File hashes

Hashes for adafruit-circuitpython-sgp30-3.0.4.tar.gz
Algorithm Hash digest
SHA256 7aaf0ddcc901487bf826e301e349905f09049204abcc2e0ec4fa5e7513d241a1
MD5 6ec32201b4351f86e4ca23e876527473
BLAKE2b-256 458a22f535a1eb5b41b350ab76aea41bf4c72d5ff4bcf9088b15f1985093d02b

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_sgp30-3.0.4-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_sgp30-3.0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d7ef321cc0ff11e609e3cacffe46e3c1061c4fd32f047876d250c3ae576b80e8
MD5 80be2e0aea90d1b1205789feead2b77d
BLAKE2b-256 38cb064110f4d475daabc75ac4e1d8fb924f457b896e6d4476977e10b7c4246a

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