# 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).
Raw data
{
"_id": null,
"home_page": "",
"name": "sensirion-uart-svm4x",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "Sensirion SVM4X SHDLC UART SVM4x",
"author": "Sensirion",
"author_email": "info@sensirion.com",
"download_url": "https://files.pythonhosted.org/packages/66/ba/4d3ebd4eb0a8c5639be78fbdb0466ef07c2ad3abd666ff8e36c7b587788e/sensirion_uart_svm4x-2.0.3.tar.gz",
"platform": null,
"description": "# Python UART Driver for Sensirion SVM4X\n\nThis repository contains the Python driver to communicate with a Sensirion SVM4X sensor over UART using the SHDLC protocol.\n\n<img src=\"https://raw.githubusercontent.com/Sensirion/python-uart-svm4x/master/images/svm4x.png\"\n width=\"300px\" alt=\"SVM4X picture\">\n\nClick [here](https://www.sensirion.com/my-sgp-ek/) to learn more about the Sensirion SVM4X sensor.\n\n\nThe SVM4x evaluation kit covers evaluation of the SGP40 and SGP41 sensors.\n\n\n\n\n\n## Connect the sensor\n\nYou can connect your sensor over the provided USB cable. \nFor special setups check out the sensor pinout in the section below.\n\n<details><summary>Sensor pinout</summary>\n<p>\n<img src=\"https://raw.githubusercontent.com/Sensirion/python-uart-svm4x/master/images/svm41-pinout-uart.png\"\n width=\"300px\" alt=\"sensor wiring picture\">\n\n| *Pin* | *Cable Color* | *Name* | *Description* | *Comments* |\n|-------|---------------|:------:|----------------|------------|\n| 1 | red | VDD | Supply Voltage | 3.3 or 5V\n| 2 | black | GND | Ground | \n| 3 | green | RX | UART: Transmission pin for communication | \n| 4 | yellow | TX | UART: Receiving pin for communication | \n| 5 | blue | SEL | Interface select | Leave floating or pull to VDD to select UART\n| 6 | purple | NC | Do not connect | \n\n\n</p>\n</details>\n\n## Documentation & Quickstart\n\nSee the [documentation page](https://sensirion.github.io/python-uart-svm4x) for an API description and a \n[quickstart](https://sensirion.github.io/python-uart-svm4x/execute-measurements.html) example.\n\n\n## Contributing\n\nWe develop and test this driver using our company internal tools (version\ncontrol, continuous integration, code review etc.) and automatically\nsynchronize the `master` branch with GitHub. But this doesn't mean that we\ndon't respond to issues or don't accept pull requests on GitHub. In fact,\nyou're very welcome to open issues or create pull requests :-)\n\n### Check coding style\n\nThe coding style can be checked with [`flake8`](http://flake8.pycqa.org/):\n\n```bash\npip install -e .[test] # Install requirements\nflake8 # Run style check\n```\n\nIn addition, we check the formatting of files with\n[`editorconfig-checker`](https://editorconfig-checker.github.io/):\n\n```bash\npip install editorconfig-checker==2.0.3 # Install requirements\neditorconfig-checker # Run check\n```\n\n## License\n\nSee [LICENSE](LICENSE).\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "SHDLC driver for the Sensirion SVM4X sensor family",
"version": "2.0.3",
"project_urls": {
"Changelog": "https://github.com/Sensirion/python-uart-svm4x/blob/master/CHANGELOG.rst",
"Documentation": "https://sensirion.github.io/python-uart-svm4x",
"Repository": "https://github.com/Sensirion/python-uart-svm4x"
},
"split_keywords": [
"sensirion",
"svm4x",
"shdlc",
"uart",
"svm4x"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "ce0af70d515fcff21ddc90eac6e31da69ee7420fe9b6325b5d6e4948d358812d",
"md5": "cd62a06098054a995a053dcbc7e98af7",
"sha256": "119375a12b6cc963692d390d92bbf7e32d99810073bd066db3c0ba447d35a996"
},
"downloads": -1,
"filename": "sensirion_uart_svm4x-2.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cd62a06098054a995a053dcbc7e98af7",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 11498,
"upload_time": "2023-11-15T09:34:18",
"upload_time_iso_8601": "2023-11-15T09:34:18.114680Z",
"url": "https://files.pythonhosted.org/packages/ce/0a/f70d515fcff21ddc90eac6e31da69ee7420fe9b6325b5d6e4948d358812d/sensirion_uart_svm4x-2.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66ba4d3ebd4eb0a8c5639be78fbdb0466ef07c2ad3abd666ff8e36c7b587788e",
"md5": "717b5f498614f08fb5b347901ed7d0ca",
"sha256": "360c51aad61378bb9b2b43edef2cbe709192a5b92d15765311b4710f8d7f0a98"
},
"downloads": -1,
"filename": "sensirion_uart_svm4x-2.0.3.tar.gz",
"has_sig": false,
"md5_digest": "717b5f498614f08fb5b347901ed7d0ca",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 10440,
"upload_time": "2023-11-15T09:34:19",
"upload_time_iso_8601": "2023-11-15T09:34:19.902352Z",
"url": "https://files.pythonhosted.org/packages/66/ba/4d3ebd4eb0a8c5639be78fbdb0466ef07c2ad3abd666ff8e36c7b587788e/sensirion_uart_svm4x-2.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-15 09:34:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sensirion",
"github_project": "python-uart-svm4x",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sensirion-uart-svm4x"
}
JSON
