Introduction¶
Driver for Sensirion SCD4X CO2 sensor
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 or individual libraries can be installed using circup.
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-scd4x
To install system-wide (this may be required in some cases):
sudo pip3 install adafruit-circuitpython-scd4x
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-scd4x
Installing to a Connected CircuitPython Device with Circup¶
Make sure that you have circup
installed in your Python environment.
Install it with the following command if necessary:
pip3 install circup
With circup
installed and your CircuitPython device connected use the
following command to install:
circup install adafruit_scd4x
Or the following command to update an existing version:
circup update
Usage Example¶
import time
import board
import adafruit_scd4x
i2c = board.I2C()
scd4x = adafruit_scd4x.SCD4X(i2c)
print("Serial number:", [hex(i) for i in scd4x.serial_number])
scd4x.start_periodic_measurement()
print("Waiting for first measurement....")
while True:
if scd4x.data_ready:
print("CO2: %d ppm" % scd4x.CO2)
print("Temperature: %0.1f *C" % scd4x.temperature)
print("Humidity: %0.1f %%" % scd4x.relative_humidity)
print()
time.sleep(1)
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.
Table of Contents¶
Examples
API Reference
adafruit_scd4x
SCD4X
SCD4X.CO2
SCD4X.altitude
SCD4X.data_ready
SCD4X.factory_reset()
SCD4X.force_calibration()
SCD4X.measure_single_shot()
SCD4X.measure_single_shot_rht_only()
SCD4X.persist_settings()
SCD4X.reinit()
SCD4X.relative_humidity
SCD4X.self_calibration_enabled
SCD4X.self_test()
SCD4X.serial_number
SCD4X.set_ambient_pressure()
SCD4X.start_low_periodic_measurement()
SCD4X.start_periodic_measurement()
SCD4X.stop_periodic_measurement()
SCD4X.temperature
SCD4X.temperature_offset