semvec/pypi-packages huggingface dataset:
sensirion-i2c-stc3x 1.0.0
I2C driver for the Sensirion STC3X sensor family
License: BSD
Requires Python: <4,>=3.6
Keywords: Sensirion STC3X I2C STC31-C STC31

# Python I2C Driver for Sensirion STC3X

This repository contains the Python driver to communicate with a Sensirion sensor of the STC3X family over I2C.

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


Click [here](https://sensirion.com/products/catalog/SEK-STC31) to learn more about the Sensirion STC3X sensor family.


The measured gas mixture depends on the STC3x product and configured binary gas.
Please refer to the datasheet and API documentation to get a list of supported
binary gases.



## Supported sensor types

| Sensor name                                             | IÂ²C Addresses |
|---------------------------------------------------------|---------------|
| [STC31-C](https://sensirion.com/products/catalog/STC31) | **0x29**      |
| [STC31](https://sensirion.com/products/catalog/STC31)   | **0x29**      |

The following instructions and examples use a *STC31-C*.



## Connect the sensor

You can connect your sensor over a [SEK-SensorBridge](https://developer.sensirion.com/sensirion-products/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-stc3x/master/images/stc3x-pinout.png"
     width="300px" alt="sensor wiring picture">

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

</p>
</details>


## Documentation & Quickstart

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


## Contributing

We develop and test this driver using our company internal tools (version
control, continuous integration, code review etc.) and automatically
synchronize the `master` branch with GitHub. But this doesn't mean that we
don't respond to issues or don't accept pull requests on GitHub. In fact,
you're very welcome to open issues or create pull requests :-)

### 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).