A multi-platform sensor driver library for Arduino / PlatformIO / ESP-IDF.

• One library for Arduino / PlatformIO / ESP-IDF
• Supports I2C and SPI devices
• A collection of ready-to-run examples under examples/

• Contents
• Installation
  • Arduino IDE
  • PlatformIO
  • ESP-IDF
• Examples
• Support list
• Notes
• License
  • Third-party licenses

Option A: Install from Library Manager (recommended)

1. Open Arduino IDE
2. Go to Tools → Manage Libraries...
3. Search for SensorLib
4. Click Install
5. Restart Arduino IDE if needed

Option B: Install from ZIP

1. GitHub page → Code → Download ZIP
2. Arduino IDE → Sketch → Include Library → Add .ZIP Library...
3. Select the downloaded ZIP file
4. Restart Arduino IDE if the library does not appear immediately

Option C: Install with Git (manual)

1. Clone this repository into your Arduino libraries folder:
   • Windows: Documents/Arduino/libraries/
   • macOS: ~/Documents/Arduino/libraries/
   • Linux: ~/Arduino/libraries/
2. Folder name should be SensorLib
3. Restart Arduino IDE

Option A: Install from PlatformIO Registry (recommended)

Add to your platformio.ini:

[env:your_env]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
  lewisxhe/SensorLib@^0.4.0

Option B: Install from GitHub (latest)

[env:your_env]
platform = espressif32
board = esp32dev
framework = arduino
lib_deps =
  https://github.com/lewisxhe/SensorLib.git

Option C: Put it into lib/ (local library)

1. Copy/clone this repository into your PlatformIO project folder:
   • <your_project>/lib/SensorLib/
2. PlatformIO will auto-detect it as a local library

SensorLib is now published in the official ESP-IDF Component Registry, and supports ESP-IDF v4.4+ (recommended v5.1+).

1. Add Dependency (in project root idf_component.yml)

Create or edit idf_component.yml in your ESP-IDF project root:

dependencies:
  lewisxhe/sensorlib:
    version: "^0.4.0"          # or use "*" to get the latest version

• PlatformIO examples: see platformio.ini and uncomment the example src_dir you want to build.
• More examples are located in the examples/ folder.

• I2C devices typically require proper pull-up resistors on SDA/SCL.
• If you cannot detect devices, check wiring, address selection, and I2C speed (100kHz / 400kHz).

SensorLib is licensed under the MIT License. See LICENSE.

This repository includes third-party code under src/bosch/ from Bosch Sensortec, licensed under the BSD 3-Clause License (BSD-3-Clause).

See THIRD_PARTY_NOTICES.md for details.