How pluscrafter/i2cdevlib works
Project type and purpose
• This is an open-source, cross-platform I²C device driver library (“i2cdevlib”).
• Purpose: provide a uniform C/C++ interface (I2Cdev) and per-device classes (e.g., MPU6050, ADXL345) that abstract away platform-specific I²C/TWI details, plus example code and Doxygen-style documentation.
File structure
Top level:
• .gitignore, README
• Platform directories: Arduino, EFM32, ESP32_ESP-IDF, Jennic, MSP430, PIC18, RaspberryPi_bcm2835, STM32, STM32_HAL, dsPIC30F, nRF51
Inside each platform:
• A generic I2Cdev implementation (I2Cdev.cpp/h or .c/.h)
• Device-specific folders or components (e.g., MPU6050/, ADXL345/) containing .cpp/.c and .h files and “examples” subfolders with sample sketches/programs
• Some have platform build configs (Makefile, component.mk, nbproject files)
Shared:
• The generic device classes in Arduino/ and in each platform—they all depend on I2Cdev.
• Examples scattered under each device directory demonstrate usage.
README for additional insights
• Core abstraction class: I2Cdev
• Device classes derive from it to implement register-level operations described in device datasheets
• The I2Cdev class is static (one instance across all devices)
• Users include only the headers they need and link platform sources accordingly
• Documentation is generated via Doxygen from code comments
Elements
• Clear labels for each layer/component (e.g., “Device Classes”, “I2Cdev Core”, “Platform I2C HAL”, “Hardware”)
Examples → Device Classes → I2Cdev Core → Platform I2C HAL → Hardware
Source → Doxygen → HTML Docs
• Blue rectangles for code modules (Device, Core, PAL)
• Yellow parallelograms for examples/apps
Detailed capture of essential elements
• For each platform, show:
[Platform Folder]
└─ I2Cdev implementation
└─ Device classes (common list)
└─ Examples
• In the center, illustrate the generic Device API layer re-used across all platforms
• Side note: annotate that adding a new device only requires a new folder under Device Abstraction, and a new platform only requires a new PAL layer.