Home

Awesome

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.

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

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

Supported sensor types

Sensor nameI²C Addresses
STS300x4A, 0x4B
STS30A0x4A, 0x4B
STS31A0x4A, 0x4B
STS310x4A, 0x4B
STS320x4A, 0x4B
STS330x4A, 0x4B
STS350x4A, 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:

STS3XCable ColorRaspberry Pi
SDAgreenPin 3
GNDblackPin 6
SCLyellowPin 5
VDDredPin 1
<img src="images/raspi-i2c-pinout-3.3V.png" width="400px">

Detailed sensor pinout

<img src="images/STS3x_pinout.png" width="300px">
PinCable ColorNameDescriptionComments
1greenSDAI2C: Serial data input / output
2blackGNDGround
3yellowSCLI2C: Serial clock input
4redVDDSupply Voltage2.15V to 5.5V

Quick start example

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.

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.