This package contains the SHDLC driver for the SVM40 Evaluation Kit as a Python package. For details, please read the package description in README.rst.
See package description in README.rst and user manual at https://sensirion.github.io/python-shdlc-svm40/.
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 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:
- An SVM40 device must be connected to the computer.
- WARNING: Some tests modify non-volatile configurations of the device, restore factory defaults etc.! Do not run the tests on a device which you don't want to get modified!
- You have to specify the serial port (and optionally other connection
parameters) used to connect to the SVM40 device:
--serial-port: The serial port where the device is connected (e.g.COM7).
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.