Add LCD output to shell function 'Emulate UI'

stm-firmware/include/reflow-controller/ui/gui.h

@@ -22,6 +22,7 @@
 #define _GUI_H_
 
 #include <stdint.h>
+#include <stddef.h>
 
 /**
  * @brief Handle the reflow controller's LCD Menu
@@ -29,10 +30,39 @@
  */
 int gui_handle(void);
 
+/**
+ * @brief Initialize the GUI (LCD, button, and rotary encoder)
+ */
 void gui_init(void);
 
+/**
+ * @brief Set a overlay message displayed on top of the root menu
+ * @param heading Heading of the overlay message (1st line)
+ * @param text Text of the overlay (the two bottom lines, 2 times 16 chars)
+ */
 void gui_root_menu_message_set(const char *heading, const char *text);
 
+/**
+ * @brief Directly write to the LCD
+ *
+ * This function writes directly to the LCD and doesn't use the handling FSM in the
+ * background. Therefore, the function will block until all data is written to the LCD.
+ *
+ * @param line line to write to. Starts at 0
+ * @param text Text to write to the line
+ */
 void gui_lcd_write_direct_blocking(uint8_t line, const char *text);
 
+/**
+ * @brief Get the vertical size of the display
+ * @return Count of rows
+ */
+size_t gui_get_line_count(void);
+
+/**
+ * @brief Return the const char disp[][21] array contianing all display rows
+ * @note This directly returns the working buffer pointer. Do not change it!
+ */
+const char (*gui_get_current_display_content(void))[21];
+
 #endif /* _GUI_H_ */