Home

Awesome

Python UART Driver for Sensirion SVM4X

This repository contains the Python driver to communicate with a Sensirion SVM4X sensor over UART using the SHDLC protocol.

<img src="https://raw.githubusercontent.com/Sensirion/python-uart-svm4x/master/images/svm4x.png" width="300px" alt="SVM4X picture">

Click here to learn more about the Sensirion SVM4X sensor.

The SVM4x evaluation kit covers evaluation of the SGP40 and SGP41 sensors.

Connect the sensor

You can connect your sensor over the provided USB cable.
For special setups check out the sensor pinout in the section below.

<details><summary>Sensor pinout</summary> <p> <img src="https://raw.githubusercontent.com/Sensirion/python-uart-svm4x/master/images/svm41-pinout-uart.png" width="300px" alt="sensor wiring picture">
PinCable ColorNameDescriptionComments
1redVDDSupply Voltage3.3 or 5V
2blackGNDGround
3greenRXUART: Transmission pin for communication
4yellowTXUART: Receiving pin for communication
5blueSELInterface selectLeave floating or pull to VDD to select UART
6purpleNCDo not connect
</p> </details>

Documentation & Quickstart

See the documentation page for an API description and a quickstart example.

Contributing

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:

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

License

See LICENSE.