feat(ui): add battery status indication

* Update espp submodule to fix bug when unsubscribing from an event * Update menu to properly unsubscribe the menu component instead of the gui component (copy paste error from long ago) * Add battery header to box-emu-hal which includes the serialization component, adds a battery topic, and adds a BatteryInfo structure (the message data) * Updated menu and gui to have battery status icons (battery level symbol, charge symbol) and battery status labels * Updated menu and gui to subscribe to the battery topic and update their battery status displays when the event fires * Updated main to send new battery info every second to test charge and discharge display in main gui and menu (until hardware V1 arrives with support for actual SoC / charge measurement Closes #24
esp-cpp · Dec 28, 2023 · eb580f0 · eb580f0
1 parent a558a2a
commit eb580f0
Show file tree

Hide file tree

Showing 32 changed files with 3,497 additions and 994 deletions.
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -71,7 +71,7 @@ set(EMULATOR_COMPONENTS
 
 set(
   COMPONENTS
-  "main esptool_py esp_lcd esp_psram task format display display_drivers monitor esp-idf-cxx ${EMULATOR_COMPONENTS} box-emu-hal gui menu"
+  "main esptool_py esp_lcd esp_psram task format display display_drivers monitor timer ${EMULATOR_COMPONENTS} box-emu-hal gui menu"
   CACHE STRING
   "List of components to include"
   )

diff --git a/components/box-emu-hal/CMakeLists.txt b/components/box-emu-hal/CMakeLists.txt
@@ -1,5 +1,5 @@
 idf_component_register(
   INCLUDE_DIRS "include"
   SRC_DIRS "src"
-  REQUIRES "driver" "heap" "fatfs" "esp_lcd" "esp_psram" "hal" "usb" "esp_tinyusb" "spi_flash" "nvs_flash" "codec" "aw9523" "display" "display_drivers" "mcp23x17" "input_drivers" "tt21100" "gt911" "drv2605" "event_manager" "i2c" "task" "timer"
+  REQUIRES "driver" "heap" "fatfs" "esp_lcd" "esp_psram" "hal" "usb" "esp_tinyusb" "spi_flash" "nvs_flash" "codec" "aw9523" "display" "display_drivers" "mcp23x17" "input_drivers" "tt21100" "gt911" "drv2605" "event_manager" "i2c" "task" "timer" "serialization"
   )
diff --git a/components/box-emu-hal/include/battery.hpp b/components/box-emu-hal/include/battery.hpp
@@ -0,0 +1,10 @@
+#pragma once
+
+#include "serialization.hpp"
+
+static const std::string battery_topic = "battery";
+
+struct BatteryInfo {
+  uint8_t level;
+  bool charging;
+};
diff --git a/components/espp b/components/espp
diff --git a/components/gui/generated/CMakeLists.txt b/components/gui/generated/CMakeLists.txt
@@ -2,6 +2,7 @@ SET(SOURCES screens/ui_romscreen.c
     screens/ui_settingsscreen.c
     ui.c
     components/ui_comp_hook.c
-    ui_helpers.c)
+    ui_helpers.c
+    ui_events.c)
 
 add_library(ui ${SOURCES})
diff --git a/components/gui/generated/components/ui_comp_hook.c b/components/gui/generated/components/ui_comp_hook.c
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 
diff --git a/components/gui/generated/filelist.txt b/components/gui/generated/filelist.txt
@@ -3,3 +3,4 @@ screens/ui_settingsscreen.c
 ui.c
 components/ui_comp_hook.c
 ui_helpers.c
+ui_events.c
diff --git a/components/gui/generated/screens/ui_romscreen.c b/components/gui/generated/screens/ui_romscreen.c
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 
@@ -29,6 +29,28 @@ lv_obj_set_height( ui_Screen1_Label2, LV_SIZE_CONTENT);   /// 1
 lv_obj_set_align( ui_Screen1_Label2, LV_ALIGN_CENTER );
 lv_label_set_text(ui_Screen1_Label2,LV_SYMBOL_SETTINGS);
 
+ui_battery_soc_symbol_1 = lv_label_create(ui_header);
+lv_obj_set_width( ui_battery_soc_symbol_1, LV_SIZE_CONTENT);  /// 1
+lv_obj_set_height( ui_battery_soc_symbol_1, LV_SIZE_CONTENT);   /// 1
+lv_obj_set_x( ui_battery_soc_symbol_1, 52 );
+lv_obj_set_y( ui_battery_soc_symbol_1, 5 );
+lv_label_set_text(ui_battery_soc_symbol_1,LV_SYMBOL_BATTERY_EMPTY);
+
+ui_battery_charging_symbol_1 = lv_label_create(ui_header);
+lv_obj_set_width( ui_battery_charging_symbol_1, LV_SIZE_CONTENT);  /// 1
+lv_obj_set_height( ui_battery_charging_symbol_1, LV_SIZE_CONTENT);   /// 1
+lv_obj_set_x( ui_battery_charging_symbol_1, 70 );
+lv_obj_set_y( ui_battery_charging_symbol_1, 5 );
+lv_label_set_text(ui_battery_charging_symbol_1,"");
+
+ui_battery_soc_text_1 = lv_label_create(ui_header);
+lv_obj_set_width( ui_battery_soc_text_1, LV_SIZE_CONTENT);  /// 1
+lv_obj_set_height( ui_battery_soc_text_1, LV_SIZE_CONTENT);   /// 1
+lv_obj_set_x( ui_battery_soc_text_1, 52 );
+lv_obj_set_y( ui_battery_soc_text_1, -5 );
+lv_obj_set_align( ui_battery_soc_text_1, LV_ALIGN_BOTTOM_LEFT );
+lv_label_set_text(ui_battery_soc_text_1,"100%");
+
 ui_Screen1_Label1 = lv_label_create(ui_header);
 lv_obj_set_width( ui_Screen1_Label1, LV_SIZE_CONTENT);  /// 1
 lv_obj_set_height( ui_Screen1_Label1, LV_SIZE_CONTENT);   /// 1

diff --git a/components/gui/generated/screens/ui_settingsscreen.c b/components/gui/generated/screens/ui_settingsscreen.c
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 
@@ -16,6 +16,28 @@ lv_obj_set_width( ui_header1, lv_pct(100));
 lv_obj_set_align( ui_header1, LV_ALIGN_TOP_MID );
 lv_obj_clear_flag( ui_header1, LV_OBJ_FLAG_SCROLLABLE );    /// Flags
 
+ui_battery_charging_symbol = lv_label_create(ui_header1);
+lv_obj_set_width( ui_battery_charging_symbol, LV_SIZE_CONTENT);  /// 1
+lv_obj_set_height( ui_battery_charging_symbol, LV_SIZE_CONTENT);   /// 1
+lv_obj_set_x( ui_battery_charging_symbol, 70 );
+lv_obj_set_y( ui_battery_charging_symbol, 5 );
+lv_label_set_text(ui_battery_charging_symbol,"");
+
+ui_battery_soc_symbol = lv_label_create(ui_header1);
+lv_obj_set_width( ui_battery_soc_symbol, LV_SIZE_CONTENT);  /// 1
+lv_obj_set_height( ui_battery_soc_symbol, LV_SIZE_CONTENT);   /// 1
+lv_obj_set_x( ui_battery_soc_symbol, 52 );
+lv_obj_set_y( ui_battery_soc_symbol, 5 );
+lv_label_set_text(ui_battery_soc_symbol,LV_SYMBOL_BATTERY_EMPTY);
+
+ui_battery_soc_text = lv_label_create(ui_header1);
+lv_obj_set_width( ui_battery_soc_text, LV_SIZE_CONTENT);  /// 1
+lv_obj_set_height( ui_battery_soc_text, LV_SIZE_CONTENT);   /// 1
+lv_obj_set_x( ui_battery_soc_text, 52 );
+lv_obj_set_y( ui_battery_soc_text, -5 );
+lv_obj_set_align( ui_battery_soc_text, LV_ALIGN_BOTTOM_LEFT );
+lv_label_set_text(ui_battery_soc_text,"100%");
+
 ui_closebutton = lv_btn_create(ui_header1);
 lv_obj_set_width( ui_closebutton, 48);
 lv_obj_set_height( ui_closebutton, 48);
@@ -54,6 +76,7 @@ lv_obj_clear_flag( ui_volumepanel, LV_OBJ_FLAG_SCROLLABLE );    /// Flags
 
 ui_volumebar = lv_bar_create(ui_volumepanel);
 lv_bar_set_value(ui_volumebar,25,LV_ANIM_OFF);
+lv_bar_set_start_value(ui_volumebar, 0, LV_ANIM_OFF);
 lv_obj_set_width( ui_volumebar, 130);
 lv_obj_set_height( ui_volumebar, 10);
 lv_obj_set_x( ui_volumebar, 25 );
@@ -111,6 +134,7 @@ lv_obj_clear_flag( ui_brightnesspanel, LV_OBJ_FLAG_SCROLLABLE );    /// Flags
 
 ui_brightnessbar = lv_bar_create(ui_brightnesspanel);
 lv_bar_set_value(ui_brightnessbar,100,LV_ANIM_OFF);
+lv_bar_set_start_value(ui_brightnessbar, 0, LV_ANIM_OFF);
 lv_obj_set_width( ui_brightnessbar, 180);
 lv_obj_set_height( ui_brightnessbar, 10);
 lv_obj_set_align( ui_brightnessbar, LV_ALIGN_CENTER );

diff --git a/components/gui/generated/ui.c b/components/gui/generated/ui.c
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 
@@ -16,6 +16,9 @@ lv_obj_t *ui_header;
 void ui_event_settingsbutton( lv_event_t * e);
 lv_obj_t *ui_settingsbutton;
 lv_obj_t *ui_Screen1_Label2;
+lv_obj_t *ui_battery_soc_symbol_1;
+lv_obj_t *ui_battery_charging_symbol_1;
+lv_obj_t *ui_battery_soc_text_1;
 lv_obj_t *ui_Screen1_Label1;
 lv_obj_t *ui_playbutton;
 lv_obj_t *ui_Screen1_Label3;
@@ -28,6 +31,9 @@ lv_obj_t *ui_boxart;
 void ui_settingsscreen_screen_init(void);
 lv_obj_t *ui_settingsscreen;
 lv_obj_t *ui_header1;
+lv_obj_t *ui_battery_charging_symbol;
+lv_obj_t *ui_battery_soc_symbol;
+lv_obj_t *ui_battery_soc_text;
 void ui_event_closebutton( lv_event_t * e);
 lv_obj_t *ui_closebutton;
 lv_obj_t *ui_Screen1_Label4;

diff --git a/components/gui/generated/ui.h b/components/gui/generated/ui.h
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 
@@ -21,6 +21,9 @@ extern lv_obj_t *ui_header;
 void ui_event_settingsbutton( lv_event_t * e);
 extern lv_obj_t *ui_settingsbutton;
 extern lv_obj_t *ui_Screen1_Label2;
+extern lv_obj_t *ui_battery_soc_symbol_1;
+extern lv_obj_t *ui_battery_charging_symbol_1;
+extern lv_obj_t *ui_battery_soc_text_1;
 extern lv_obj_t *ui_Screen1_Label1;
 extern lv_obj_t *ui_playbutton;
 extern lv_obj_t *ui_Screen1_Label3;
@@ -31,6 +34,9 @@ extern lv_obj_t *ui_boxart;
 void ui_settingsscreen_screen_init(void);
 extern lv_obj_t *ui_settingsscreen;
 extern lv_obj_t *ui_header1;
+extern lv_obj_t *ui_battery_charging_symbol;
+extern lv_obj_t *ui_battery_soc_symbol;
+extern lv_obj_t *ui_battery_soc_text;
 void ui_event_closebutton( lv_event_t * e);
 extern lv_obj_t *ui_closebutton;
 extern lv_obj_t *ui_Screen1_Label4;

diff --git a/components/gui/generated/ui_events.h b/components/gui/generated/ui_events.h
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 

diff --git a/components/gui/generated/ui_helpers.c b/components/gui/generated/ui_helpers.c
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 

diff --git a/components/gui/generated/ui_helpers.h b/components/gui/generated/ui_helpers.h
@@ -1,5 +1,5 @@
 // This file was generated by SquareLine Studio
-// SquareLine Studio version: SquareLine Studio 1.3.3
+// SquareLine Studio version: SquareLine Studio 1.3.4
 // LVGL version: 8.3.3
 // Project name: emu
 

diff --git a/components/gui/include/gui.hpp b/components/gui/include/gui.hpp
@@ -11,6 +11,7 @@
 #include "task.hpp"
 #include "logger.hpp"
 
+#include "battery.hpp"
 #include "fs_init.hpp"
 #include "input.h"
 #include "hal_events.hpp"
@@ -52,12 +53,16 @@ class Gui {
     espp::EventManager::get().add_subscriber(mute_button_topic,
                                              "gui",
                                              std::bind(&Gui::on_mute_button_pressed, this, _1));
+    espp::EventManager::get().add_subscriber(battery_topic,
+                                             "gui",
+                                             std::bind(&Gui::on_battery, this, _1));
   }
 
   ~Gui() {
+    espp::EventManager::get().remove_subscriber(mute_button_topic, "gui");
+    espp::EventManager::get().remove_subscriber(battery_topic, "gui");
     task_->stop();
     deinit_ui();
-    espp::EventManager::get().remove_subscriber(mute_button_topic, "gui");
   }
 
   void ready_to_play(bool new_state) {
@@ -152,6 +157,8 @@ class Gui {
     set_mute(is_muted());
   }
 
+  void on_battery(const std::vector<uint8_t>& data);
+
   lv_img_dsc_t make_boxart(const std::string& path) {
     // load the file
     // auto start = std::chrono::high_resolution_clock::now();