Metadata-Version: 2.4
Name: sensirion_i2c_stcc4
Version: 1.1.0
Summary: I2C driver for the Sensirion STCC4 sensor family
Project-URL: Changelog, https://github.com/Sensirion/python-i2c-stcc4/blob/master/CHANGELOG.md
Project-URL: Repository, https://github.com/Sensirion/python-i2c-stcc4
Project-URL: Documentation, https://sensirion.github.io/python-i2c-stcc4
Author-email: Sensirion <info@sensirion.com>
License-Expression: BSD-3-Clause
License-File: LICENSE
Keywords: I2C,STCC4,Sensirion STCC4
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: Hardware :: Hardware Drivers
Requires-Python: <4.0,>=3.8
Requires-Dist: sensirion-driver-adapters<3.0,>=2.3.0
Requires-Dist: sensirion-driver-support-types<2.0,>=1.2.0
Requires-Dist: sensirion-i2c-driver<2.0,>=1.0
Requires-Dist: sensirion-shdlc-sensorbridge<2.0,>=0.1.0
Provides-Extra: docs
Requires-Dist: jinja2~=3.1.6; extra == 'docs'
Requires-Dist: lazy-object-proxy~=1.7.1; extra == 'docs'
Requires-Dist: sphinx-autoapi~=3.0.0; extra == 'docs'
Requires-Dist: sphinx-rtd-theme==3.0.2; extra == 'docs'
Requires-Dist: sphinx==8.2.3; extra == 'docs'
Provides-Extra: test
Requires-Dist: flake8>=7.1.0; extra == 'test'
Requires-Dist: mock~=5.2.0; extra == 'test'
Requires-Dist: mypy~=1.13.0; extra == 'test'
Requires-Dist: pytest-cov>=5.0.0; extra == 'test'
Requires-Dist: pytest>=8.3.5; extra == 'test'
Requires-Dist: setuptools>=73.2.0; extra == 'test'
Description-Content-Type: text/markdown

# Python I2C Driver for Sensirion STCC4

This repository contains the Python driver to communicate with a Sensirion STCC4 sensor over I2C.

<img src="https://raw.githubusercontent.com/Sensirion/python-i2c-stcc4/master/images/STCC4.png"
    width="300px" alt="STCC4 picture">


Click [here](https://sensirion.com/products/catalog/STCC4) to learn more about the Sensirion STCC4 sensor.


The STCC4 is Sensirion's next generation miniature CO2 sensor for indoor air quality applications.



The default I²C address of [STCC4](https://sensirion.com/products/catalog/STCC4) is **0x64**.

> [!NOTE]
> The SEK-STCC4 board from Sensirion includes a STCC4 and a SHT4x for temperature and humidity compensation, which is controlled by the STCC4 through the integrated I2C controller interface. The provided examples are designed considering this sensor configuration.

## Connect the sensor

You can connect your sensor over a [SEK-SensorBridge](https://developer.sensirion.com/product-support/sek-sensorbridge/).
For special setups you find the sensor pinout in the section below.

<details><summary>Sensor pinout</summary>
<p>
<img src="https://raw.githubusercontent.com/Sensirion/python-i2c-stcc4/master/images/STCC4_pinout.png"
     width="300px" alt="sensor wiring picture">

| *Pin* | *Cable Color* | *Name* | *Description*  | *Comments* |
|-------|---------------|:------:|----------------|------------|
| 1 | black | GND | Ground |
| 2 | red | VDD | Supply Voltage | 2.7V to 5.5V
| 3 | green | SDA | I2C: Serial data input / output |
| 4 | yellow | SCL | I2C: Serial clock input |


</p>
</details>


## Documentation & Quickstart

See the [documentation page](https://sensirion.github.io/python-i2c-stcc4) for an API description and a
[quickstart](https://sensirion.github.io/python-i2c-stcc4/execute-measurements.html) example.


## Contributing

### Check coding style

The coding style can be checked with [`flake8`](http://flake8.pycqa.org/):

```bash
pip install -e .[test]  # Install requirements
flake8                  # Run style check
```

In addition, we check the formatting of files with
[`editorconfig-checker`](https://editorconfig-checker.github.io/):

```bash
pip install editorconfig-checker==2.0.3   # Install requirements
editorconfig-checker                      # Run check
```

## License

See [LICENSE](LICENSE).