https://github.com/sensirion/raspberry-pi-i2c-sfa3x
RaspberryPi driver for Sensirion SFA3x sensor module
https://github.com/sensirion/raspberry-pi-i2c-sfa3x
driver gas-sensor i2c raspberry-pi sensirion sfa30 sfa3x
Last synced: 2 months ago
JSON representation
RaspberryPi driver for Sensirion SFA3x sensor module
- Host: GitHub
- URL: https://github.com/sensirion/raspberry-pi-i2c-sfa3x
- Owner: Sensirion
- License: bsd-3-clause
- Created: 2021-03-15T16:31:04.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2025-03-18T09:59:19.000Z (over 1 year ago)
- Last Synced: 2025-03-18T10:39:10.095Z (over 1 year ago)
- Topics: driver, gas-sensor, i2c, raspberry-pi, sensirion, sfa30, sfa3x
- Language: C
- Homepage:
- Size: 1.07 MB
- Stars: 1
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Sensirion Raspberry Pi I²C SFA3X Driver
The repository provides a driver for setting up a SFA3X sensor to run on a Raspberry Pi over I²C.
Click [here](https://sensirion.com/products/catalog/SEK-SFA30) to learn more about the Sensirion SFA3X sensor.
The default I²C address of [SFA3X](https://sensirion.com/products/catalog/SFA30) is **0x5D**.
## Connect the sensor
Your sensor has 5 different connectors: VDD, GND, SDA, SCL, SEL.
Use the following pins to connect your SFA3X:
| *SFA3X* | *Cable Color* | *Raspberry Pi* |
| :----------------: | -------------- | ------------------ |
| VDD | red | Pin 1
| GND | black | Pin 6
| SDA | green | Pin 3
| SCL | yellow | Pin 5
| SEL | blue | Pin 9
### Detailed sensor pinout
| *Pin* | *Cable Color* | *Name* | *Description* | *Comments* |
|-------|---------------|:------:|----------------|------------|
| 1 | red | VDD | Supply Voltage | 3.15V to 5.5V
| 2 | black | GND | Ground |
| 3 | green | SDA | I2C: Serial data input / output |
| 4 | yellow | SCL | I2C: Serial clock input |
| 5 | blue | SEL | Interface select | Pull to GND to select I2C (leaving it floating selects UART)
## Quick start example
- [Install the Raspberry Pi OS on to your Raspberry Pi](https://projects.raspberrypi.org/en/projects/raspberry-pi-setting-up)
- [Enable the I²C interface in the raspi-config](https://www.raspberrypi.org/documentation/configuration/raspi-config.md)
- Download the SFA3X driver from [Github](https://github.com/Sensirion/raspberry-pi-i2c-sfa3x) and extract the `.zip` on your Raspberry Pi
- Connect the SFA3X sensor as explained in the [section above](#connect-the-sensor)
- Compile the driver
1. Open a [terminal](https://projects.raspberrypi.org/en/projects/raspberry-pi-using/8)
2. Navigate to the driver directory. E.g. `cd ~/raspberry-pi-i2c-sfa3x`
3. Navigate to the subdirectory example-usage.
4. Run the `make` command to compile the driver
Output:
```
rm -f sfa3x_i2c_example_usage
cc -Os -Wall -fstrict-aliasing -Wstrict-aliasing=1 -Wsign-conversion -fPIC -I. -o sfa3x_i2c_example_usage sfa3x_i2c.h sfa3x_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 sfa3x_i2c_example_usage.c
```
- Test your connected sensor
- Run `./sfa3x_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
```bash
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 `./sfa3x_i2c_example_usage` but do not get sensor readings but something like this instead
```
Error executing device_reset(): -1
Error executing get_device_marking(): -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 ./sfa3x_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`](https://releases.llvm.org/download.html) 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.
```bash
clang-format -i *.c *.h
```
Note that differences from this formatting will result in a failed build until
they are fixed.
## License
See [LICENSE](LICENSE).