feat(lightbulb): Add iic driver sm2182e

Author: shixinke-orion

components/led/lightbulb_driver/CHANGELOG.md

@@ -1,5 +1,12 @@
 # ChangeLog
 
+## v1.8.0 - 2025-03-28
+
+### Improve:
+
+- Added new dimming driver SM2182E
+- Modify some kconfig names. Please refer to [sdkconfig.rename](./sdkconfig.rename)
+
 ## v1.7.1 - 2025-03-05
 
 ### Bug Fix:

components/led/lightbulb_driver/CMakeLists.txt

@@ -23,6 +23,13 @@ if(CONFIG_ENABLE_SM2135EH_DRIVER)
     list(APPEND incs "drivers/common/iic/")
 endif()
 
+if(CONFIG_ENABLE_SM2182E_DRIVER)
+    list(APPEND srcs "drivers/sm2182e/sm2182e.c")
+    list(APPEND incs "drivers/sm2182e")
+    list(APPEND srcs "drivers/common/iic/iic.c")
+    list(APPEND incs "drivers/common/iic/")
+endif()
+
 if(CONFIG_ENABLE_SM2x35EGH_DRIVER)
     list(APPEND srcs "drivers/sm2x35egh/sm2x35egh.c")
     list(APPEND incs "drivers/sm2x35egh")

components/led/lightbulb_driver/Kconfig

@@ -21,6 +21,12 @@ menu "LightBulb Driver Config"
             help
                 Enable SM2135eh output.
 
+        config ENABLE_SM2182E_DRIVER
+            bool "Enable sm2182e interface"
+            default "y"
+            help
+                Enable SN2182e output.
+
         config ENABLE_SM2X35EGH_DRIVER
             bool "Enable sm2x35egh(sm2235egh sm2335egh) interface"
             default "y"

components/led/lightbulb_driver/README.md

@@ -13,6 +13,7 @@ The lightbulb component encapsulates several commonly used dimming schemes for l
 
   - ~~SM2135E~~
   - SM2135EH
+  - SM2182E
   - SM2X35EGH (SM2235EGH/SM2335EGH)
   - BP57x8D (BP5758/BP5758D/BP5768)
   - BP1658CJ

components/led/lightbulb_driver/README_CN.md

@@ -15,6 +15,7 @@
 
   - ~~SM2135E~~
   - SM2135EH
+  - SM2182E
   - SM2X35EGH (SM2235EGH/SM2335EGH)
   - BP57x8D (BP5758/BP5758D/BP5768)
   - BP1658CJ

components/led/lightbulb_driver/drivers/sm2182e/sm2182e.c

