Skip to main content

Driver for Sensirion SCD4X CO2 sensor

Project description

Introduction

Documentation Status Discord Build Status Code Style: Black

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.

Purchase one from the Adafruit shop

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.

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_scd4x-1.4.5.tar.gz (30.2 kB view details)

Uploaded Source

Built Distribution

File details

Details for the file adafruit_circuitpython_scd4x-1.4.5.tar.gz.

File metadata

File hashes

Hashes for adafruit_circuitpython_scd4x-1.4.5.tar.gz
Algorithm Hash digest
SHA256 e7f9447b12ed73eeddf5eb2496625d83d0cbde6770ce9d2316e235572bc91dd2
MD5 356990298c9194aa68d44dc4fadb78cf
BLAKE2b-256 b5f704e2546c1e0345b30a361ccb1e7c9d86ad6b9a5c787cda82621ffcd021a4

See more details on using hashes here.

File details

Details for the file adafruit_circuitpython_scd4x-1.4.5-py3-none-any.whl.

File metadata

File hashes

Hashes for adafruit_circuitpython_scd4x-1.4.5-py3-none-any.whl
Algorithm Hash digest
SHA256 46a32015692941bab3f7223c4ae703303b06dd9aacacbaee6b8486e390565019
MD5 0b945b0f09c36c3252489974930b9982
BLAKE2b-256 a9c80a0828136bbb7d01be848d9d728e14901cc85e32df9814b173f257684f9d

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