Skip to main content

Introduction

Documentation Status Discord Build Status Code Style: Ruff

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.

Metadata

Release files for adafruit-circuitpython-scd4x 1.4.13

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for adafruit-circuitpython-scd4x 1.4.13
File Size Uploaded
adafruit_circuitpython_scd4x-1.4.13.tar.gz 29.5 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for adafruit-circuitpython-scd4x 1.4.13
File Interpreter ABI Platform
adafruit_circuitpython_scd4x-1.4.13-py3-none-any.whl Python 3 none any Details

Total release size: 39.7 kB

Release files / adafruit_circuitpython_scd4x-1.4.13.tar.gz

Download URL adafruit_circuitpython_scd4x-1.4.13.tar.gz
Size 29.5 kB
Tags Source
SHA-256 checksum
How to use checksums
15a6182da0f7a3c09942f7f80c80d174a432c5c1c0a285034084a3c85a6ad466
BLAKE2b-256 checksum
How to use checksums
17e885e6e5efbca84f2696f589fa3d04958997cfb691e5d153726e0d07746459
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release files / adafruit_circuitpython_scd4x-1.4.13-py3-none-any.whl

Download URL adafruit_circuitpython_scd4x-1.4.13-py3-none-any.whl
Size 10.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e860484bc81fb02c3d4e966dfb4e78a21363530c5d3b88c3cf49f67dc1bf3dac
BLAKE2b-256 checksum
How to use checksums
ef6a98d24ccff37933923914f837ffd60bc7da7a3b7717f0a6aedd4384053cf0
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.15

Release history Release notifications | RSS feed

This release

1.4.13 This release

2 release files

1.4.11

2 release files

1.4.10

2 release files

1.4.9

2 release files

1.4.8

2 release files

1.4.7

2 release files

1.4.6

2 release files

1.4.5

2 release files

1.4.4

2 release files

1.4.3

2 release files

1.4.2

2 release files

1.4.1

2 release files

1.4.0

2 release files

1.3.9

2 release files

1.3.8

2 release files

1.3.7

2 release files

1.3.6

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

1 release file

1.2.3

1 release file

1.2.2

1 release file

1.2.1

1 release file

1.2.0

1 release file

1.1.0

1 release file

1.0.0

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page