@@ -0,0 +1,168 @@
+/*
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#include <stdio.h>
+#include <string.h>
+
+#include <esp_log.h>
+
+#include "sm2182e.h"
+#include "iic.h"
+
+static const char *TAG = "driver_sm2182e";
+
+#define INVALID_ADDR        0xFF
+#define IIC_BASE_UNIT_HZ    1000
+#define SM2182E_MAX_PIN     2
+
+/**
+ * SM2182E register start address - Byte0
+ */
+/* B[7:6] */
+#define BASE_ADDR                   0xC0
+
+/* B[4:3] */
+#define BIT_ENABLE_ACTIVE           0x10
+#define BIT_DISABLE_OUTPUT          0x00
+
+/* B[2:0] */
+#define BIT_CH_FIXED_VALUE          0x03
+
+/**
+ * SM2135EH register current address - Byte1
+ */
+// Nothing
+
+/**
+ * SM2135EH register grayscale address - Byte2-5
+ *
+ *
+ */
+// Nothing
+
+typedef struct {
+    sm2182e_cw_current_t cw_current;
+    uint8_t mapping_addr[SM2182E_MAX_PIN];
+    bool init_done;
+} sm2182e_handle_t;
+
+static sm2182e_handle_t *s_sm2182e = NULL;
+
+esp_err_t sm2182e_set_standby_mode(bool enable_standby)
+{
+    DRIVER_CHECK(s_sm2182e, "not init", return ESP_ERR_INVALID_STATE);
+
+    uint8_t addr = 0;
+    uint8_t value[5] = {0};
+    if (enable_standby) {
+        addr = BASE_ADDR | BIT_DISABLE_OUTPUT | BIT_CH_FIXED_VALUE;
+    } else {
+        addr = BASE_ADDR | BIT_ENABLE_ACTIVE | BIT_CH_FIXED_VALUE;
+    }
+
+    return iic_driver_write(addr, value, sizeof(value));
+}
+
+esp_err_t sm2182e_set_shutdown(void)
+{
+    DRIVER_CHECK(s_sm2182e, "not init", return ESP_ERR_INVALID_STATE);
+
+    return sm2182e_set_standby_mode(true);
+}
+
+esp_err_t sm2182e_regist_channel(sm2182e_channel_t channel, sm2182e_out_pin_t pin)
+{
+    DRIVER_CHECK(s_sm2182e, "not init", return ESP_ERR_INVALID_STATE);
+    DRIVER_CHECK(channel >= SM2182E_CHANNEL_C && channel < SM2182E_CHANNEL_MAX, "check channel fail", return ESP_ERR_INVALID_ARG);
+    DRIVER_CHECK(pin < SM2182E_PIN_OUT_MAX, "check out pin fail", return ESP_ERR_INVALID_ARG);
+
+    s_sm2182e->mapping_addr[channel - 3] = pin;
+    return ESP_OK;
+}
+
+esp_err_t sm2182e_set_cw_channel(uint16_t value_c, uint16_t value_w)
+{
+    DRIVER_CHECK(s_sm2182e, "not init", return ESP_ERR_INVALID_STATE);
+    DRIVER_CHECK(s_sm2182e->mapping_addr[SM2182E_CHANNEL_C - 3] != INVALID_ADDR || s_sm2182e->mapping_addr[SM2182E_CHANNEL_W - 3] != INVALID_ADDR, "white channel not regist", return ESP_ERR_INVALID_STATE);
+    DRIVER_CHECK(value_c <= 1023 && value_w <= 1023, "value out of range", return ESP_ERR_INVALID_ARG);
+
+    uint8_t _value[5] = { 0 };
+    uint8_t addr = BASE_ADDR | BIT_ENABLE_ACTIVE | BIT_CH_FIXED_VALUE;
+
+    _value[0] = s_sm2182e->cw_current;
+
+    _value[(s_sm2182e->mapping_addr[0]) * 2 + 2] = value_c & 0xFF;
+    _value[(s_sm2182e->mapping_addr[0]) * 2 + 1] = value_c >> 8;
+
+    _value[(s_sm2182e->mapping_addr[1]) * 2 + 2] = value_w & 0xFF;
+    _value[(s_sm2182e->mapping_addr[1]) * 2 + 1] = value_w >> 8;
+
+    ESP_LOGD(TAG, "addr:%x [out1:[%x][%x] out2:[%x][%x]]", addr, _value[1], _value[2], _value[3], _value[4]);
+    return iic_driver_write(addr, _value, sizeof(_value));
+}
+
+sm2182e_cw_current_t sm2182e_cw_current_mapping(int current_mA)
+{
+    DRIVER_CHECK((current_mA >= 5) && (current_mA <= 80), "The current value is incorrect and cannot be mapped.", return SM2182E_CW_CURRENT_MAX);
+
+    const uint8_t limits[] = {5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80};
+    for (int i = 0; i < sizeof(limits); i++) {
+        if (current_mA == limits[i]) {
+            return (sm2182e_cw_current_t)i;
+        }
+    }
+
+    return SM2182E_CW_CURRENT_MAX;
+}
+
+esp_err_t sm2182e_init(driver_sm2182e_t *config, void(*hook_func)(void *))
+{
+    esp_err_t err = ESP_OK;
+
+    DRIVER_CHECK(config, "config is null", return ESP_ERR_INVALID_ARG);
+    DRIVER_CHECK(!s_sm2182e, "already init done", return ESP_ERR_INVALID_ARG);
+    DRIVER_CHECK(config->cw_current >= SM2182E_CW_CURRENT_5MA && config->cw_current < SM2182E_CW_CURRENT_MAX, "cw channel current param error", return ESP_ERR_INVALID_ARG);
+
+    s_sm2182e = calloc(1, sizeof(sm2182e_handle_t));
+    DRIVER_CHECK(s_sm2182e, "alloc fail", return ESP_ERR_NO_MEM);
+    memset(s_sm2182e->mapping_addr, INVALID_ADDR, SM2182E_MAX_PIN);
+
+    s_sm2182e->cw_current = config->cw_current;
+
+    if (config->freq_khz > 400) {
+        config->freq_khz = 400;
+        ESP_LOGW(TAG, "The frequency is too high, adjust it to 400khz");
+    }
+
+    err |= iic_driver_init(I2C_NUM_0, config->iic_sda, config->iic_clk, config->freq_khz * IIC_BASE_UNIT_HZ);
+    DRIVER_CHECK(err == ESP_OK, "i2c master init fail", goto EXIT);
+
+    if (config->enable_iic_queue) {
+        err |= iic_driver_send_task_create();
+        DRIVER_CHECK(err == ESP_OK, "task create fail", goto EXIT);
+    }
+
+    return err;
+EXIT:
+
+    if (s_sm2182e) {
+        free(s_sm2182e);
+        s_sm2182e = NULL;
+    }
+    return err;
+}
+
+esp_err_t sm2182e_deinit(void)
+{
+    DRIVER_CHECK(s_sm2182e, "not init", return ESP_ERR_INVALID_STATE);
+
+    sm2182e_set_shutdown();
+    iic_driver_deinit();
+    iic_driver_task_destroy();
+    free(s_sm2182e);
+    s_sm2182e = NULL;
+    return ESP_OK;
+}

