sensirion/arduino-i2c-sfm-sf06

Arduino library to work with Sensirion's SF06 based flow sensors via I2C

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.

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 name	I²C Addresses
SFM4300	0x2A, 0x2B, 0x2C, 0x2D
SFM3119	0x29
SFM3003	0x28, 0x2D
SFM3013	0x2F
SFM3019	0x2E

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

• Sensirion Core

Sensor wiring

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

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

The recommended voltage is 3.3V.

Board specific wiring

You will find pinout schematics for recommended board models below:

Arduino Uno

SFM-SF06	SFM-SF06 Pin	Cable Color	Board Pin
ADDR	1
SDA	2		D18/SDA
GND	3		GND
VDD	4		3.3V
SCL	5		D19/SCL
IRQn	6

Arduino Nano

SFM-SF06	SFM-SF06 Pin	Cable Color	Board Pin
ADDR	1
SDA	2		A4
GND	3		GND
VDD	4		3.3V
SCL	5		A5
IRQn	6

Arduino Micro

SFM-SF06	SFM-SF06 Pin	Cable Color	Board Pin
ADDR	1
SDA	2		D2/SDA
GND	3		GND
VDD	4		3.3V
SCL	5		~D3/SCL
IRQn	6

Arduino Mega 2560

SFM-SF06	SFM-SF06 Pin	Cable Color	Board Pin
ADDR	1
SDA	2		D20/SDA
GND	3		GND
VDD	4		3.3V
SCL	5		D21/SCL
IRQn	6

ESP32 DevKitC

SFM-SF06	SFM-SF06 Pin	Cable Color	Board Pin
ADDR	1
SDA	2		GPIO 21
GND	3		GND
VDD	4		3V3
SCL	5		GPIO 22
IRQn	6

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.

arduino-i2c-sfm-sf06's Issues

SFM3013-300-CL Code Issue for connecting multiple sensors with Multiplexer(TCA9548A)

Hi, I am trying to connect two SFM-3013-300-CL's to an Arduino via a TCA9548A multiplexer to collect flow and temperature data. I am using the 'exampleusage.ino' file and have set the I2C multiplexer as specified. However I keep receiving the following error: Error trying to execute readMeasurementData(): Not enough data received

I am trying the to run the multiplexer with two sensors to test if it works with the following code:

`#include <Arduino.h>
#include <SensirionI2cSfmSf06.h>
#include <Wire.h>

#define TCAADDR 0x70
int active_sensors[8];

SensirionI2cSfmSf06 sensor;
SensirionI2cSfmSf06 sensor_2;

void tcaselect(uint8_t i) { // i stands for bus
if (i > 7) return;
Wire.beginTransmission(TCAADDR);
Wire.write(1 << i); // send byte to select bus
Wire.endTransmission();
}

static char errorMessage[64];
static int16_t error;

void print_byte_array(uint8_t* array, uint16_t len) {
uint16_t i = 0;
Serial.print("0x");
for (; i < len; i++) {
Serial.print(array[i], HEX);
}
}

void setup() {

Serial.begin(115200);
while (!Serial) {
    delay(100);
}
Wire.begin();
tcaselect(1);
sensor.begin(Wire, SFM3013_I2C_ADDR_2F);

tcaselect(1);
sensor.stopContinuousMeasurement();
delay(100);
uint32_t productIdentifier = 0;
uint8_t serialNumber[8] = {0};
error = sensor.readProductIdentifier(productIdentifier, serialNumber, 8);
if (error != NO_ERROR) {
    Serial.print("Error trying to execute readProductIdentifier(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}
Serial.print("productIdentifier: ");
Serial.print(productIdentifier);
Serial.print("\t");
Serial.print("serialNumber: ");
print_byte_array(serialNumber, 8);
Serial.println();
tcaselect(1);
error = sensor.startO2ContinuousMeasurement();
if (error != NO_ERROR) {
    Serial.print(
        "Error trying to execute startO2ContinuousMeasurement(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}

tcaselect(2);
sensor.begin(Wire, SFM3013_I2C_ADDR_2F);

tcaselect(2);
sensor.stopContinuousMeasurement();
delay(100);
uint32_t productIdentifier = 0;
uint8_t serialNumber[8] = {0};
error = sensor.readProductIdentifier(productIdentifier, serialNumber, 8);
if (error != NO_ERROR) {
    Serial.print("Error trying to execute readProductIdentifier(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}
Serial.print("productIdentifier: ");
Serial.print(productIdentifier);
Serial.print("\t");
Serial.print("serialNumber: ");
print_byte_array(serialNumber, 8);
Serial.println();
tcaselect(2);
error = sensor.startO2ContinuousMeasurement();
if (error != NO_ERROR) {
    Serial.print(
        "Error trying to execute startO2ContinuousMeasurement(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}

}

void loop() {

float aFlow = 0.0;
float aTemperature = 0.0;
uint16_t aStatusWord = 0u;
delay(100);
tcaselect(1);
error = sensor.readMeasurementData(aFlow, aTemperature, aStatusWord);
if (error != NO_ERROR) {
    Serial.print("Error trying to execute readMeasurementData(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}
Serial.print("aFlow: ");
Serial.print(aFlow);
Serial.print("\t");
Serial.print("aTemperature: ");
Serial.print(aTemperature);
Serial.print("\t");
Serial.print("aStatusWord: ");
Serial.print(aStatusWord);
Serial.println();

tcaselect(2);
error = sensor.readMeasurementData(aFlow, aTemperature, aStatusWord);
if (error != NO_ERROR) {
    Serial.print("Error trying to execute readMeasurementData(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}
Serial.print("aFlow: ");
Serial.print(aFlow);
Serial.print("\t");
Serial.print("aTemperature: ");
Serial.print(aTemperature);
Serial.print("\t");
Serial.print("aStatusWord: ");
Serial.print(aStatusWord);
Serial.println();

}`

