Metadata-Version: 2.1
Name: sensirion-uart-svm4x
Version: 2.0.3
Summary: SHDLC driver for the Sensirion SVM4X sensor family
Home-page: UNKNOWN
Author: Sensirion
Author-email: info@sensirion.com
License: BSD
Project-URL: Documentation, https://sensirion.github.io/python-uart-svm4x
Project-URL: Repository, https://github.com/Sensirion/python-uart-svm4x
Project-URL: Changelog, https://github.com/Sensirion/python-uart-svm4x/blob/master/CHANGELOG.rst
Keywords: Sensirion SVM4X
        SHDLC
        UART
        SVM4x
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.8
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6, <4
Description-Content-Type: text/markdown
Requires-Dist: sensirion-shdlc-driver (~=0.1.5)
Requires-Dist: sensirion-driver-adapters (<3.0,>=2.1.8)
Requires-Dist: sensirion-driver-support-types (~=0.2.0)
Provides-Extra: docs
Requires-Dist: click (==8.0.4) ; extra == 'docs'
Requires-Dist: jinja2 (==3.0.1) ; extra == 'docs'
Requires-Dist: sphinx (~=2.2.1) ; extra == 'docs'
Requires-Dist: sphinx-rtd-theme (~=0.4.3) ; extra == 'docs'
Provides-Extra: test
Requires-Dist: flake8 (~=3.7.8) ; extra == 'test'
Requires-Dist: pytest (~=6.2.5) ; extra == 'test'
Requires-Dist: pytest-cov (~=3.0.0) ; extra == 'test'

# 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](https://www.sensirion.com/my-sgp-ek/) 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">

| *Pin* | *Cable Color* | *Name* | *Description*  | *Comments* |
|-------|---------------|:------:|----------------|------------|
| 1 | red | VDD | Supply Voltage | 3.3 or 5V
| 2 | black | GND | Ground | 
| 3 | green | RX | UART: Transmission pin for communication | 
| 4 | yellow | TX | UART: Receiving pin for communication | 
| 5 | blue | SEL | Interface select | Leave floating or pull to VDD to select UART
| 6 | purple | NC | Do not connect | 


</p>
</details>

## Documentation & Quickstart

See the [documentation page](https://sensirion.github.io/python-uart-svm4x) for an API description and a 
[quickstart](https://sensirion.github.io/python-uart-svm4x/execute-measurements.html) 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`](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
```

## License

See [LICENSE](LICENSE).


