feat(led): Update to allow configuration of the led sleep mode (#359)

* feat(led): Update to allow configuration of the led sleep mode * guard the led sleep mode around esp-idf 5.4 or greater
esp-cpp · Jan 10, 2025 · da19abf · da19abf
1 parent 4ee42c8
commit da19abf
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/components/led/include/led.hpp b/components/led/include/led.hpp
@@ -37,6 +37,17 @@ class Led : public BaseComponent {
     ledc_mode_t speed_mode{
         LEDC_LOW_SPEED_MODE};  /**< The LEDC speed mode you want for this LED channel. */
     bool output_invert{false}; /**< Whether to invert the GPIO output for this LED channel. */
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0) || defined(_DOXYGEN_)
+    ledc_sleep_mode_t sleep_mode{
+        LEDC_SLEEP_MODE_KEEP_ALIVE}; /**< The LEDC sleep mode you want for this
+                                        LED channel. Default is
+                                        LEDC_SLEEP_MODE_KEEP_ALIVE which will
+                                        keep the LEDC output when the system
+                                        enters light sleep. Note that this is
+                                        only useful if the LED's clock_config is
+                                        set to a clock source which supports
+                                        light sleep. */
+#endif
   };
 
   /**

diff --git a/components/led/src/led.cpp b/components/led/src/led.cpp
@@ -41,6 +41,9 @@ Led::Led(const Config &config) noexcept
     channel_conf.duty = actual_duty;
     channel_conf.gpio_num = conf.gpio;
     channel_conf.speed_mode = conf.speed_mode;
+#if ESP_IDF_VERSION >= ESP_IDF_VERSION_VAL(5, 4, 0)
+    channel_conf.sleep_mode = conf.sleep_mode;
+#endif
     channel_conf.hpoint = 0;
     channel_conf.timer_sel = conf.timer;
     channel_conf.flags.output_invert = conf.output_invert;