Merge branch 'feature/add_sm16825e_driver' into 'master'

feat(lightbulb_driver): add sm16825e chip driver

See merge request ae_group/esp-iot-solution!1357

Author: YuanMingfu-star

components/led/lightbulb_driver/CHANGELOG.md

@@ -1,5 +1,11 @@
 # ChangeLog
 
+## v1.10.0 - 2025-08-19
+
+### Improve:
+
+* Added new dimming driver SM16825E
+
 ## v1.9.0 - 2025-08-11
 
 ### Improve:
@@ -61,7 +67,7 @@
 
 ### Enhancements:
 
-* Remove linear dimming, default to enabling curve dimming for all. 
+* Remove linear dimming, default to enabling curve dimming for all.
 
 ## v1.4.0 - 2024-11-15
 
@@ -151,7 +157,7 @@
 * The driver now supports setting white balance parameters for all channels. This means that you can adjust the white balance individually for each channel, allowing for precise control and customization of the lighting output.
 * Increased the power limit range from 100-300 to 100-500, facilitating power setting for RGBWW beads.
 * Introduced CCT output modes: standard mode (consistent with original scheme, mapping percentage to Kelvin values proportionally) and precise mode (setting individual percentages for each Kelvin value and predetermining current coefficients for each channel, scaling these coefficients proportionally during writing).
-* Some configuration changes: 
+* Some configuration changes:
   * Removed mode_mask from capability, now using led_beads to set the LED panel bead combination
   * Renamed enable_mix_cct to enable_hardware_cct, fades_ms to fade_time_ms, and enable_fades to enable_fade
   * Removed hardware_monitor_cb
@@ -194,6 +200,7 @@
 * Add a phase delay function to the PWM drive, and after enabling this function, all channel outputs will be in a complementary state.
 
 ## v0.4.1 - 2023-8-30
+
 ### Bug Fixes:
 
 * Fixed a thread safety issue.
@@ -347,8 +354,8 @@
 ### Enhancements:
 
 * Initial version
-
 * The following dimming solutions are supported
+
   * PWM
     * RGB + CW
     * RGB + CCT/Brightness
@@ -360,13 +367,14 @@
     * BP5758/BP5758D/BP5768D
   * Single Line
     * WS2812
-
 * Support for power limit
 * Support for color calibration
 * Support for effect
+
   * Blink
   * Breathe
 * Support for application layer capability configuration
+
   * Status memory
   * Fade
   * Mix CCT

components/led/lightbulb_driver/CMakeLists.txt

@@ -63,6 +63,11 @@ if(CONFIG_ENABLE_WS2812_DRIVER)
     list(APPEND incs "drivers/ws2812")
 endif()
 
