Home

Awesome

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.

<img src="https://raw.githubusercontent.com/Sensirion/python-i2c-sfm-sf06/master/images/SFM4300.png" width="300px" alt="SFM-SF06 picture">

Click here 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 nameI²C Addresses
SFM43000x2A, 0x2B, 0x2C, 0x2D
SFM31190x29
SFM30030x28, 0x2D
SFM30130x2F
SFM30190x2E

The following instructions and examples use a SFM4300.

Connect the sensor

You can connect your sensor over a 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-sfm-sf06/master/images/pinout_SFM4300.png" width="300px" alt="sensor wiring picture">
PinCable ColorNameDescriptionComments
1ADDRsee data sheet section 4.1
2SDAI2C: Serial data input / outputSerial data, bidirectional
3GNDGround
4VDDSupply Voltage3.0V to 5.0V
5SCLI2C: Serial clock input
6IRQnActive low. see data sheet section 3.3
</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.