Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sensirion/python-i2c-sfm-sf06
Python code to work with Sensirion's SF06 based flow sensors via I2C
https://github.com/sensirion/python-i2c-sfm-sf06
driver evaluation-kit flow gas-flow i2c python sek sensirion sensor sf06 sfm
Last synced: 4 days ago
JSON representation
Python code to work with Sensirion's SF06 based flow sensors via I2C
- Host: GitHub
- URL: https://github.com/sensirion/python-i2c-sfm-sf06
- Owner: Sensirion
- License: bsd-3-clause
- Created: 2021-12-07T11:17:41.000Z (almost 3 years ago)
- Default Branch: master
- Last Pushed: 2024-05-13T13:16:06.000Z (6 months ago)
- Last Synced: 2024-11-07T07:34:21.666Z (9 days ago)
- Topics: driver, evaluation-kit, flow, gas-flow, i2c, python, sek, sensirion, sensor, sf06, sfm
- Language: Python
- Homepage: https://sensirion.github.io/python-i2c-sfm-sf06/
- Size: 323 KB
- Stars: 2
- Watchers: 5
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Python I2C Driver for Sensirion SFM-SF06
This repository contains the Python driver to communicate with a Sensirion sensor of the SFM-SF06 family over I2C.
Click [here](https://sensirion.com/products/product-categories/gas-flow-sensors/) to learn more about the Sensirion SFM-SF06 sensor family.
Not all sensors of this driver family support all measurements.
In case a measurement is not supported by all sensors, the products that
support it are listed in the API description.
## Supported sensor types
| Sensor name | I²C Addresses |
| ------------- | -------------- |
|[SFM4300](https://sensirion.com/products/catalog/?filter_series=77ed9322-c043-4eaf-ad3c-2b55aae69cdd)| **0x2A**, 0x2B, 0x2C, 0x2D|
|[SFM3119](https://sensirion.com/products/catalog/SFM3119/)| **0x29**|
|[SFM3003](https://sensirion.com/products/catalog/SEK-SFM3003/)| **0x28**, 0x2D|
|[SFM3013](https://sensirion.com/products/catalog/SEK-SFM3013/)| **0x2F**|
|[SFM3019](https://sensirion.com/products/catalog/SEK-SFM3019/)| **0x2E**|
The following instructions and examples use a *SFM4300*.
## 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.
Sensor pinout
| *Pin* | *Cable Color* | *Name* | *Description* | *Comments* |
|-------|---------------|:------:|----------------|------------|
| 1 | | ADDR | | see data sheet section 4.1
| 2 | | SDA | I2C: Serial data input / output | Serial data, bidirectional
| 3 | | GND | Ground |
| 4 | | VDD | Supply Voltage | 3.0V to 5.0V
| 5 | | SCL | I2C: Serial clock input |
| 6 | | IRQn | | Active low. see data sheet section 3.3
## Documentation & Quickstart
See the [documentation page](https://sensirion.github.io/python-i2c-sfm-sf06) for an API description and a
[quickstart](https://sensirion.github.io/python-i2c-sfm-sf06/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).