thebigboschi/sps30

readme

 # SPS30 Particulate Matter Sensor Driver for ESP-IDF

This is a component for the Espressif IoT Development Framework (ESP-IDF) to interface with the Sensirion SPS30 particulate matter sensor using I2C.

## Connection

Connect the sensor to your ESP board as follows:

*   **VDD** to **3.3V** or **5V**
*   **GND** to **GND**
*   **SCL** to your desired SCL pin
*   **SDA** to your desired SDA pin
*   **SEL** to **GND** (to select I2C interface)

## How to use as a component

1.  Add the component to your project's dependencies in the `idf_component.yml` file:
    ```yaml
    dependencies:
      thebigboschi/sps30: "^1.0.0"
    ```
2.  Run `idf.py reconfigure` to download and install the component.
3.  In your `main.c`, you can now include the header with `#include "sps30.h"` and use the functions from the library.

## How to run the example

The provided example initializes the sensor, reads its metadata, and then continuously reads and prints measurement data.

1.  Navigate to the example directory:
    ```bash
    cd examples/basic_example
    ```
2.  **Important:** Open `main/main.c` and configure the `SDA_GPIO` and `SCL_GPIO` pins according to your hardware connections.
3.  Build, flash, and monitor the project using the ESP-IDF command-line tool:
    ```bash
    idf.py build flash monitor
    ```

## Publishing

This component is published on the [ESP-IDF Component Registry](https://components.espressif.com/components/thebigboschi/sps30).