# Python I2C Driver for Sensirion STS3X
This repository contains the Python driver to communicate with a Sensirion sensor of the STS3X family over I2C.
<img src="https://raw.githubusercontent.com/Sensirion/python-i2c-sts3x/master/images/STS3x.png"
width="300px" alt="STS3X picture">
Click [here](https://www.sensirion.com/search/products?q=STS3x) to learn more about the Sensirion STS3X sensor family.
## Supported sensor types
| Sensor name | I²C Addresses |
| ------------- | -------------- |
|[STS30](https://sensirion.com/products/catalog/STS30-DIS)| **0x4A**, 0x4B|
|[STS30A](https://www.sensirion.com/products/catalog/STS30A-DIS)| **0x4A**, 0x4B|
|[STS31A](https://www.sensirion.com/products/catalog/STS31A-DIS)| **0x4A**, 0x4B|
|[STS31](https://www.sensirion.com/products/catalog/STS31-DIS)| **0x4A**, 0x4B|
|[STS32](https://www.sensirion.com/products/catalog/STS32-DIS)| **0x4A**, 0x4B|
|[STS33](https://www.sensirion.com/products/catalog/STS33-DIS)| **0x4A**, 0x4B|
|[STS35](https://www.sensirion.com/products/catalog/STS35-DIS)| **0x4A**, 0x4B|
The following instructions and examples use a *STS30*.
## Connect the sensor
You can connect your sensor over a [SEK-SensorBridge](https://developer.sensirion.com/sensirion-products/sek-sensorbridge/).
For special setups you find the sensor pinout in the section below.
<details><summary>Sensor pinout</summary>
<p>
<img src="https://raw.githubusercontent.com/Sensirion/python-i2c-sts3x/master/images/STS3x_pinout.png"
width="300px" alt="sensor wiring picture">
| *Pin* | *Cable Color* | *Name* | *Description* | *Comments* |
|-------|---------------|:------:|----------------|------------|
| 1 | green | SDA | I2C: Serial data input / output |
| 2 | black | GND | Ground |
| 3 | yellow | SCL | I2C: Serial clock input |
| 4 | red | VDD | Supply Voltage | 2.15V to 5.5V
</p>
</details>
## Documentation & Quickstart
See the [documentation page](https://sensirion.github.io/python-i2c-sts3x) for an API description and a
[quickstart](https://sensirion.github.io/python-i2c-sts3x/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-i2c-sts3x",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6, <4",
"maintainer_email": "",
"keywords": "Sensirion STS3X I2C STS30 STS30A STS31A STS31 STS32 STS33 STS35",
"author": "Sensirion",
"author_email": "info@sensirion.com",
"download_url": "https://files.pythonhosted.org/packages/bc/0d/c12184b87f760da46ed4de40f09e6cd399939a0fb166d6611c1f83142d06/sensirion_i2c_sts3x-1.0.0.tar.gz",
"platform": null,
"description": "# Python I2C Driver for Sensirion STS3X\n\nThis repository contains the Python driver to communicate with a Sensirion sensor of the STS3X family over I2C. \n\n<img src=\"https://raw.githubusercontent.com/Sensirion/python-i2c-sts3x/master/images/STS3x.png\"\n width=\"300px\" alt=\"STS3X picture\">\n\n\nClick [here](https://www.sensirion.com/search/products?q=STS3x) to learn more about the Sensirion STS3X sensor family.\n\n\n\n## Supported sensor types\n\n| Sensor name | I\u00c2\u00b2C Addresses |\n| ------------- | -------------- |\n|[STS30](https://sensirion.com/products/catalog/STS30-DIS)| **0x4A**, 0x4B|\n|[STS30A](https://www.sensirion.com/products/catalog/STS30A-DIS)| **0x4A**, 0x4B|\n|[STS31A](https://www.sensirion.com/products/catalog/STS31A-DIS)| **0x4A**, 0x4B|\n|[STS31](https://www.sensirion.com/products/catalog/STS31-DIS)| **0x4A**, 0x4B|\n|[STS32](https://www.sensirion.com/products/catalog/STS32-DIS)| **0x4A**, 0x4B|\n|[STS33](https://www.sensirion.com/products/catalog/STS33-DIS)| **0x4A**, 0x4B|\n|[STS35](https://www.sensirion.com/products/catalog/STS35-DIS)| **0x4A**, 0x4B|\n\nThe following instructions and examples use a *STS30*.\n\n\n\n## Connect the sensor\n\nYou can connect your sensor over a [SEK-SensorBridge](https://developer.sensirion.com/sensirion-products/sek-sensorbridge/).\nFor special setups you find 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-i2c-sts3x/master/images/STS3x_pinout.png\"\n width=\"300px\" alt=\"sensor wiring picture\">\n\n| *Pin* | *Cable Color* | *Name* | *Description* | *Comments* |\n|-------|---------------|:------:|----------------|------------|\n| 1 | green | SDA | I2C: Serial data input / output | \n| 2 | black | GND | Ground | \n| 3 | yellow | SCL | I2C: Serial clock input | \n| 4 | red | VDD | Supply Voltage | 2.15V to 5.5V\n\n\n</p>\n</details>\n\n\n## Documentation & Quickstart\n\nSee the [documentation page](https://sensirion.github.io/python-i2c-sts3x) for an API description and a \n[quickstart](https://sensirion.github.io/python-i2c-sts3x/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": "I2C driver for the Sensirion STS3X sensor family",
"version": "1.0.0",
"project_urls": {
"Changelog": "https://github.com/Sensirion/python-i2c-sts3x/blob/master/CHANGELOG.rst",
"Documentation": "https://sensirion.github.io/python-i2c-sts3x",
"Repository": "https://github.com/Sensirion/python-i2c-sts3x"
},
"split_keywords": [
"sensirion",
"sts3x",
"i2c",
"sts30",
"sts30a",
"sts31a",
"sts31",
"sts32",
"sts33",
"sts35"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "25e9712b0365b83e7adcf3509c375595860d1a8cc76b1000e56cf3aef99d6feb",
"md5": "3d5cad9b497f5898e2346c0422f57f5d",
"sha256": "54246293cd91298dbc9d574216f8576bdca7279dcce77a7b8010f1efc0e65690"
},
"downloads": -1,
"filename": "sensirion_i2c_sts3x-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d5cad9b497f5898e2346c0422f57f5d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6, <4",
"size": 9888,
"upload_time": "2023-10-27T14:22:27",
"upload_time_iso_8601": "2023-10-27T14:22:27.559615Z",
"url": "https://files.pythonhosted.org/packages/25/e9/712b0365b83e7adcf3509c375595860d1a8cc76b1000e56cf3aef99d6feb/sensirion_i2c_sts3x-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bc0dc12184b87f760da46ed4de40f09e6cd399939a0fb166d6611c1f83142d06",
"md5": "a515ffdd9130b31ce7a1a4b10d65139e",
"sha256": "204bd0da816a638a3508e33c9153ade4731ae408d7dcf4c65fa068b94a8147f1"
},
"downloads": -1,
"filename": "sensirion_i2c_sts3x-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "a515ffdd9130b31ce7a1a4b10d65139e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6, <4",
"size": 9289,
"upload_time": "2023-10-27T14:23:08",
"upload_time_iso_8601": "2023-10-27T14:23:08.267965Z",
"url": "https://files.pythonhosted.org/packages/bc/0d/c12184b87f760da46ed4de40f09e6cd399939a0fb166d6611c1f83142d06/sensirion_i2c_sts3x-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-27 14:23:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Sensirion",
"github_project": "python-i2c-sts3x",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "sensirion-i2c-sts3x"
}
JSON
