https://github.com/sudodevinci/esp-environment-drivers
Centralized repository for i2c drivers for the ESP32 with thread-safety built-in. This would be an alternative to wrapping existing drivers such as BusIO from Adafruit.
https://github.com/sudodevinci/esp-environment-drivers
driver-programming drivers esp32 i2c i2c-bus rtos sensors threading
Last synced: about 1 month ago
JSON representation
Centralized repository for i2c drivers for the ESP32 with thread-safety built-in. This would be an alternative to wrapping existing drivers such as BusIO from Adafruit.
- Host: GitHub
- URL: https://github.com/sudodevinci/esp-environment-drivers
- Owner: sudoDeVinci
- Created: 2025-07-23T03:32:25.000Z (11 months ago)
- Default Branch: main
- Last Pushed: 2025-07-23T03:47:11.000Z (11 months ago)
- Last Synced: 2025-07-23T05:27:24.240Z (11 months ago)
- Topics: driver-programming, drivers, esp32, i2c, i2c-bus, rtos, sensors, threading
- Language: C++
- Homepage: https://devinci.space
- Size: 3.91 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Thread-Safe I2C Sensor Drivers for ESP32
[](https://github.com/sudoDeVinci/ESP-Environment-Drivers/actions/workflows/compile.yml)
[](https://github.com/sudoDeVinci/ESP-Environment-Drivers/actions/workflows/testing.yml)
While creating the [ESP-Sky-imager]("(https://github.com/sudoDeVinci/ESP-Sky-Imager") and [Esp-QuadCopter]("(https://github.com/sudoDeVinci/ESP-QuadCopter") projects, I ended up needing to also create a thread-safe alternative to the Adafruit BusIO drivers for my various sensors.
This repository is a collection of those drivers and any updates I make to them.
## Features
- **Thread-safe I2C communication** using timed mutexes
- **Automatic I2C bus management** with clock speed negotiation
- **Address conflict detection** and pin validation
- **Statistical processing utilities** for sensor data filtering
- **Comprehensive unit testing** with AUnit framework
- **ESP platform focus** The only target board type
## Supported Sensors
- **MPU6050** - 6-axis gyroscope and accelerometer
- **SHT31D** - Temperature and humidity sensor
- **BMP3xx** - Barometric pressure sensor *COMING SOON*
## Architecture
The library is built around two core components:
- [`I2CManager`](I2CManager.hpp) - Singleton that manages I2C buses, handles sensor registration, and negotiates clock speeds
- [`I2CSensor`](I2CSensor.hpp) - Base class providing common I2C functionality and statistical utilities
### I2C Bus Management
The manager automatically handles:
- Clock speed negotiation between multiple sensors on the same bus
- Address conflict detection
- Pin configuration validation
- Bus initialization and cleanup
### Statistical Processing
The base sensor class includes utilities for:
- Mean and standard deviation calculations
- Quartile computation and outlier removal using IQR method
- CRC8 checksum validation
## Usage
```cpp
#include "MPU6050.hpp"
#include "SHT31D.hpp"
#define I2C_SDA 21
#define I2C_SCL 22
MPU6050 gyro(0, I2C_SDA, I2C_SCL);
SHT31 tempSensor(0, I2C_SDA, I2C_SCL);
void setup() {
Serial.begin(115200);
if (!gyro.init()) {
Serial.println("MPU6050 initialization failed");
return;
}
if (!tempSensor.init()) {
Serial.println("SHT31D initialization failed");
return;
}
}
void loop() {
MPU_XYZ gyroData = gyro.readGyro();
if (tempSensor.update()) {
float temperature = tempSensor.getTemperature();
float humidity = tempSensor.getHumidity();
}
delay(100);
}
```
## Thread Safety
All I2C communication is protected by timed mutexes with configurable timeouts. The library ensures safe concurrent access to I2C buses when used in multi-threaded environments.
## Building and Testing
The project includes automated testing using the AUnit framework and EpoxyDuino for cross-platform compatibility.
### Running Tests
```bash
cd tests
make EPOXY_DUINO_DIR=../EpoxyDuino AUNIT_DIR=../AUnit
./tests.out
```
### Dependencies for Testing
- [AUnit](https://github.com/bxparks/AUnit) - Unit testing framework
- [EpoxyDuino](https://github.com/bxparks/EpoxyDuino) - Arduino emulation for native testing
## Ideas / TODOs
- [ ] An 'updateTimespan' attr within the sensors which update internal values. If the timespan has passed, grab new values. If the value hasn't passed, read the same. This would be good for sensors which we use the average of a range of readings, potentially saving a large number of calculations.
## License
This project is licensed under the Business Source License. See [LICENSE](LICENSE) for details.