Introduction¶
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 .env
source .env/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))
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.