From ec19c1913c0ed2d7ea89432e98d7313f07a52a7a Mon Sep 17 00:00:00 2001
From: Bjoern Kerler <info@revskills.de>
Date: Sun, 1 Sep 2024 17:14:19 +0200
Subject: [PATCH] Add display backlight brightness control

---
 src/gui/MItem_menus.cpp                       | 19 +++++++++++++++++++
 src/gui/MItem_menus.hpp                       | 10 ++++++++++
 src/gui/screen_menu_user_interface.hpp        |  3 ++-
 src/guiapi/include/gui_leds.hpp               | 16 +++++++++++++++-
 src/guiapi/src/gui_leds.cpp                   | 19 ++++++++++++++++---
 .../config_store/store_definition.hpp         |  2 ++
 6 files changed, 64 insertions(+), 5 deletions(-)

diff --git a/src/gui/MItem_menus.cpp b/src/gui/MItem_menus.cpp
index 1c01d46a7b..3b1b67a93c 100644
--- a/src/gui/MItem_menus.cpp
+++ b/src/gui/MItem_menus.cpp
@@ -25,6 +25,7 @@
 #include <option/has_leds.h>
 #if HAS_LEDS()
     #include "led_animations/animator.hpp"
+    #include "gui_leds.hpp"
 #endif
 #include "img_resources.hpp"
 #include "power_panic.hpp"
@@ -536,6 +537,24 @@ void MI_LEDS_ENABLE::OnChange(size_t old_index) {
 }
 #endif
 