components/led/lightbulb_driver/drivers/sm2182e/sm2182e.h

@@ -0,0 +1,122 @@
+/*
+ * SPDX-FileCopyrightText: 2022-2025 Espressif Systems (Shanghai) CO LTD
+ *
+ * SPDX-License-Identifier: Apache-2.0
+ */
+
+#pragma once
+#include "driver/gpio.h"
+
+/**
+ * @brief Current options for WY channels
+ *
+ */
+typedef enum {
+    SM2182E_CW_CURRENT_5MA,
+    SM2182E_CW_CURRENT_10MA,
+    SM2182E_CW_CURRENT_15MA,
+    SM2182E_CW_CURRENT_20MA,
+    SM2182E_CW_CURRENT_25MA,
+    SM2182E_CW_CURRENT_30MA,
+    SM2182E_CW_CURRENT_35MA,
+    SM2182E_CW_CURRENT_40MA,
+    SM2182E_CW_CURRENT_45MA,
+    SM2182E_CW_CURRENT_50MA,
+    SM2182E_CW_CURRENT_55MA,
+    SM2182E_CW_CURRENT_60MA,
+    SM2182E_CW_CURRENT_65MA,
+    SM2182E_CW_CURRENT_70MA,
+    SM2182E_CW_CURRENT_75MA,
+    SM2182E_CW_CURRENT_80MA,
+    SM2182E_CW_CURRENT_MAX,
+} sm2182e_cw_current_t;
+
+/**
+ * @brief Output configuration
+ *
+ */
+typedef struct {
+    sm2182e_cw_current_t cw_current;
+    gpio_num_t iic_clk;
+    gpio_num_t iic_sda;
+    bool enable_iic_queue;
+    uint16_t freq_khz;
+} driver_sm2182e_t;
+
+/**
+ * @brief SM2182E channel abstract definition
+ *
+ */
+typedef enum {
+    SM2182E_CHANNEL_C = 3,
+    SM2182E_CHANNEL_W,
+    SM2182E_CHANNEL_MAX,
+} sm2182e_channel_t;
+
+/**
+ * @brief SM2182E output pin definition
+ *
+ */
+typedef enum {
+    SM2182E_PIN_OUT1 = 0,
+    SM2182E_PIN_OUT2,
+    SM2182E_PIN_OUT_MAX,
+} sm2182e_out_pin_t;
+
+/**
+ * @brief Initialize sm2135e output
+ *
+ * @param config Driver configuration
+ * @param hook_func Hook function, which will be called inside the driver. e.g. to notify that config have been changed internally
+ * @return esp_err_t
+ */
+esp_err_t sm2182e_init(driver_sm2182e_t *config, void(*hook_func)(void *));
+
+/**
+ * @brief Register the sm2182e channel
+ * @note Needs to correspond to the real hardware
+ *
+ * @param channel Abstract channel
+ * @param pin Chip pin
+ * @return esp_err_t
+ */
+esp_err_t sm2182e_regist_channel(sm2182e_channel_t channel, sm2182e_out_pin_t pin);
+
+/**
+ * @brief Set only wy channel output
+ *
+ * @param value_w Output cold value
+ * @param value_y Output warm value
+ * @return esp_err_t
+ */
+esp_err_t sm2182e_set_cw_channel(uint16_t value_c, uint16_t value_w);
+
+/**
+ * @brief Stop all channel output
+ *
+ * @return esp_err_t
+ */
+esp_err_t sm2182e_set_shutdown(void);
+
+/**
+ * @brief Set standby mode
+ *
+ * @param enable_standby If set to true will enter standby mode
+ * @return esp_err_t
+ */
+esp_err_t sm2182e_set_standby_mode(bool enable_standby);
+
+/**
+ * @brief Convert the cw channel current value into the enumeration value required by the driver
+ *
+ * @param current_mA Only the following current values can be used: 5, 10, 15, 20, 25, 30, 35, 40, 45, 50, 55, 60, 65, 70, 75, 80
+ * @return sm2182e_cw_current_t
+ */
+sm2182e_cw_current_t sm2182e_cw_current_mapping(int current_mA);
+
+/**
+ * @brief Deinitialize sm2182e and release resources
+ *
+ * @return esp_err_t
+ */
+esp_err_t sm2182e_deinit(void);