Would appreciate any guidance.

SFM-3013-300-CL Wiring Diagram Arduino Mega

Hi,

Our team is attempting to connect SIX SFM-3013-300-CL Mass Flow Rate (MFR) Sensors to an Arduino Mega and get a readable output on a Laptop. This would require a multiplexer to enable multiple sensors to be integrated. The datasheet states the requirement for a 3.3kohm pull-up resistor to be fitted. Do these resistors need to be connected one to each the SDL and SCL port of each MFR sensor and then to the multiplexer? Would any additional components/resistors be required for this wiring diagram, and is this the right way to set up the system?

Thanks

Negative flow values when using SFM-3013

Hi there,

I seem to be getting negative values for flow moving in the direction of the arrow on the flow sensor and positive values for flow moving in the opposite direction. Would you be able to shine any light on this - am I missing something simple here??

Thanks,
Seán

SFM4300-50-P

Hi,
Thanks for creating this library, very easy to use.
I have a problem when using a SFM4300-50-P. When the flow rate is over 32 l/min, the value becomes negative (-32, then, the higher the flow, the lower this negative value, -30, -28, etc.). Could it be a problem of coding a byte operation?

I do not experience this problem when using a SFM4300-20-P, which is limited to 20 l/min.

Thanks

Reading Air-O2 Flow from SFM3003-300-CL

Hi,

I have been able to read O2 flow successfully using this library using the aforementioned SFM3003-300-CL library on an Arduino Nano 33 BLE. However, when I tried to use the startAirO2ContinuousMeasurement() function to read the both a mixture-flow from human breath (as well as the O2 concentration within this mixture), it started to give me large negative values for flow. Further, the last nine bits of the status word did not change to match a changing level of O2 concentration as they should according to the datasheet. This may be entirely due to my lack of understanding, so it would be much appreciated to get some clarity on this.

The following code is what I am currently using (note for others who use a Nano that I had to change the name of the variable "error" as it is a keyword in the Mbed OS driver commonly used on Arduino Nano systems):

// #include <Arduino.h>
#include <SensirionI2cSfmSf06.h>
#include <stdlib.h>
#include <stdint.h>

#include <Wire.h>

SensirionI2cSfmSf06 sensor;

static char errMessage[64];
static int16_t err;


void print_byte_array(uint8_t* array, uint16_t len) {
  uint16_t i = 0;
  Serial.print("0x");
  for (; i < len; i++) {
    Serial.print(array[i], HEX);
  }
}




void setup() {

  Serial.begin(115200);
  while (!Serial) {
    delay(100);
  }
  Wire.begin();
  sensor.begin(Wire, SFM3003_I2C_ADDR_28);

  sensor.stopContinuousMeasurement();
  delay(100);
  uint32_t productIdentifier = 0;
  uint8_t serialNumber[8] = { 0 };
  err = sensor.readProductIdentifier(productIdentifier, serialNumber, 8);
  if (err != NO_ERROR) {
    Serial.print("Error trying to execute readProductIdentifier(): ");
    errorToString(err, errMessage, sizeof errMessage);
    Serial.println(errMessage);
    return;
  }
  Serial.print("productIdentifier: ");
  Serial.print(productIdentifier);
  Serial.print("\t");
  Serial.print("serialNumber: ");
  print_byte_array(serialNumber, 8);
  Serial.println();

  
  uint16_t o2_vol_frac = 21; // in %, assuming 21% volume O2 in ambient air mixture.
  err = sensor.startAirO2ContinuousMeasurement(o2_vol_frac);
  if (err != NO_ERROR) {
    Serial.print(
      "Error trying to execute startO2ContinuousMeasurement(): ");
    errorToString(err, errMessage, sizeof errMessage);
    Serial.println(errMessage);
    return;
  }
}

