Home

Awesome

Sensirion I²C STS3X Arduino Library

This is the Sensirion STS3X library for Arduino allowing you to communicate with a sensor of the STS3X family 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.

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

Sensor wiring

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

<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

The recommended voltage is 3.3V.

Board specific wiring

You will find pinout schematics for recommended board models below:

<details><summary>Arduino Uno</summary> <p>
STS3XSTS3X PinCable ColorBoard Pin
SDA1greenD18/SDA
GND2blackGND
SCL3yellowD19/SCL
VDD4red3.3V
<img src="images/Arduino-Uno-Rev3-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>Arduino Nano</summary> <p>
STS3XSTS3X PinCable ColorBoard Pin
SDA1greenA4
GND2blackGND
SCL3yellowA5
VDD4red3.3V
<img src="images/Arduino-Nano-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>Arduino Micro</summary> <p>
STS3XSTS3X PinCable ColorBoard Pin
SDA1greenD2/SDA
GND2blackGND
SCL3yellow~D3/SCL
VDD4red3.3V
<img src="images/Arduino-Micro-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>Arduino Mega 2560</summary> <p>
STS3XSTS3X PinCable ColorBoard Pin
SDA1greenD20/SDA
GND2blackGND
SCL3yellowD21/SCL
VDD4red3.3V
<img src="images/Arduino-Mega-2560-Rev3-i2c-pinout-3.3V.png" width="600px"> </p> </details> <details><summary>ESP32 DevKitC</summary> <p>
STS3XSTS3X PinCable ColorBoard Pin
SDA1greenGPIO 21
GND2blackGND
SCL3yellowGPIO 22
VDD4red3V3
<img src="images/esp32-devkitc-i2c-pinout-3.3V.png" width="600px"> </p> </details>

Quick Start

  1. Install the libraries and dependencies according to Installation of the library

  2. Connect the STS3X sensor to your Arduino as explained in Sensor wiring

  3. Open the exampleUsage sample project within the Arduino IDE:

    File ➔ Examples ➔ Sensirion I2C STS3X ➔ exampleUsage

    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 code of exampleUsage. You find the list with pre-defined addresses in src/SensirionI2CSts3x.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.