Big overhaul of the UI framework (#1749)

* Starting GUI render refactor to be more immediate mode

Update TemperatureAdjust.cpp

.

Cleanup Soldering

Sleep

SolderingProfiles

Soldering Rework

Rough pass GUI

Temp Adjust

Cleanup old OperatingMode

Debug Menu

* Update TemperatureAdjust.cpp

* Roughing some transition work

* Fixup! Hook in the init starter helper

* Better home screen button handler

* FIXUP! Fix typo's

.

* Update SettingsMenu.cpp

* More settings rework

* More settings rendering

* Fixup

* Transitions

Update SolderingProfile.cpp

Hook in transistions

* Update TemperatureAdjust.cpp

* Update push.yml

* Add auto-repeat to settings menu

* Miniware: Use IT for I2C writes

* Update USBPDDebug_HUSB238.cpp

* Force write screen on side animation cancel

.

* Refactor moving down the settings list

* Update settingsGUI.cpp

* Update I2C_Wrapper.cpp

* Update OLED.cpp

* Rework button handling

* Fix PD debug at boot

* Fixup not showing right menu options

* silence some warnings

* Style cleanup

* Fkit use bit-bang I2C for Miniware

* Update GUIRendering.md

* Fixup transition on enter soldering mode

* Save Settings

* Fixes for some animations not running

Dont bail on animations if keypress is still held

* Fixup settings acceleration

* OLED Up animation

* Link up/down on debug meny

* Make all accelerometers I2C bus aware

Update accelerometers_common.h

* Make I2C mag optional

* Miniware -> Only Bit-Bang I2C

* Fixup for scrollbar

FIXUP! Debug menu returns to home screen

FIXUP! Up oled animation

Fix temp exit

* Settings menu -> Both buttons return a menu layer

* Merge fixup

* Update BMA223.cpp

* Re-Enable OLED sleep

* Save Setting on temp adjust exit

* WiP on startup mode

* Some autostart working

* Add hibernation mode & more autostart fixes

* If cant CJC; go to startup

* Hibernate in sleep

* Cleanup scroll indicator

* FIXUP! Ensure startup warnings are linked in

* FIXUP! Ensure we render out temp change before timing out

* Ensure 100ms delay between CJC samples

* Fix not re-calculating menu length on entering menu

* Implement NegotiationinProgress for USB-PD

* Mask heating until PD finishes negotiation

* Fixup staying in hibernate correctly

* Warning timeout

* Show reset settings warning

* Correctly compensate help text start time

* Update GUIThread.cpp

* Update USBPD.cpp

* .

* Fixup sleep time

* Update printSleepCountdown.cpp

* replacing countdown with big plus while in boost mode

* bringing back the + 1 since it was missing when not in boost mode

* Bail on USB-PD check after 3 seconds incase of DC source

* Fix hibernate

* Update PIDThread.cpp

* did center plus symbol (boost mode)

* Big refactor to not make settings increment handler handle the "is last item" return

* Fixup boot logo

* Fix flashing

* Fixup recalculate the menu length on long hold

* Fixup missing menu entries

* Fix junk left on screen after user confirmation

* Re-order button handler to use custom, then default order to allow setting associated setting

* Attach setting for settings using custom handler

* Fix swap +/- keys

* Fix boost temp

* Implement last menu option for Language selector

* Wait for init before CJC runs

* Check last setting via increment value

* Update BSP.cpp

* removed = from >=

Otherwise incrementing would stop and the scroll bar would already flash at the second to last value.

* (Hacky) Fix for Settings reset

---------

Co-authored-by: discip <53649486+discip@users.noreply.github.com>

source/Core/Inc/ScrollMessage.hpp

@@ -4,50 +4,21 @@
 #include "portmacro.h"
 #include <stdint.h>
 /**
- * A helper class for showing a full-screen scrolling message.
+ * A helper for showing a full-screen scrolling message.
  */
-class ScrollMessage {
-  TickType_t messageStart = 0;
-  int16_t    lastOffset   = -1;
 
-  /**
-   * Calcualte the width in pixels of the message string, in the large
-   * font and taking into account multi-byte chars.
-   *
-   * @param message The null-terminated message string.
-   */
-  static uint16_t messageWidth(const char *message);
-
-public:
-  ScrollMessage() {}
-
-  /**
-   * Resets this `ScrollMessage` instance to its initial state.
-   */
-  void reset() {
-    messageStart = 0;
-    lastOffset   = -1;
-  }
-
-  /**
-   * Gets whether this `ScrollMessage` instance is in its initial state.
-   */
-  bool isReset() const { return messageStart == 0; }
-
-  /**
-   * Draw and update the scroll message if needed.
-   *
-   * This function does not call `OLED::refresh()`. If this function
-   * returns `true`, the caller shall call `OLED::refresh()` to draw the
-   * modified framebuffer to the OLED screen.
-   *
-   * @param message The null-terminated message string. This must be the
-   * same string as the previous call, unless this `ScrollMessage` instance
-   * is in its initial state or `reset()` has been called.
-   * @param currentTick The current tick as returned by `xTaskGetTickCount()`.
-   * @return Whether the OLED framebuffer has been modified.
-   */
-  bool drawUpdate(const char *message, TickType_t currentTick);
-};
+/**
+ * Draw and update the scroll message if needed.
+ *
+ * This function does not call `OLED::refresh()`. If this function
+ * returns `true`, the caller shall call `OLED::refresh()` to draw the
+ * modified framebuffer to the OLED screen.
+ *
+ * @param message The null-terminated message string. This must be the
+ * same string as the previous call, unless this `ScrollMessage` instance
+ * is in its initial state or `reset()` has been called.
+ * @param currentTick The current tick as returned by `xTaskGetTickCount()` offset to 0 at start of scrolling.
+ */
+void drawScrollingText(const char *message, TickType_t currentTickOffset);
 
 #endif /* SCROLL_MESSAGE_HPP_ */

source/Core/Inc/Settings.h

@@ -107,8 +107,9 @@ void resetSettings();
 
 uint16_t getSettingValue(const enum SettingsOptions option);
 // Returns true if setting is now on the last value (next iteration will wrap)
-bool nextSettingValue(const enum SettingsOptions option);
-bool prevSettingValue(const enum SettingsOptions option);
+void nextSettingValue(const enum SettingsOptions option);
+void prevSettingValue(const enum SettingsOptions option);
+bool isLastSettingValue(const enum SettingsOptions option);
 
 void setSettingValue(const enum SettingsOptions option, const uint16_t newValue);
 

source/Core/Inc/Translation.h

@@ -183,6 +183,7 @@ const char *translatedString(uint16_t index);
 void prepareTranslations();
 void settings_displayLanguageSwitch(void);
 bool settings_showLanguageSwitch(void);
-bool settings_setLanguageSwitch(void);
+void settings_setLanguageSwitch(void);
+bool isLastLanguageOption(void);
 
 #endif /* TRANSLATION_H_ */

source/Core/Inc/Types.h

@@ -1,6 +1,6 @@
 #ifndef TYPES_H_
 #define TYPES_H_
-#include <stddef.h>
+#include <stdint.h>
 
 // Used for temperature represented in C or x10C.
 //

source/Core/Inc/settingsGUI.hpp

@@ -8,11 +8,11 @@
 #ifndef GUI_HPP_
 #define GUI_HPP_
 #include "BSP.h"
+#include "Buttons.hpp"
 #include "FreeRTOS.h"
 #include "Settings.h"
 #include "Translation.h"
 
-
 #define PRESS_ACCEL_STEP         (TICKS_100MS / 3)
 #define PRESS_ACCEL_INTERVAL_MIN TICKS_100MS
 #define PRESS_ACCEL_INTERVAL_MAX (TICKS_100MS * 3)
@@ -26,9 +26,8 @@ typedef struct {
   // The settings description index, please use the `SETTINGS_DESC` macro with
   // the `SettingsItemIndex` enum. Use 0 for no description.
   uint8_t description;
-  // return true if increment reached the maximum value
-  bool (*const incrementHandler)(void);
-  void (*const draw)(void);
+  void (*const incrementHandler)(void);
+  void (*const draw)(void); // Must not be nullptr, as that marks end of menu
   bool (*const isVisible)(void);
   // If this is set, we will automatically use the settings increment handler instead, set >= num settings to disable
   SettingsOptions   autoSettingOption;
@@ -36,8 +35,9 @@ typedef struct {
   uint8_t           shortDescriptionSize;
 } menuitem;
 
-void                  enterSettingsMenu();
-void                  warnUser(const char *warning, const TickType_t timeout);
-extern const menuitem rootSettingsMenu[];
+void                   enterSettingsMenu();
+bool                   warnUser(const char *warning, const ButtonState buttons);
+extern const menuitem  rootSettingsMenu[];
+extern const menuitem *subSettingsMenus[];
 
 #endif /* GUI_HPP_ */