Skip to content

Latest commit

 

History

History
185 lines (132 loc) · 6.24 KB

README.md

File metadata and controls

185 lines (132 loc) · 6.24 KB
Raw

Sensirion Raspberry Pi I²C STS3X Driver

The repository provides a driver for setting up a sensor of the STS3X family to run on a Raspberry Pi over I²C.

Click here to learn more about the Sensirion STS3X sensor family.

Supported sensor types

Sensor name I²C Addresses
STS30 0x4A, 0x4B
STS30A 0x4A, 0x4B
STS31A 0x4A, 0x4B
STS31 0x4A, 0x4B
STS32 0x4A, 0x4B
STS33 0x4A, 0x4B
STS35 0x4A, 0x4B

The following instructions and examples use a STS30.

Connect the sensor

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

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

Detailed sensor pinout

Pin Cable Color Name Description Comments
1 green SDA I2C: Serial data input / output
2 black GND Ground
3 yellow SCL I2C: Serial clock input
4 red VDD Supply Voltage 2.15V to 5.5V

Quick start example

  • Install the Raspberry Pi OS on to your Raspberry Pi

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

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

  • Connect the STS3X sensor as explained in the section above

  • The provided example is working with a STS30, I²C address 0x4A. In order to use the code with another product or I²C address you need to change it in the call sts3x_init(ADDRESS) in sts3x_i2c_example_usage.c. The list of supported I²C-addresses is found in the header sts3x_i2c.h.

  • Compile the driver

    1. Open a terminal

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

    3. Navigate to the subdirectory example-usage.

    4. Run the make command to compile the driver

      Output:

      rm -f sts3x_i2c_example_usage
cc -Os -Wall -fstrict-aliasing -Wstrict-aliasing=1 -Wsign-conversion -fPIC -I. -o sts3x_i2c_example_usage  sts3x_i2c.h sts3x_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 sts3x_i2c_example_usage.c

  • Test your connected sensor

    • Run ./sts3x_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 ./sts3x_i2c_example_usage but do not get sensor readings but something like this instead

Error executing stop_measurement(): -1
Error executing soft_reset(): -1
Error executing read_status_register(): -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 ./sts3x_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!

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 .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.