Awesome

Overview of Sensirion's GitHub Repositories

Table of Contents

1. Preface
2. Reference Drivers and Examples
   1. Repositories
   2. Concept
   3. Example use
3. Arduino Drivers and Examples
4. Python Packages
5. RaspberryPi Drivers and Examples
6. Third party repositories provided by our developer community
   1. Linux Kernel drivers
   2. From Paul van Haastrecht
   3. Sparkfun
   4. Adafruit
   5. Seeedstudio
   6. Rust packages
   7. Node packages

Preface

The goal of this page is to help users navigate the various driver offerings by Sensirion.

«Platform independent drivers requiring minimal porting efforts»

Sensirion is offering reference driver implementations that are meant to support customers in their product designs. These are tested extensively, and cover most of the common functionality of our sensors. They are also written in a platform independent way, to enable easy porting to new platforms. Because of that, they tend to be a bit more complex than a simple platform specific library, but offer peace of mind for the user to freely move to a different hardware platform with minimal adjustments. These drivers are described in the Reference Drivers and Examples section below.

«Platform specific prototyping starters»

We are also offering some platform specific libraries and code snippets to boost your prototyping activities. We have an extensive set of Arduino drivers and examples and Python packages, which can be used to communicate with our sensors via the Sensirion SensorBridge (Sensirion Evaluation Kit) .

We also offer some preconfigured and simplified variations of the reference drivers for the RaspberryPi platform. See the section RaspberryPi Drivers and Examples

«Thank you to the open source community»

Lastly, there's a few third party repositories that we wanted to include. Please note that Sensirion is creating these projects and therefore being listed there is not an official endorsement, but there's really great work out there by our community that we wanted to share with you!

Finally, feel free to report any issues you have with the drivers on the respective GitHub repository. If you have questions beyond the drivers we're sharing here - for example anything that's related to the sensors themselves, rather than the drivers - the best way to get help is to use the contact form on the Sensirion website.

For more information, please also check out or Developer Website.

Reference Drivers and Examples

Generic drivers for all platforms from small-scale embedded-systems to full-scale Operating Systems.

Repositories

Shared code can be found here https://github.com/Sensirion/embedded-common

Concept

Our reference drivers are our suggested starting point to implement stable products. They are tested intensively, and we provide support to our customers in case they face unexpected behaviour of the code.

It is implemented in a platform independent way, by means of a small "Hardware Abstraction Layer" (HAL) which abstracts the interface level commands (I2C, delay functions etc.) from the sensor readout protocols and timing. Because of that, the drivers can be ported to new platforms rather easily.

We currently support a range of sample implementation. At the time of writing this document, the following platforms are supported:

• Linux (with the I2C userspace interface, see below for Linux Kernel drivers)
• MBED OS
• Arduino Wire library (plus alternative I2C library)
• Microchip SAMD2
• Nordic nRF51
• STM32F1
• Zephyr (User Space)

The complete list of implementations is availble in the embedded-common repository.

• For devices with an I2C controller ("hardware-I2C") https://github.com/Sensirion/embedded-common/tree/master/i2c/sample-implementations
• For devices without an I2C controller, whereby I2C is modulated with the help of General-Purpose Input/Output Pins (GPIOs) ("software-I2C") https://github.com/Sensirion/embedded-common/tree/master/i2c/sample-implementations/GPIO_bit_banging/sample-implementations

Example use

To build a driver, there's three steps that need to be completed:

1. Download the release zip file from GitHub
2. Configure your platform, or build your own platform support file
3. Compile example / integrate into your application

As an example, for the SHTC1 humidity sensor for Linux user space:

1. Download the latest release zip file from https://github.com/Sensirion/embedded-sht/releases and unzip
2. Copy embedded-common/i2c/sample-implementations/linux_user_space/sensirion_i2c_hal.c to embedded-common/i2c/, thereby overwriting the empty sample implementation provided as starting point for new platform support.
3. type make shtc1_example_usage