void loop() {
 
  float aFlow = 0.0;
  float aTemperature = 0.0;
  uint16_t aStatusWord = 0u;
  delay(100);
  err = sensor.readMeasurementData(aFlow, aTemperature, aStatusWord);
  if (err != NO_ERROR) {
    Serial.print("Error trying to execute readMeasurementData(): ");
    errorToString(err, errMessage, sizeof errMessage);
    Serial.println(errMessage);
    return;
  }
  Serial.print("aFlow: ");
  Serial.println(aFlow);
  Serial.print("aTemperature: ");
  Serial.println(aTemperature);
  Serial.print("aStatusWord: ");
  Serial.println(aStatusWord);
}

The resulting output looks something like :

aFlow: -24583.00
aTemperature: 27.95
aStatusWord: 26645

which seems entirely incorrect. I am assuming that readFlowMeasurement is accurately using the scale factors and such due to its prior performance, which leaves either my use of the O2 volume input parameter or my use of the read function itself at fault.

Thank you for your help!

SFM3013 Arduino Interface Issue

Hi,

I am trying to connect an SFM-3013-CL to an Arduino Mega and I'm using this repo (arduino-i2c-sfm-sf06) as guidance to collect Temperature and Mass Flow Readings. Following is the Circuit Set-Up I've been using:

I have followed the guidance and downloaded the 'Sensirion I2C SFM-SF06' Library and also installed all the required dependencies onto the Arduino IDE. I decided to download and use the latest 'exampleUsage' file (1.4.0), SensirionI2cSfmSf06.h and SensirionI2cSfmSf06.cpp.

Following is the code I've used (from the exampleUsage file):

`
#include <Arduino.h>
#include <SensirionI2cSfmSf06.h>
#include <Wire.h>

SensirionI2cSfmSf06 sensor;

static char errorMessage[64];
static int16_t error;

void print_byte_array(uint8_t* array, uint16_t len) {
uint16_t i = 0;
Serial.print("0x");
for (; i < len; i++) {
Serial.print(array[i], HEX);
}
}

void setup() {

Serial.begin(115200);
while (!Serial) {
    delay(100);
}
Wire.begin();
sensor.begin(Wire, SFM3013_I2C_ADDR_2F);

sensor.stopContinuousMeasurement();
delay(100);
uint32_t productIdentifier = 0;
uint8_t serialNumber[8] = {0};
error = sensor.readProductIdentifier(productIdentifier, serialNumber, 8);
if (error != NO_ERROR) {
    Serial.print("Error trying to execute readProductIdentifier(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}
Serial.print("productIdentifier: ");
Serial.print(productIdentifier);
Serial.print("\t");
Serial.print("serialNumber: ");
print_byte_array(serialNumber, 8);
Serial.println();
error = sensor.startO2ContinuousMeasurement();
if (error != NO_ERROR) {
    Serial.print(
        "Error trying to execute startO2ContinuousMeasurement(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}

}

void loop() {

float aFlow = 0.0;
float aTemperature = 0.0;
uint16_t aStatusWord = 0u;
delay(100);
error = sensor.readMeasurementData(aFlow, aTemperature, aStatusWord);
if (error != NO_ERROR) {
    Serial.print("Error trying to execute readMeasurementData(): ");
    errorToString(error, errorMessage, sizeof errorMessage);
    Serial.println(errorMessage);
    return;
}
Serial.print("aFlow: ");
Serial.print(aFlow);
Serial.print("\t");
Serial.print("aTemperature: ");
Serial.print(aTemperature);
Serial.print("\t");
Serial.print("aStatusWord: ");
Serial.print(aStatusWord);
Serial.println();

}
`

However, upon running this, the serial monitor shows a maximum of 2-3 readings, and then stops displaying data and prints unreadable symbols:

Would appreciate if I could get guidance on what I am doing incorrectly, and how to resolve this.

Thanks.

SFM4300-20-P Negative value

Hi
Thank you for creating library, for very easy use.
I have configured SFM4300-20-P with Arduino mega 2560 in which facing of issue flow rate over 12 or 13 l/m value becomes negative. also after overlapping range it becomes 0 (request for support showing final range limit).

Function readMeasurementData returns integer on Arduino Due

Plaform: Arduino Due (SAM board package 1.6.12)
File: SensirionI2CSfmSf06.cpp
Function: SensirionI2CSfmSf06::readMeasurementData

flow = (intFlow - _flowOffset) / _flowScaleFactor;
should be changed to:
flow = (float)(intFlow - _flowOffset) / (float)(_flowScaleFactor);

otherwise it returns integer values.

Edit: typo in SAM board package version