Skip to content

C driver to work with Sensirion's SFM3304 flow sensor via I2C on Raspberry-Pi

License

Notifications You must be signed in to change notification settings

Sensirion/raspberry-pi-i2c-sfm3304

Repository files navigation

Sensirion Raspberry Pi I²C SFM3304 Driver

The repository provides a driver for setting up a SFM3304 sensor to run on a Raspberry Pi over I²C.

Click here to learn more about the Sensirion SFM3304 sensor.

The default I²C address of SFM3304 is 0x2E.

Connect the sensor

Your sensor has 4 different connectors: VDD, SCL, GND, SDA. Use the following pins to connect your SFM3304:

SFM3304 Cable Color Raspberry Pi
VDD red Pin 1
SCL yellow Pin 5
GND black Pin 6
SDA green Pin 3

Detailed sensor pinout

Pin Cable Color Name Description Comments
1 NC Do not connect Ground for the heater
2 red VDD Supply Voltage 3.15V to 3.45V
3 yellow SCL I2C: Serial clock input
4 black GND Ground
5 green SDA I2C: Serial data input / output
6 NC Do not connect Supply voltage to the heater

Quick start example

  • Install the Raspberry Pi OS on to your Raspberry Pi

  • Enable the I²C interface in the raspi-config

  • Download the SFM3304 driver from Github and extract the .zip on your Raspberry Pi

  • Connect the SFM3304 sensor as explained in the section above

  • Compile the driver

    1. Open a terminal

    2. Navigate to the driver directory. E.g. cd ~/raspberry-pi-i2c-sfm3304

    3. Navigate to the subdirectory example-usage.

    4. Run the make command to compile the driver

      Output:

      rm -f sfm3304_i2c_example_usage
      cc -Os -Wall -fstrict-aliasing -Wstrict-aliasing=1 -Wsign-conversion -fPIC -I. -o sfm3304_i2c_example_usage  sfm3304_i2c.h sfm3304_i2c.c sensirion_i2c_hal.h sensirion_i2c.h sensirion_i2c.c \
          sensirion_i2c_hal.c sensirion_config.h sensirion_common.h sensirion_common.c sfm3304_i2c_example_usage.c
      
  • Test your connected sensor

    • Run ./sfm3304_i2c_example_usage in the same directory you used to compile the driver. You should see the measurement values in the console.

Troubleshooting

Building driver failed

If the execution of make in the compilation step 3 fails with something like

 make: command not found

your RaspberryPi likely does not have the build tools installed. Proceed as follows:

$ sudo apt-get update
$ sudo apt-get upgrade
$ sudo apt-get install build-essential

Initialization failed

If you run ./sfm3304_i2c_example_usage but do not get sensor readings but something like this instead

Error executing stop_continuous_measurement(): -1
Error executing read_product_identifier(): -1
Error executing start_continuous_measurement(): -1
...

then go through the below troubleshooting steps.

  • Ensure that you connected the sensor correctly: All cables are fully plugged in and connected to the correct pin.
  • Ensure that I²C is enabled on the Raspberry Pi. For this redo the steps on "Enable the I²C interface in the raspi-config" in the guide above.
  • Ensure that your user account has read and write access to the I²C device. If it only works with user root (sudo ./sfm3304_i2c_example_usage), it's typically due to wrong permission settings. See the next chapter how to solve this.

Missing I²C permissions

If your user is missing access to the I²C interface you should first verfiy the user belongs to the i2c group.

$ groups
users input some other groups etc

If i2c is missing in the list add the user and restart the Raspberry Pi.

$ sudo adduser your-user i2c
Adding user `your-user' to group `i2c' ...
Adding user your-user to group i2c
Done.
$ sudo reboot

If that did not help you can make globally accessible hardware interfaces with a udev rule. Only do this if everything else failed and you are reasoably confident you are the only one having access to your Pi.

Go into the /etc/udev/rules.d folder and add a new file named local.rules.

$ cd /etc/udev/rules.d/
$ sudo touch local.rules

Then add a single line ACTION=="add", KERNEL=="i2c-[0-1]*", MODE="0666" to the file with your favorite editor.

$ sudo vi local.rules

Contributing

Contributions are welcome!

This Sensirion library uses clang-format to standardize the formatting of all our .c 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 *.c *.h

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

License

See LICENSE.