After that, you should have an executable called shtc1_example_usage that will read out the SHTC1 sensor. Run it with ./shtc1_example_usage. Depending on the permissions on the I2C device file (which is defined as #define I2C_DEVICE_PATH "/dev/i2c-1" in the provided sample implementation) you might have to add your user to the respective group or run as root with sudo ./shtc1_example_usage.

Arduino Drivers and Examples

To simplify developing on the Arduino platform, we offer a range of dedicated libraries. Those are available directly though the Library Manager in the Arduino IDE or here on GitHub, so installation is just a few mouse clicks away.

The code can be found in the following repositories:

Shared code can be found here: Arduino Core

Finally, we offer some snippets to bootstrap our flow sensor based prototypes (SLG, SLI, SLS, SLQ-QTxxx, LG16-xxxxD, LS32, LPG10, LD20 and SLF3x): Arduino Liquid Flow Snippets

Want to understand every single step of your Arduino driver in one file? Check the Arduino Snippets and learn it from scratch.

Python Packages

The python packages work with our I2C and UART (SHDLC) sensors when attached to a compatible system. Compatible means, that the system provides an I2C Interface (e.g. a Raspberry Pi on Linux) for I2C sensors, or a COM-Port/Character device for UART (SHDLC) sensors. The Python drivers also work for I2C sensors attached with a SensorBridge

Raspberry Pi Drivers and Examples

The Raspberry Pi drivers are Reference Drivers, which we configured for Raspberry Pi and should work out of the box. See the corresponding README.md files for detailed setup and installation instructions.

Learn how to port any Reference Drivers to Raspberry Pi by reading this section.

Third party repositories provided by our developer community

:warning: Please note that libraries listed in this section are not maintained by Sensirion, and are not supported by Sensirion.

Note that this list does not claim to be complete. If you would like to have your repository listed here, please submit a pull request or file an issue containing the github URL. Thanks!

Linux Kernel drivers

While our reference drivers above support Linux' userspace I2C interface, there's also the option to build them into the kernel. Some of those drivers were authored by Sensirion (and are now maintained as part of the Linux kernel). The following drivers are available:

Via HWMON interface

• SHT1x (legacy): https://github.com/torvalds/linux/blob/master/drivers/hwmon/sht15.c
• SHT2x: CONFIG_SENSORS_SHT21 https://github.com/torvalds/linux/blob/master/drivers/hwmon/sht21.c
• SHT3x: CONFIG_SENSORS_SHT3x https://github.com/torvalds/linux/blob/master/drivers/hwmon/sht3x.c
• SHTC1/SHTC3, SHTW1/SHTW2: CONFIG_SENSORS_SHTC1 https://github.com/torvalds/linux/blob/master/drivers/hwmon/shtc1.c
• SHT4x: 'CONFIG_SENSOR_SHT4x' https://github.com/torvalds/linux/blob/master/drivers/hwmon/sht4x.c

Via IIO interface

• SGP30, SGPC3: CONFIG_SENSIRION_SGP30 https://github.com/torvalds/linux/blob/master/drivers/iio/chemical/sgp30.c
• SGP30, SGPC3: Out-of-tree module with more functionality and for older kernels: https://github.com/Sensirion/linux-sgp30/
• SPS30: CONFIG_SPS30 https://github.com/torvalds/linux/blob/master/drivers/iio/chemical/sps30.c
• SPS30: Out-of-tree module for older kernels: https://github.com/Sensirion/linux-sgp30/

From Paul van Haastrecht

• SPS30 on Arduino : https://github.com/paulvha/sps30
• SPS30 on Raspberry: https://github.com/paulvha/sps30_on_raspberry

Sparkfun

• SGP30 Arduino Library: https://github.com/sparkfun/SparkFun_SGP30_Arduino_Library
• SHTC3 Arduino Library: https://github.com/sparkfun/SparkFun_SHTC3_Arduino_Library
• SCD30 Arduino Library: https://github.com/sparkfun/SparkFun_SCD30_Arduino_Library

Adafruit

• SHT31 Arduino Library: https://github.com/adafruit/Adafruit_SHT31
• SHT31D CircuitPython Library: https://github.com/adafruit/Adafruit_CircuitPython_SHT31D
• SHTC3 Arduino Library: https://github.com/adafruit/Adafruit_SHTC3
• SHTC3 CircuitPython Library: https://github.com/adafruit/Adafruit_CircuitPython_SHTC3
• SGP30 Arduino Library: https://github.com/adafruit/Adafruit_SGP30
• SGP30 CircuitPython Library: https://github.com/adafruit/Adafruit_CircuitPython_SGP30

Seeedstudio

• SGP30 Arduino Library: https://github.com/Seeed-Studio/SGP30_Gas_Sensor
• SGP30 Python Driver: https://github.com/Seeed-Studio/Seeed_Python_SGP30
• SHT31 Arduino Library: https://github.com/Seeed-Studio/Grove_SHT31_Temp_Humi_Sensor
• SHT35 Arduino Library: https://github.com/Seeed-Studio/Seeed_SHT35
• SCD30 Arduino Library: https://github.com/Seeed-Studio/Seeed_SCD30

Rust packages

Sensirion HDLC

• Crate: https://crates.io/crates/sensirion-hdlc
• Source code: https://github.com/iohe/sensirion-hdlc

SPS30 UART

• Crate: https://crates.io/crates/sps30
• Source code: https://github.com/iohe/sps30

SPS30 I2C

• Crate: https://crates.io/crates/sps30-i2c
• Source code: https://github.com/david-gherghita/sps30-i2c-rs

SHTCX Driver

• Crate: https://crates.io/crates/shtcx
• Source code: https://github.com/dbrgn/shtcx-rs

SHT3x Driver

• Crate: https://crates.io/crates/sht3x
• Source code: https://github.com/miek/sht3x-rs

SGP30 Driver

• Crate: https://crates.io/crates/sgp30
• Source code: https://github.com/dbrgn/sgp30-rs

Node packages

Sensirion HDLC

Node package which uses Node SerialPort and RXJS to implement Sensirion HDLC.

• NPM package: https://www.npmjs.com/package/@cytera/sensirion-hdlc
• Source code: https://github.com/cytera/sensirion-hdlc-node