Sensirion/python-i2c-stc

This driver repository is deprecated. Please use the new driver available here: https://.com/Sensirion/python-i2c-stc3x

This repository contains the Python driver to communicate with Sensirion STC3x sensors using the I²C interface. For details, please read the package description in README.rst.

• STC31: The STC31 is a chip-sized gas concentration sensor for high range, accurate CO2 measurements designed for high-volume production.

See package description in README.rst and user manual at https://sensirion..io/python-i2c-stc/.

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 . But this doesn't mean that we don't respond to issues or don't accept pull requests on . In fact, you're very welcome to open issues or create pull requests :)

The coding style can be checked with flake8:

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

In addition, we check the formatting of files with editorconfig-checker:

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

Unit tests can be run with pytest:

pip install -e .[test]                             # Install requirements
pytest -m "not needs_device"                       # Run tests without hardware
pytest                                             # Run all tests
pytest -m "not (needs_device and not needs_stc4x)" # Run all tests for stc3x

The tests with the marker needs_stc3x have following requirements:

• An STC3x device must be connected to a SensorBridge on port 1.
• Pass the serial port where the SensorBridge is connected with --serial-port, e.g. pytest --serial-port=COM7
• The SensorBridge must have default settings (baudrate 460800, address 0)

The documentation can be built with Sphinx:

python setup.py install                        # Install package
pip install -r docs/requirements.txt           # Install requirements
sphinx-versioning build docs docs/_build/html  # Build documentation

See LICENSE.