Skip to content

Latest commit

 

History

History
255 lines (194 loc) · 12 KB

README.md

File metadata and controls

255 lines (194 loc) · 12 KB
Raw

Overview over Sensirion's github repositories

Table of Contents

  1. Preface
  2. Reference Drivers
    1. Concept
    2. Repositories
    3. Example use
  3. Arduino driver repositories and examples
  4. Python Drivers
  5. 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

Preface

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

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

We are also offering some platform specific libraries, in particular for Arduino based platforms. These offer reduced complexity, but cannot be ported to other platforms easily. See the section Arduino driver repositories and examples below.

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 outside of 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

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

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.

Repositories

Product prefix Function Bus Repository
SHT humidity and temperature I2C embedded-sht
STS temperature I2C embedded-sts
SCD Carbon Dioxide (CO2) I2C embedded-scd
SPS Particulate Matter (PM0.5, PM1.0, PM2.5, PM4 and PM10) I2C embedded-sps
SPS Particulate Matter (PM0.5, PM1.0, PM2.5, PM4 and PM10) UART embedded-uart-sps
SFM gas flow meter I2C embedded-sfm
SGP, SVM30 Metal-Oxide (MOX) gas sensor I2C embedded-sgp
SVM40 Metal-Oxide (MOX) VOC sensor I2C embedded-svm40

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

Example use

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

  1. Download the a 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/hw_i2c/sample-implementations/linux_user_space/sensirion_hw_i2c_implementation.c to embedded-common/hw_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 driver repositories 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, so installation is just a few mouse clicks away.

The code can be found in the following repositories:

We also provide a library for our environmental sensor shield products, which come with SGP30/SHTC1 and SGPC3/SHTC3 respectively: https://github.com/Sensirion/arduino-ess

In addition to the libraries we provide sample projects for a few of our sensors. The zips of those project can be found at the following links:

Finally, we offer some snippets to help getting started with our flow sensor products (SLG, SLI, SLS, SLQ-QTxxx, LG16-xxxxD, LS32, LPG10, LD20 and SLF3x): https://github.com/Sensirion/arduino-liquid-flow-snippets

Python Drivers

The python drivers 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.

Product prefix Function Bus Repository
SensorBridge USB to I2C Gateway USB python-shdlc-sensorbridge
SVM40 humidity-compensated VOC sensor with humidity and temperature UART python-shdlc-svm40
SHT humidty and temperature I2C python-i2c-sht
SFM gas flow meter I2C via SensorBridge python-sensorbridge-i2c-sfm

Third party repositories provided by our developer community

⚠️ 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

Via IIO interface

From Paul van Haastrecht

Sparkfun

Adafruit

Seeedstudio

Rust packages

Sensirion HDLC

SPS30 UART

SPS30 I2C

SHTCX Driver

SHT3x Driver

SGP30 Driver