+#if HAS_LEDS()
+/**********************************************************************************************/
+// MI_DISPLAY_BACKLIGHT_BRIGHTNESS
+static constexpr NumericInputConfig led_display_backlight_brightness_spin_config = {
+    // Keep a min value of 2 percent to make sure the user can still see the lcd content if changed by mistake
+    .min_value = 2,
+    .max_value = 100
+};
+
+MI_DISPLAY_BACKLIGHT_BRIGHTNESS::MI_DISPLAY_BACKLIGHT_BRIGHTNESS()
+    : WiSpin(config_store().leds_display_backlight_brightness.get(), led_display_backlight_brightness_spin_config, _(label), nullptr, is_enabled_t::yes, is_hidden_t::no) {
+}
+void MI_DISPLAY_BACKLIGHT_BRIGHTNESS::OnClick() {
+    leds::display_backlight_brightness(GetVal());
+    leds::store_display_backlight_brightness(GetVal());
+}
+#endif
+
 #if HAS_SIDE_LEDS()
 // MI_SIDE_LEDS_DIMMING_DURATION
 static constexpr NumericInputConfig side_led_dimming_spin_config = {
diff --git a/src/gui/MItem_menus.hpp b/src/gui/MItem_menus.hpp
index c24a2f982e..254074094d 100644
--- a/src/gui/MItem_menus.hpp
+++ b/src/gui/MItem_menus.hpp
@@ -413,6 +413,16 @@ class MI_LEDS_ENABLE : public WI_ICON_SWITCH_OFF_ON_t {
 };
 #endif
 
+#if HAS_LEDS()
+class MI_DISPLAY_BACKLIGHT_BRIGHTNESS : public WiSpin {
+    static constexpr const char *const label = N_("Display Backlight Brightness");
+
+public:
+    MI_DISPLAY_BACKLIGHT_BRIGHTNESS();
+    virtual void OnClick() override;
+};
+#endif
+
 #if HAS_SIDE_LEDS()
 class MI_SIDE_LEDS_ENABLE : public WI_ICON_SWITCH_OFF_ON_t {
     static constexpr const char *const label = N_("RGB Side Strip");
diff --git a/src/gui/screen_menu_user_interface.hpp b/src/gui/screen_menu_user_interface.hpp
index a7ca1d9984..bf38c10f0b 100644
--- a/src/gui/screen_menu_user_interface.hpp
+++ b/src/gui/screen_menu_user_interface.hpp
@@ -30,7 +30,8 @@ using ScreenMenuUserInterface__ = ScreenMenu<GuiDefaults::MenuFooter, MI_RETURN,
 #endif
 #if HAS_LEDS()
     ,
-    MI_LEDS_ENABLE
+    MI_LEDS_ENABLE,
+    MI_DISPLAY_BACKLIGHT_BRIGHTNESS
 #endif
 #if HAS_SIDE_LEDS()
     ,
diff --git a/src/guiapi/include/gui_leds.hpp b/src/guiapi/include/gui_leds.hpp
index 4f8c347492..a80f1446e0 100644
--- a/src/guiapi/include/gui_leds.hpp
+++ b/src/guiapi/include/gui_leds.hpp
@@ -49,7 +49,21 @@ void SetNth(Color clr, index n);
  *
  * @param percent Brightness in range 0 - 100
  */
-void SetBrightness(unsigned percent);
+void display_backlight_brightness(unsigned percent);
+
+/**
+ * @brief Read the Brightness of the display backlight from ConfigStore
+ *
+ * @return percent Brightness in range 2 - 100
+ */
+uint8_t get_display_backlight_brightness();
+
+/**
+ * @brief Store the Brightness of the display backlight to ConfigStore
+ *
+ * @param percent Brightness in range 2 - 100
+ */
+void store_display_backlight_brightness(uint8_t percent);
 
 /**
  * @brief Forces write on next call of tick loop
diff --git a/src/guiapi/src/gui_leds.cpp b/src/guiapi/src/gui_leds.cpp
index 9b4dcc64c6..045d1bedde 100644
--- a/src/guiapi/src/gui_leds.cpp
+++ b/src/guiapi/src/gui_leds.cpp
@@ -28,8 +28,10 @@ Neopixels &getNeopixels() {
 
 void leds::Init() {
     // Turn on LCD backlight
-    // TODO move SetBrightness to display
-    leds::SetBrightness(100);
+    // TODO move display_backlight_brightness to display
+    uint8_t value = leds::get_display_backlight_brightness();
+    // Safety: Make sure that the display is never turned off (value=0) on reboot/reset !
+    leds::display_backlight_brightness(value == 0 ? 100 : value);
     leds::TickLoop();
 
 #if HAS_SIDE_LEDS()
@@ -38,6 +40,16 @@ void leds::Init() {
     leds::side_strip_control.set_dimming_duration(config_store().side_leds_dimming_duration.get());
 #endif
 }
+
+uint8_t leds::get_display_backlight_brightness() {
+    return config_store().leds_display_backlight_brightness.get();
+}
+
+void leds::store_display_backlight_brightness(uint8_t percent) {
+    leds::display_backlight_brightness(percent);
+    return config_store().leds_display_backlight_brightness.set(percent);
+}
+
 void leds::ForceRefresh(size_t cnt) {
     getNeopixels().ForceRefresh(cnt);
 }
@@ -63,13 +75,14 @@ void leds::SetNth(Color clr, leds::index n) {
 // backlight is on WS2811 (RGB)
 // but color structure is meant for WS2812 (GRB)
 // so to set RED channel on WS2811 have to set GREEN
-void leds::SetBrightness(unsigned percent) {
+void leds::display_backlight_brightness(unsigned percent) {
     percent = std::min(100u, percent);
     percent *= 255;
     percent /= 100;
 
     SetNth(Color(0, percent, 0), index::backlight);
 }
+
 #if HAS_SIDE_LEDS()
 void SideStripControl::set_dimming_duration(int duration_sec) {
     config_store().side_leds_dimming_duration.set(duration_sec);
diff --git a/src/persistent_stores/store_instances/config_store/store_definition.hpp b/src/persistent_stores/store_instances/config_store/store_definition.hpp
index 9d534760b4..c7e1819ee9 100644
--- a/src/persistent_stores/store_instances/config_store/store_definition.hpp
+++ b/src/persistent_stores/store_instances/config_store/store_definition.hpp
@@ -332,6 +332,8 @@ struct CurrentStore
     StoreItem<bool, true, journal::hash("Enable Side LEDs dimming")> side_leds_dimming_enabled;
     StoreItem<int, 120, journal::hash("Side LEDs dimming duration")> side_leds_dimming_duration;
 
+    StoreItem<uint8_t, 100, journal::hash("Display backlight brightness")> leds_display_backlight_brightness;
+
     StoreItem<bool, true, journal::hash("Enable Tool LEDs")> tool_leds_enabled;
     StoreItem<uint8_t, 100, journal::hash("Tool LED brightness")> tool_leds_brightness;