Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/julienfdev/rp2040-bsec
An RP2040 port for the Bosch BSEC software (BME68x hi-level software library)
https://github.com/julienfdev/rp2040-bsec
Last synced: 4 days ago
JSON representation
An RP2040 port for the Bosch BSEC software (BME68x hi-level software library)
- Host: GitHub
- URL: https://github.com/julienfdev/rp2040-bsec
- Owner: julienfdev
- Created: 2024-11-02T21:45:02.000Z (14 days ago)
- Default Branch: main
- Last Pushed: 2024-11-02T21:53:39.000Z (14 days ago)
- Last Synced: 2024-11-02T22:24:09.684Z (14 days ago)
- Language: C
- Size: 0 Bytes
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# RP2040 BSEC Library
The RP2040 BSEC Library provides an interface to the Bosch BSEC (Bosch Software Environmental Cluster) library for use on the Raspberry Pi Pico (RP2040). This library allows you to interact with the BME68x sensor for environmental sensing, including IAQ (Indoor Air Quality), CO₂ levels, VOCs, and more. The library has been tailored for RP2040 boards and uses I2C communication with the BME68x sensor.
It uses the v2.6.1.0 version of the BSEC algorithm, which provides a higher-level signal processing and fusion for the BME68x sensor. The library receives compensated sensor values from the sensor API and processes the BME68x signals to provide the requested sensor outputs.
## Features
- Provides data from the BME68x sensor through the BSEC algorithm, which includes IAQ, static IAQ, CO₂ equivalent, breath VOC equivalent, temperature, humidity, and more.
- Supports configuration and state management of the BSEC algorithm.
- Allows control over sensor parameters like sample rate and output sensor subscriptions by using the provided configs
## Installation
### Git
To install the RP2040 BSEC Library, add it as a submodule to your project. Ensure you install the library recursively, as it relies on other submodules.
```sh
git submodule add --recursive https://github.com/your-username/rp2040-bsec.git lib/rp2040-bsec
```
### CMake
After adding the library as a submodule, update your `CMakeLists.txt` to include the RP2040 BSEC Library.
```cmake
# After the `pico_sdk_init` call
add_subdirectory(lib/rp2040-bsec)
# Link the library to your project
target_link_libraries(your_project rp2040_bsec)
# Include the library's header files
target_include_directories(your_project PRIVATE lib/rp2040-bsec)
```
### First Steps
1. **Setup I2C**: Make sure your RP2040 board is connected to the BME68x sensor via I2C. The library currently supports I2C communication exclusively. NB: If you're using an RTOS, you can provide your own non-blocking delay function in the BSec constructor.
2. **Initialization**: Initialize the BSEC library in your code by creating an instance of the `Bsec` class and configuring the sensor and sampling parameters. (see original .ino files for now, examples to be added to the project)
3. **Subscription Configuration**: Configure which data outputs you need and their sample rates through the `updateSubscription` method. It must be correlated with the config file you use.
4. **Running the Library**: Call the `run` method to obtain sensor data whenever available.
## Known Limitations
- **I2C Only**: This library supports I2C communication only; SPI is currently not supported.
- **Single Device Support**: Only one BME68x sensor can be used at a time. Multi-device support on a single i2c interface is planned for future updates.