Python Driver for Sensirion SHDLC Devices
This repository contains the base driver for Sensirion SHDLC devices as a Python package. For details, please read the package description in README.rst.
We develop and test this driver using our company internal tools (version
control, continuous integration, code review etc.) and automatically
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
pip install -e .[test] # Install requirements flake8 # Run style check
Unit tests can be run with
pip install -e .[test] # Install requirements pytest -m "not (needs_serialport or needs_tcp)" # Run tests without hardware pytest # Run all tests
To run the tests which access connected hardware, you need to pass following
--serial-port: The serial port where a device is connected (e.g.
--serial-bitrate: The bitrate of the device connected to the serial port (e.g.
--serial-address: The slave address of the device connected to the serial port (e.g.
--tcp-port: The TCP IP address where a device is connected (e.g.
--tcp-port: The port of the device connected via TCP (e.g.
--tcp-address: The slave address of the device connected via TCP (e.g.
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