How robotdynofficial/rbddimmer works
Project type and purpose
• This is an Arduino “RBDdimmer” library for AC‐triac dimming on multiple MCUs (AVR, SAM, SAMD21, ESP8266, ESP32, STM32, etc.).
• Purpose: provide a simple API (dimmerLamp, begin, setPower, getPower, setMode, getState, etc.) that abstracts zero‐cross detection, timer setup, and triac firing.
File structure
• Top level:
• README files and metadata (library.json, library.properties, index.json, keywords.txt) – used by Arduino IDE.
• examples/ – user sketches demonstrating API usage.
• src/
– RBDdimmer.h – core API and shared logic
– Platform subdirectories (avr, esp8266, esp32, sam, samd, stm32duino) each with RBDmcuXXX.cpp/.h – hardware‐abstraction implementations.
• No backend/frontend; it’s a zero‐footprint embedded library.
• Build: Arduino IDE picks the matching src/<platform> based on defined macros.
README for additional insights
• Describes supported boards and their zero‐cross and output pins.
• Details 10 API functions and two operating modes (NORMAL_MODE, TOGGLE_MODE).
• Illustrates how user code calls begin(), setPower(), etc., triggering timers and interrupts under the hood.
Main components
a. Components
1. User Application (Arduino Sketch – user code in examples/)
2. RBDdimmer Core (RBDdimmer.h + core logic)
3. Hardware Abstraction Layer (HAL) – dispatch to platform modules
4. Platform Modules (RBDmcuAVR, RBDmcuESP8266, RBDmcuESP32, RBDmcuSAM, RBDmcuSAMD21, RBDmcuSTM32F1…)
5. Hardware Resources
• Zero-cross detector (external interrupt pin)
• Timer peripheral (internal MCU timer)
• Output pin controlling triac/gate
b. Relationships and interactions
• User calls API → RBDdimmer Core
• Core calls HAL init functions → selects specific RBDmcuXXX based on MCU macro
• Platform module configures timer and external interrupt, implements low‐level trigger()
• Hardware module issues triac gate pulses on output pin at computed times
• Zero-cross interrupt fires, control returns to core for phase angle calculation
c. Architectural patterns / design principles
• Layered architecture: API layer → core logic → hardware abstraction → platform implementations → hardware
• Strategy / polymorphism: each RBDmcuXXX implements the same interface for timers and interrupts
• Conditional compilation: Arduino build system picks platform code via #ifdefs
d. Key technologies / libraries
• Standard Arduino API (pinMode, digitalWrite, attachInterrupt)
• MCU‐specific peripheral registers (timers, EXTI) abstracted in RBDmcu*.cpp
• build metadata (library.json) for Arduino CLI/IDE