https://github.com/sensirion/python-i2c-svm4x
Python I2C driver for SVM41 Development Board SGP41 VOC+NOx sensor and SHT40 humidity and temperature sensor . Please visit https://www.sensirion.com/my-sgp-ek/ for more information
https://github.com/sensirion/python-i2c-svm4x
i2c i2c-device no2-sensor nox nox-sensor sensirion sgp41 sht40 sht4x svm41 voc voc-sensor
Last synced: about 2 months ago
JSON representation
Python I2C driver for SVM41 Development Board SGP41 VOC+NOx sensor and SHT40 humidity and temperature sensor . Please visit https://www.sensirion.com/my-sgp-ek/ for more information
- Host: GitHub
- URL: https://github.com/sensirion/python-i2c-svm4x
- Owner: Sensirion
- License: bsd-3-clause
- Created: 2021-12-01T14:07:22.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-31T08:27:12.000Z (3 months ago)
- Last Synced: 2025-02-14T14:03:34.673Z (2 months ago)
- Topics: i2c, i2c-device, no2-sensor, nox, nox-sensor, sensirion, sgp41, sht40, sht4x, svm41, voc, voc-sensor
- Language: Python
- Homepage:
- Size: 40 KB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.rst
- License: LICENSE
Awesome Lists containing this project
README
# Python Driver for Sensirion SVM4x Evaluation Kit
This repository contains the Python driver to communicate with the Sensirion
SVM4x Evaluation Kit using the I²C interface. For details, please read the
package description in [README.rst](README.rst).
The SVM4x evaluation kit covers evaluation of the SGP40 and SGP41 sensors.
## Usage
See package description in [README.rst](README.rst) and user manual at
https://sensirion.github.io/python-i2c-svm4x/.
## Development
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
```
### Run tests
Unit tests can be run with [`pytest`](https://pytest.org/):
```bash
pip install -e .[test] # Install requirements
pytest -m "not needs_device" # Run tests without hardware
pytest # Run all tests
```
The tests with the marker `needs_device` have following requirements:
- An SVM4x device must be connected to a
[SensorBridge](https://www.sensirion.com/sensorbridge/) on port 1.
- **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!**
- 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)
### Build documentation
The documentation can be built with [Sphinx](http://www.sphinx-doc.org/):
```bash
python setup.py install # Install package
pip install -r docs/requirements.txt # Install requirements
sphinx-versioning build docs docs/_build/html # Build documentation
```
## License
See [LICENSE](LICENSE).