+if(CONFIG_ENABLE_SM16825E_DRIVER)
+    list(APPEND srcs "drivers/sm16825e/sm16825e.c")
+    list(APPEND incs "drivers/sm16825e")
+endif()
+
 idf_component_register(SRCS ${srcs}
                         INCLUDE_DIRS ${incs}
                         PRIV_INCLUDE_DIRS "src/priv_include"

components/led/lightbulb_driver/Kconfig

@@ -57,6 +57,12 @@ menu "LightBulb Driver Config"
             help
                 Enable ws2812 output.
 
+        config ENABLE_SM16825E_DRIVER
+            bool "Enable sm16825e interface"
+            default "y"
+            help
+                Enable SM16825E output.
+
         menu "IIC Config"
             depends on ENABLE_KP18058_DRIVER || ENABLE_BP1658CJ_DRIVER || ENABLE_BP57X8D_DRIVER || ENABLE_SM2X35EGH_DRIVER || ENABLE_SM2135EH_DRIVER || ENABLE_SM2135E_DRIVER
 

components/led/lightbulb_driver/README.md

@@ -8,7 +8,6 @@ The lightbulb component encapsulates several commonly used dimming schemes for l
 
   - RGB + C/W
   - RGB + CCT/Brightness
-
 - IIC Dimming Scheme
 
   - ~~SM2135E~~
@@ -18,10 +17,10 @@ The lightbulb component encapsulates several commonly used dimming schemes for l
   - BP57x8D (BP5758/BP5758D/BP5768)
   - BP1658CJ
   - KP18058
-
 - Single Bus Scheme:
 
   - WS2812
+  - SM16825E
 
 ## Supported common functionalities
 
@@ -130,6 +129,8 @@ lightbulb_init(&config);
 
 ## Example of Single-bus Scheme
 
+### WS2812 Usage example
+
 Single-bus scheme utilizes the SPI driver to output data for WS2812 LEDs, with data packaging sequence set as GRB.
 
 ```c
@@ -164,6 +165,139 @@ lightbulb_config_t config = {
 lightbulb_init(&config);
 ```
 
+### SM16825E usage example
+
+The SM16825E is an RGBWY five-channel LED driver that uses an SPI interface and RZ coding protocol, supporting 16-bit grey scale control and current regulation.
+
+```cpp
+lightbulb_config_t config = {
+    //1. Select SM16825E output and configure parameters
+    .type = DRIVER_SM16825E,
+    .driver_conf.sm16825e.led_num = 1,        // Number of LED chips
+    .driver_conf.sm16825e.ctrl_io = 9,        // Control GPIO pin
+    .driver_conf.sm16825e.freq_hz = 3333000,  // SPI frequency (default: 3.33MHz, auto-calculated based on RZ protocol timing)
+
+    //2. Driver capability selection, enable/disable according to your needs
+    .capability.enable_fade = true,
+    .capability.fade_time_ms = 800,
+    .capability.enable_lowpower = false,
+    .capability.enable_status_storage = true,
+    .capability.led_beads = LED_BEADS_5CH_RGBCW,  // Supports 5-channel RGBWY
+    .capability.storage_cb = NULL,
+    .capability.sync_change_brightness_value = true,
+
+    //3. Limit parameters, see details in later sections
+    .external_limit = NULL,
+
+    //4. Color calibration parameters
+    .gamma_conf = NULL,
+
+    //5. Initialize lighting parameters; if "on" is set, the light will turn on during driver initialization
+    .init_status.mode = WORK_COLOR,
+    .init_status.on = true,
+    .init_status.hue = 0,
+    .init_status.saturation = 100,
+    .init_status.value = 100,
+};
+lightbulb_init(&config);
+
+// Optional: Configure channel mapping (if custom pin mapping is needed)
+sm16825e_regist_channel(SM16825E_CHANNEL_R, SM16825E_PIN_OUTR);
+sm16825e_regist_channel(SM16825E_CHANNEL_G, SM16825E_PIN_OUTG);
+sm16825e_regist_channel(SM16825E_CHANNEL_B, SM16825E_PIN_OUTB);
+sm16825e_regist_channel(SM16825E_CHANNEL_W, SM16825E_PIN_OUTW);
+sm16825e_regist_channel(SM16825E_CHANNEL_Y, SM16825E_PIN_OUTY);
+
+// Optional: Set channel current (10-300mA)
+sm16825e_set_channel_current(SM16825E_CHANNEL_R, 100);  // 100mA
+sm16825e_set_channel_current(SM16825E_CHANNEL_G, 100);  // 100mA
+sm16825e_set_channel_current(SM16825E_CHANNEL_B, 100);  // 100mA
+sm16825e_set_channel_current(SM16825E_CHANNEL_W, 100);  // 100mA
+sm16825e_set_channel_current(SM16825E_CHANNEL_Y, 100);  // 100mA
+
+// Optional: Enable/disable standby mode
+sm16825e_set_standby(false);  // Disable standby mode, enable normal operation
+
+// Optional: Shutdown all channels
+// sm16825e_set_shutdown();
+```
+
+**Features of SM16825E**
+
+* Supports RGBWY five-channel independent control
+* 16-bit grayscale resolution (65,536 levels)
+* Adjustable current control (10-300mA per channel)
+* Supports standby mode (power consumption <2mW)
+* RZ encoding protocol, 800Kbps data transmission rate, 1200ns code period
+* Support multi-chip cascading
+* Auto-timing calculation: dynamically calculates SPI frequency and bit patterns based on datasheet parameters
+* Flexible channel mapping: supports arbitrary mapping from logical channels to physical pins
+* Optimized SPI transmission: uses 3.33MHz SPI frequency, each SM16825E bit encoded with 4 SPI bits
+
+#### SM16825E Advanced Features
+
+##### Channel Mapping Configuration
+
+SM16825E supports flexible channel mapping, allowing logical channels (R, G, B, W, Y) to be mapped to arbitrary physical pins:
+
+```c
+// Custom channel mapping example
+sm16825e_regist_channel(SM16825E_CHANNEL_R, SM16825E_PIN_OUT1);  // Red mapped to OUT1
+sm16825e_regist_channel(SM16825E_CHANNEL_G, SM16825E_PIN_OUT2);  // Green mapped to OUT2
+sm16825e_regist_channel(SM16825E_CHANNEL_B, SM16825E_PIN_OUT3);  // Blue mapped to OUT3
+sm16825e_regist_channel(SM16825E_CHANNEL_W, SM16825E_PIN_OUT4);  // White mapped to OUT4
+sm16825e_regist_channel(SM16825E_CHANNEL_Y, SM16825E_PIN_OUT5);  // Yellow mapped to OUT5
+```
+
+##### Current Control
+
+Each channel can independently set current value, range 10-300mA:
+
+```c
+// Set current for different channels
+sm16825e_set_channel_current(SM16825E_CHANNEL_R, config->current[SM16825E_CHANNEL_R]);  // Red Channel
+sm16825e_set_channel_current(SM16825E_CHANNEL_G, config->current[SM16825E_CHANNEL_G]);  // Green Channel
+sm16825e_set_channel_current(SM16825E_CHANNEL_B, config->current[SM16825E_CHANNEL_B]);  // Blue Channel
+sm16825e_set_channel_current(SM16825E_CHANNEL_W, config->current[SM16825E_CHANNEL_W]);  // White Channel
+sm16825e_set_channel_current(SM16825E_CHANNEL_Y, config->current[SM16825E_CHANNEL_Y]);  // Yellow Channel
+```
+
+##### Standby Mode Control
+
+Supports standby mode to reduce power consumption:
+
+```c
+// Enable standby mode (power consumption <2mW)
+sm16825e_set_standby(true);
+
+// Disable standby mode, resume normal operation
+sm16825e_set_standby(false);
+```
+
+##### Direct Channel Control
+
+Can directly set RGBWY channel values (0-255):
+
+```c
+// Set channel values
+sm16825e_set_rgbwy_channel(255, 128, 64, 192, 96);
+// Parameter order: red, green, blue, white, yellow
+
+// Shutdown all channels
+sm16825e_set_shutdown();
+```
+
+##### Timing Optimization Details
+
+The driver automatically calculates optimal timing based on datasheet parameters:
+
+- **RZ Encoding**: 800Kbps effective transmission rate, 1200ns code period
+- **SPI Frequency**: 3.33MHz, each SM16825E bit encoded with 4 SPI bits
+- **Timing Parameters**:
+  - T0 bit: 300ns high level + 900ns low level
+  - T1 bit: 900ns high level + 300ns low level
+  - Reset signal: minimum 200μs low level
+
 ## Example of Limit Parameters
 
 The primary purpose of limit parameters is to restrict the maximum output power and constrain the brightness parameters within a specific range. This component allows independent control of colored light and white light, which results in two sets of maximum/minimum brightness parameters and power parameters. Colored light uses the HSV model, with the value representing colored light brightness, while white light uses the brightness parameter. The input range for both value and brightness is 0 <= x <= 100.
@@ -195,16 +329,14 @@ input   output
 
 Power limit is applied after the brightness parameter limitations, and for the RGB channel adjustment, the range is 100 <= x <= 300. The relationship between input and output is as follows:
 
-```c
-input           output(color_max_power = 100)       output(color_max_power = 200)       output(color_max_power = 300)
-255,255,0       127,127,0                           255,255,0                           255,255,0
-127,127,0       63,63,0                             127,127,0                           127,127,0
-63,63,0         31,31,0                             63,63,0                             63,63,0
-255,255,255     85,85,85                            170,170,170                         255,255,255
-127,127,127     42,42,42                            84,84,84                            127,127,127
-63,63,63        21,21,21                            42,42,42                            63,63,63
-
-```
+|    input    | output(color_max_power = 100) | output(color_max_power = 200) | output(color_max_power = 300) |
+| :---------: | :---------------------------: | :---------------------------: | :---------------------------: |
+|  255,255,0  |           127,127,0           |           255,255,0           |           255,255,0           |
+|  127,127,0  |            63,63,0            |           127,127,0           |           127,127,0           |
+|   63,63,0   |            31,31,0            |            63,63,0            |            63,63,0            |
+| 255,255,255 |           85,85,85           |          170,170,170          |          255,255,255          |
+| 127,127,127 |           42,42,42           |           84,84,84           |          127,127,127          |
+|  63,63,63  |           21,21,21           |           42,42,42           |           63,63,63           |
 
 ## Example of Calibration Parameters