https://github.com/sensirion/linux-sps30
Linux Kernel Driver for Sensirion SPS30. External module based on the upstream sps30 driver that is backported to older kernels
https://github.com/sensirion/linux-sps30
i2c iio kernel-driver particulate-matter raspberry-pi sensirion sensor sps30
Last synced: 5 months ago
JSON representation
Linux Kernel Driver for Sensirion SPS30. External module based on the upstream sps30 driver that is backported to older kernels
- Host: GitHub
- URL: https://github.com/sensirion/linux-sps30
- Owner: Sensirion
- License: other
- Created: 2020-01-17T10:26:45.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2020-04-08T14:29:27.000Z (almost 6 years ago)
- Last Synced: 2025-07-22T11:02:57.707Z (8 months ago)
- Topics: i2c, iio, kernel-driver, particulate-matter, raspberry-pi, sensirion, sensor, sps30
- Language: C
- Size: 18.6 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Sensirion SPS30 Linux Kernel Driver
The sps30 driver for the Sensirion SPS30 is based on the IIO subsystem.
The driver contained here was originally submitted to the Linux kernel mailing
list: https://lkml.org/lkml/2018/12/14/1066
Sensirion then backported it to older kernel versions.
## Requirements
Kernel with the following config options set, either as module or compiled in.
The config options must be listed in `.config` (e.g. selected with
`make menuconfig`)
Minimal driver requirements:
* `CONFIG_CRC8`
* `CONFIG_IIO`
## Directory Structure
/: The root directory contains the Makefile needed for out-of-tree
module builds.
/sps30: The sps30 directory contains the driver source and Kconfig as needed
for upstream merging with the Linux sources.
## Building
### Local Machine
Compiling for your local machine is useful to test if the driver compiles
correctly. Prerequisites are the kernel headers and build tools.
```bash
# Install dependencies
sudo apt install build-essential linux-headers-$(uname -r)
# configure
export KERNELDIR=/lib/modules/$(uname -r)/build
# build
make -j
```
To check for style issues we can use the `check` target
```bash
make check
```
### Cross Compiling
To cross compile, one needs to install a cross compilation tool chain and set
the `ARCH` and `CROSS_COMPILE` environment variables accordingly:
```bash
# Example to cross compile for raspbian
export ARCH=arm
export CROSS_COMPILE=~/opt/toolchain/gcc-linaro-arm-linux-gnueabihf-raspbian-x64/bin/arm-linux-gnueabihf-
```
## Usage
The driver is meant for direct use with sysfs or libiio.
Errors are printed to the kernel log (dmesg)
### Loading the Kernel Module
Load the dependencies of the sps30.ko kernel module:
```bash
sudo modprobe industrialio
sudo modprobe crc8
```
Load the kernel module with the appropriate command:
* Out-of-tree build
```bash
sudo insmod sps30.ko
```
* In-kernel build
```bash
sudo modprobe sps30
```
### Instantiation
Instantiate the driver on the correct i2c bus with
```bash
echo sps30 0x69 | sudo tee /sys/class/i2c-adapter/i2c-1/new_device
```
Only `sps30` is a permissible name.
### Operation
Query device files by reading from the iio subsytem's device:
```bash
cat /sys/bus/iio/devices/iio\:device0/in_concentration_pm2p5_input
```
or alternatively on the i2c bus: `/sys/bus/i2c/devices/1-0069/iio:device0/`
### Unloading
Unload the driver by removing the device instance and then unloading the module.
```bash
echo 0x69 | sudo tee /sys/class/i2c-adapter/i2c-1/delete_device
sudo rmmod sps30
```