Home

Awesome

Sensirion I²C SFM-SF06 Arduino Library

This is the Sensirion SFM-SF06 library for Arduino allowing you to communicate with a sensor of the SFM-SF06 family over I²C.

<img src="images/SFM4300.png" width="300px">

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.

Installation of the library

This library can be installed using the Arduino Library manager: Start the Arduino IDE and open the Library Manager via

Sketch ➔ Include Library ➔ Manage Libraries...

Search for the Sensirion I2C SFM-SF06 library in the Filter your search... field and install it by clicking the install button.

If you cannot find it in the library manager, download the latest release as .zip file and add it to your Arduino IDE via

Sketch ➔ Include Library ➔ Add .ZIP Library...

Don't forget to install the dependencies listed below the same way via library manager or Add .ZIP Library

Dependencies

Sensor wiring

Use the following pin description to connect your SFM-SF06 to the standard I²C bus of your Arduino board:

<img src="images/pinout_SFM4300.png" width="300px">
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

The recommended voltage is 3.3V.

Board specific wiring

You will find pinout schematics for recommended board models below:

<details><summary>Arduino Uno</summary> <p>
SFM-SF06SFM-SF06 PinCable ColorBoard Pin
ADDR1
SDA2D18/SDA
GND3GND
VDD43.3V
SCL5D19/SCL
IRQn6
<img src="images/Arduino-Uno-Rev3-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>Arduino Nano</summary> <p>
SFM-SF06SFM-SF06 PinCable ColorBoard Pin
ADDR1
SDA2A4
GND3GND
VDD43.3V
SCL5A5
IRQn6
<img src="images/Arduino-Nano-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>Arduino Micro</summary> <p>
SFM-SF06SFM-SF06 PinCable ColorBoard Pin
ADDR1
SDA2D2/SDA
GND3GND
VDD43.3V
SCL5~D3/SCL
IRQn6
<img src="images/Arduino-Micro-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>Arduino Mega 2560</summary> <p>
SFM-SF06SFM-SF06 PinCable ColorBoard Pin
ADDR1
SDA2D20/SDA
GND3GND
VDD43.3V
SCL5D21/SCL
IRQn6
<img src="images/Arduino-Mega-2560-Rev3-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>ESP32 DevKitC</summary> <p>
SFM-SF06SFM-SF06 PinCable ColorBoard Pin
ADDR1
SDA2GPIO 21
GND3GND
VDD43V3
SCL5GPIO 22
IRQn6
<img src="images/esp32-devkitc-i2c-pinout-3.3V.png" width="600px"> </p> </details>

Quick Start

  1. Install the libraries and dependencies according to Installation of the library

  2. Connect the SFM-SF06 sensor to your Arduino as explained in Sensor wiring

  3. Open the exampleUsage sample project within the Arduino IDE:

    File ➔ Examples ➔ Sensirion I2C SFM-SF06 ➔ exampleUsage

    The provided example is working with a SFM4300, I²C address 0x2A. In order to use the code with another product or I²C address you need to change it in the code of examples/exampleUsage. You find the list with pre-defined addresses in src/SensirionI2CSfmSf06.h.

  4. Click the Upload button in the Arduino IDE or Sketch ➔ Upload

  5. When the upload process has finished, open the Serial Monitor or Serial Plotter via the Tools menu to observe the measurement values. Note that the Baud Rate in the used tool has to be set to 115200 baud.

Contributing

Contributions are welcome!

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 :)

This Sensirion library uses clang-format to standardize the formatting of all our .cpp and .h files. Make sure your contributions are formatted accordingly:

The -i flag will apply the format changes to the files listed.

clang-format -i src/*.cpp src/*.h

Note that differences from this formatting will result in a failed build until they are fixed.

License

See LICENSE.