This repository contains the CircuitPython driver to communicate with Sensirion SEN5x sensors using the I²C interface. For details, please read the package description in README.rst.
This library is a fork of the official python library from Sensirion, to add support for CircuitPython on embedded devices and linux SBCs.
See package description in README.rst and user manual at https://sensirion.github.io/python-i2c-sen5x/.
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 :)
The coding style can be checked with flake8:
pip install -e .[test] # Install requirements
flake8 # Run style checkIn addition, we check the formatting of files with
editorconfig-checker:
pip install editorconfig-checker==2.0.3 # Install requirements
editorconfig-checker # Run checkUnit tests can be run with pytest:
pip install -e .[test] # Install requirements
pytest -m "not needs_device" # Run tests without hardware
pytest # Run all testsThe tests with the marker needs_device have following requirements:
- A SEN55 or SEN54 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 documentationSee LICENSE.