components/led/lightbulb_driver/idf_component.yml

@@ -1,4 +1,4 @@
-version: "1.7.1"
+version: "1.8.0"
 description: Provide multiple dimming driver solutions to easily build lightbulb applications
 url: https://github.com/espressif/esp-iot-solution/tree/master/components/led/lightbulb_driver
 dependencies:

components/led/lightbulb_driver/include/lightbulb.h

@@ -22,6 +22,10 @@ extern "C" {
 #include "pwm.h"
 #endif
 
+#ifdef CONFIG_ENABLE_SM2182E_DRIVER
+#include "sm2182e.h"
+#endif
+
 #ifdef CONFIG_ENABLE_SM2135EH_DRIVER
 #include "sm2135eh.h"
 #endif
@@ -56,15 +60,16 @@ typedef enum {
     DRIVER_ESP_PWM = 1,
 
     /* IIC */
-    DRIVER_SM2135E,     // This version is no longer supported. Please checkout to v0.5.2
+    DRIVER_SM2135E = 10,        // This version is no longer supported. Please checkout to v0.5.2
     DRIVER_SM2135EH,
-    DRIVER_SM2x35EGH,   // Available for SM2235EGH SM2335EGH
-    DRIVER_BP57x8D,     // Available for BP5758 BP5758D BP5768D
-    DRIVER_BP1658CJ,
-    DRIVER_KP18058,
+    DRIVER_SM2182E,
+    DRIVER_SM2x35EGH,           // Available for SM2235EGH SM2335EGH
+    DRIVER_BP1658CJ = 20,
+    DRIVER_BP57x8D,             // Available for BP5758 BP5758D BP5768D
+    DRIVER_KP18058 = 40,
 
     /* Single Bus */
-    DRIVER_WS2812,
+    DRIVER_WS2812 = 100,
 
     DRIVER_SELECT_MAX,
 } lightbulb_driver_t;
@@ -305,6 +310,9 @@ typedef struct {
 #ifdef CONFIG_ENABLE_SM2135EH_DRIVER
         driver_sm2135eh_t sm2135eh;
 #endif
+#ifdef CONFIG_ENABLE_SM2182E_DRIVER
+        driver_sm2182e_t sm2182e;
+#endif
 #ifdef CONFIG_ENABLE_BP57x8D_DRIVER
         driver_bp57x8d_t bp57x8d;
 #endif