Encapsulate common display code in a singleton (#12395)
* Encapsulate common LCD code in a singleton * Depend more UBL code on UBL_DEVEL_DEBUGGING - Since most users don't need the debugging on at all times, this helps reduce the default build size for UBL by over 2K, a little closer to fitting on 128K boards.
This commit is contained in:
Scott Lahteine
GitHub
@ -23,6 +23,21 @@
|
||||
|
||||
#include "../inc/MarlinConfig.h"
|
||||
|
||||
#if HAS_SPI_LCD
|
||||
|
||||
#include "../Marlin.h"
|
||||
|
||||
#if ENABLED(ADVANCED_PAUSE_FEATURE)
|
||||
#include "../feature/pause.h"
|
||||
#include "../module/motion.h" // for active_extruder
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
#if HAS_BUZZER
|
||||
#include "../libs/buzzer.h"
|
||||
#endif
|
||||
|
||||
#if HAS_GRAPHICAL_LCD
|
||||
|
||||
#ifndef LCD_PIXEL_WIDTH
|
||||
@ -171,13 +186,11 @@
|
||||
#define INFO_FONT_DESCENT 2
|
||||
#define INFO_FONT_HEIGHT (INFO_FONT_ASCENT + INFO_FONT_DESCENT)
|
||||
|
||||
// Font IDs
|
||||
enum MarlinFont : uint8_t {
|
||||
FONT_STATUSMENU = 1,
|
||||
FONT_EDIT,
|
||||
FONT_MENU
|
||||
};
|
||||
void lcd_setFont(const MarlinFont font_nr);
|
||||
|
||||
#if ENABLED(LIGHTWEIGHT_UI)
|
||||
void lcd_in_status(const bool inStatus);
|
||||
@ -185,46 +198,10 @@
|
||||
|
||||
#endif // HAS_GRAPHICAL_LCD
|
||||
|
||||
#if HAS_SPI_LCD || ENABLED(MALYAN_LCD) || ENABLED(EXTENSIBLE_UI)
|
||||
void lcd_init();
|
||||
bool lcd_detected();
|
||||
void lcd_update();
|
||||
void lcd_setalertstatusPGM(PGM_P message);
|
||||
void kill_screen(PGM_P lcd_msg);
|
||||
#else
|
||||
inline void lcd_init() {}
|
||||
inline bool lcd_detected() { return true; }
|
||||
inline void lcd_update() {}
|
||||
inline void lcd_setalertstatusPGM(PGM_P message) { UNUSED(message); }
|
||||
#endif
|
||||
|
||||
#define HAS_ENCODER_ACTION (HAS_LCD_MENU || ENABLED(ULTIPANEL_FEEDMULTIPLY))
|
||||
|
||||
#if HAS_ENCODER_ACTION
|
||||
extern uint32_t encoderPosition;
|
||||
#endif
|
||||
|
||||
#if HAS_SPI_LCD
|
||||
|
||||
#include "../Marlin.h"
|
||||
|
||||
#if ENABLED(ADVANCED_PAUSE_FEATURE)
|
||||
#include "../feature/pause.h"
|
||||
#include "../module/motion.h" // for active_extruder
|
||||
#endif
|
||||
|
||||
void lcd_status_screen();
|
||||
void lcd_return_to_status();
|
||||
bool lcd_hasstatus();
|
||||
void lcd_setstatus(const char* message, const bool persist=false);
|
||||
void lcd_setstatusPGM(PGM_P message, const int8_t level=0);
|
||||
void lcd_setalertstatusPGM(PGM_P message);
|
||||
void lcd_reset_alert_level();
|
||||
void lcd_reset_status();
|
||||
void lcd_status_printf_P(const uint8_t level, PGM_P const fmt, ...);
|
||||
void lcd_kill_screen();
|
||||
void kill_screen(PGM_P lcd_msg);
|
||||
|
||||
enum LCDViewAction : uint8_t {
|
||||
LCDVIEW_NONE,
|
||||
LCDVIEW_REDRAW_NOW,
|
||||
@ -233,37 +210,10 @@
|
||||
LCDVIEW_CALL_NO_REDRAW
|
||||
};
|
||||
|
||||
extern LCDViewAction lcdDrawUpdate;
|
||||
inline void lcd_refresh() { lcdDrawUpdate = LCDVIEW_CLEAR_CALL_REDRAW; }
|
||||
|
||||
#if HAS_BUZZER
|
||||
void lcd_buzz(const long duration, const uint16_t freq);
|
||||
#else
|
||||
inline void lcd_buzz(const long duration, const uint16_t freq) { UNUSED(duration); UNUSED(freq); }
|
||||
#endif
|
||||
|
||||
void lcd_quick_feedback(const bool clear_buttons=true); // Audible feedback for a button click - could also be visual
|
||||
|
||||
#if ENABLED(LCD_PROGRESS_BAR)
|
||||
extern millis_t progress_bar_ms; // Start time for the current progress bar cycle
|
||||
#if PROGRESS_MSG_EXPIRE > 0
|
||||
void dontExpireStatus();
|
||||
#endif
|
||||
#endif
|
||||
|
||||
#if ENABLED(LCD_SET_PROGRESS_MANUALLY)
|
||||
extern uint8_t progress_bar_percent;
|
||||
#endif
|
||||
|
||||
#if ENABLED(ADC_KEYPAD)
|
||||
uint8_t get_ADC_keyValue();
|
||||
#endif
|
||||
|
||||
#if HAS_LCD_CONTRAST
|
||||
extern int16_t lcd_contrast;
|
||||
void set_lcd_contrast(const int16_t value);
|
||||
#endif
|
||||
|
||||
#if HAS_GRAPHICAL_LCD
|
||||
#define SETCURSOR(col, row) lcd_moveto(col * (MENU_FONT_WIDTH), (row + 1) * (MENU_FONT_HEIGHT))
|
||||
#define SETCURSOR_RJ(len, row) lcd_moveto(LCD_PIXEL_WIDTH - len * (MENU_FONT_WIDTH), (row + 1) * (MENU_FONT_HEIGHT))
|
||||
@ -272,10 +222,6 @@
|
||||
#define SETCURSOR_RJ(len, row) lcd_moveto(LCD_WIDTH - len, row)
|
||||
#endif
|
||||
|
||||
#if ENABLED(SHOW_BOOTSCREEN)
|
||||
void lcd_bootscreen();
|
||||
#endif
|
||||
|
||||
#define LCD_UPDATE_INTERVAL 100
|
||||
#define BUTTON_EXISTS(BN) (defined(BTN_## BN) && BTN_## BN >= 0)
|
||||
#define BUTTON_PRESSED(BN) !READ(BTN_## BN)
|
||||
@ -284,41 +230,10 @@
|
||||
|
||||
typedef void (*screenFunc_t)();
|
||||
typedef void (*menuAction_t)();
|
||||
extern screenFunc_t currentScreen;
|
||||
void lcd_goto_screen(const screenFunc_t screen, const uint32_t encoder=0);
|
||||
|
||||
extern bool lcd_clicked;
|
||||
#if LCD_TIMEOUT_TO_STATUS
|
||||
extern bool defer_return_to_status;
|
||||
inline void set_defer_return_to_status(const bool defer) { defer_return_to_status = defer; }
|
||||
#else
|
||||
constexpr bool defer_return_to_status = false;
|
||||
#define set_defer_return_to_status(D) NOOP
|
||||
#endif
|
||||
|
||||
extern int16_t lcd_preheat_hotend_temp[2], lcd_preheat_bed_temp[2];
|
||||
extern uint8_t lcd_preheat_fan_speed[2];
|
||||
|
||||
#if ENABLED(AUTO_BED_LEVELING_UBL) || ENABLED(G26_MESH_VALIDATION)
|
||||
extern bool lcd_external_control;
|
||||
#else
|
||||
constexpr bool lcd_external_control = false;
|
||||
#endif
|
||||
|
||||
#if ENABLED(LCD_BED_LEVELING)
|
||||
extern bool lcd_wait_for_move;
|
||||
#else
|
||||
constexpr bool lcd_wait_for_move = false;
|
||||
#endif
|
||||
|
||||
// Manual Movement
|
||||
constexpr float manual_feedrate_mm_m[XYZE] = MANUAL_FEEDRATE;
|
||||
extern float move_menu_scale;
|
||||
#if IS_KINEMATIC
|
||||
extern bool processing_manual_move;
|
||||
#else
|
||||
constexpr bool processing_manual_move = false;
|
||||
#endif
|
||||
|
||||
#if ENABLED(ADVANCED_PAUSE_FEATURE)
|
||||
void lcd_advanced_pause_show_message(const AdvancedPauseMessage message,
|
||||
@ -326,65 +241,15 @@
|
||||
const uint8_t extruder=active_extruder);
|
||||
#endif
|
||||
|
||||
#if ENABLED(G26_MESH_VALIDATION)
|
||||
void lcd_chirp();
|
||||
#endif
|
||||
|
||||
#if ENABLED(AUTO_BED_LEVELING_UBL)
|
||||
void lcd_mesh_edit_setup(const float &initial);
|
||||
float lcd_mesh_edit();
|
||||
#endif
|
||||
|
||||
#if ENABLED(SCROLL_LONG_FILENAMES)
|
||||
extern uint8_t filename_scroll_pos, filename_scroll_max;
|
||||
#endif
|
||||
|
||||
#endif // HAS_LCD_MENU
|
||||
|
||||
#if ENABLED(FILAMENT_LCD_DISPLAY) && ENABLED(SDSUPPORT)
|
||||
extern millis_t previous_lcd_status_ms;
|
||||
#endif
|
||||
|
||||
#if ENABLED(STATUS_MESSAGE_SCROLLING)
|
||||
extern uint8_t status_scroll_offset;
|
||||
#endif
|
||||
|
||||
bool lcd_blink();
|
||||
|
||||
bool use_click();
|
||||
|
||||
#if ENABLED(AUTO_BED_LEVELING_UBL) || ENABLED(G26_MESH_VALIDATION)
|
||||
bool is_lcd_clicked();
|
||||
void wait_for_release();
|
||||
#endif
|
||||
|
||||
#elif ENABLED(EXTENSIBLE_UI)
|
||||
|
||||
// These functions are defined elsewhere
|
||||
void lcd_setstatus(const char* const message, const bool persist=false);
|
||||
void lcd_setstatusPGM(const char* const message, const int8_t level=0);
|
||||
void lcd_status_printf_P(const uint8_t level, const char * const fmt, ...);
|
||||
void lcd_reset_status();
|
||||
void lcd_refresh();
|
||||
void lcd_reset_alert_level();
|
||||
bool lcd_hasstatus();
|
||||
|
||||
#else // MALYAN_LCD or no LCD
|
||||
|
||||
constexpr bool lcd_wait_for_move = false;
|
||||
|
||||
inline void lcd_refresh() {}
|
||||
inline bool lcd_hasstatus() { return false; }
|
||||
inline void lcd_setstatus(const char* const message, const bool persist=false) { UNUSED(message); UNUSED(persist); }
|
||||
inline void lcd_setstatusPGM(PGM_P const message, const int8_t level=0) { UNUSED(message); UNUSED(level); }
|
||||
inline void lcd_status_printf_P(const uint8_t level, PGM_P const fmt, ...) { UNUSED(level); UNUSED(fmt); }
|
||||
inline void lcd_reset_alert_level() {}
|
||||
inline void lcd_reset_status() {}
|
||||
|
||||
#endif
|
||||
|
||||
#define HAS_DIGITAL_ENCODER (HAS_SPI_LCD && ENABLED(NEWPANEL))
|
||||
|
||||
#if HAS_DIGITAL_ENCODER
|
||||
|
||||
// Wheel spin pins where BA is 00, 10, 11, 01 (1 bit always changes)
|
||||
@ -402,103 +267,400 @@
|
||||
#if BUTTON_EXISTS(BACK)
|
||||
#define BLEN_D 3
|
||||
#define EN_D _BV(BLEN_D)
|
||||
#define LCD_BACK_CLICKED (buttons & EN_D)
|
||||
#define LCD_BACK_CLICKED() (buttons & EN_D)
|
||||
#endif
|
||||
|
||||
#endif // HAS_DIGITAL_ENCODER
|
||||
#if ENABLED(REPRAPWORLD_KEYPAD)
|
||||
#define REPRAPWORLD_BTN_OFFSET 0 // Bit offset into buttons for shift register values
|
||||
|
||||
#if HAS_LCD_MENU
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_F3 0
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_F2 1
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_F1 2
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_DOWN 3
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_RIGHT 4
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_MIDDLE 5
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_UP 6
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_LEFT 7
|
||||
|
||||
extern volatile uint8_t buttons; // The last-checked buttons in a bit array.
|
||||
void lcd_buttons_update();
|
||||
#define EN_REPRAPWORLD_KEYPAD_F1 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F1))
|
||||
#define EN_REPRAPWORLD_KEYPAD_F2 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F2))
|
||||
#define EN_REPRAPWORLD_KEYPAD_F3 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F3))
|
||||
#define EN_REPRAPWORLD_KEYPAD_DOWN (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_DOWN))
|
||||
#define EN_REPRAPWORLD_KEYPAD_RIGHT (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_RIGHT))
|
||||
#define EN_REPRAPWORLD_KEYPAD_MIDDLE (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_MIDDLE))
|
||||
#define EN_REPRAPWORLD_KEYPAD_UP (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_UP))
|
||||
#define EN_REPRAPWORLD_KEYPAD_LEFT (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_LEFT))
|
||||
|
||||
#define RRK(B) (buttons_reprapworld_keypad & (B))
|
||||
|
||||
#ifdef EN_C
|
||||
#define BUTTON_CLICK() ((buttons & EN_C) || RRK(EN_REPRAPWORLD_KEYPAD_MIDDLE))
|
||||
#else
|
||||
#define BUTTON_CLICK() RRK(EN_REPRAPWORLD_KEYPAD_MIDDLE)
|
||||
#endif
|
||||
|
||||
#elif ENABLED(LCD_I2C_VIKI)
|
||||
|
||||
#define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
|
||||
|
||||
// button and encoder bit positions within 'buttons'
|
||||
#define B_LE (BUTTON_LEFT << B_I2C_BTN_OFFSET) // The remaining normalized buttons are all read via I2C
|
||||
#define B_UP (BUTTON_UP << B_I2C_BTN_OFFSET)
|
||||
#define B_MI (BUTTON_SELECT << B_I2C_BTN_OFFSET)
|
||||
#define B_DW (BUTTON_DOWN << B_I2C_BTN_OFFSET)
|
||||
#define B_RI (BUTTON_RIGHT << B_I2C_BTN_OFFSET)
|
||||
|
||||
#if BUTTON_EXISTS(ENC) // The pause/stop/restart button is connected to BTN_ENC when used
|
||||
#define B_ST (EN_C) // Map the pause/stop/resume button into its normalized functional name
|
||||
#define BUTTON_CLICK() (buttons & (B_MI|B_RI|B_ST)) // Pause/stop also acts as click until a proper pause/stop is implemented.
|
||||
#else
|
||||
#define BUTTON_CLICK() (buttons & (B_MI|B_RI))
|
||||
#endif
|
||||
|
||||
// I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
|
||||
#define LCD_HAS_SLOW_BUTTONS
|
||||
|
||||
#elif ENABLED(LCD_I2C_PANELOLU2)
|
||||
|
||||
#if !BUTTON_EXISTS(ENC) // Use I2C if not directly connected to a pin
|
||||
|
||||
#define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
|
||||
|
||||
#define B_MI (PANELOLU2_ENCODER_C << B_I2C_BTN_OFFSET) // requires LiquidTWI2 library v1.2.3 or later
|
||||
|
||||
#define BUTTON_CLICK() (buttons & B_MI)
|
||||
|
||||
// I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
|
||||
#define LCD_HAS_SLOW_BUTTONS
|
||||
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
#else
|
||||
|
||||
inline void lcd_buttons_update() {}
|
||||
// Shift register bits correspond to buttons:
|
||||
#define BL_LE 7 // Left
|
||||
#define BL_UP 6 // Up
|
||||
#define BL_MI 5 // Middle
|
||||
#define BL_DW 4 // Down
|
||||
#define BL_RI 3 // Right
|
||||
#define BL_ST 2 // Red Button
|
||||
#define B_LE (_BV(BL_LE))
|
||||
#define B_UP (_BV(BL_UP))
|
||||
#define B_MI (_BV(BL_MI))
|
||||
#define B_DW (_BV(BL_DW))
|
||||
#define B_RI (_BV(BL_RI))
|
||||
#define B_ST (_BV(BL_ST))
|
||||
#define BUTTON_CLICK() (buttons & (B_MI|B_ST))
|
||||
|
||||
#endif
|
||||
|
||||
#if ENABLED(LCD_HAS_SLOW_BUTTONS)
|
||||
extern volatile uint8_t slow_buttons;
|
||||
#endif
|
||||
|
||||
#if ENABLED(REPRAPWORLD_KEYPAD)
|
||||
#define REPRAPWORLD_BTN_OFFSET 0 // Bit offset into buttons for shift register values
|
||||
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_F3 0
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_F2 1
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_F1 2
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_DOWN 3
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_RIGHT 4
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_MIDDLE 5
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_UP 6
|
||||
#define BLEN_REPRAPWORLD_KEYPAD_LEFT 7
|
||||
|
||||
#define EN_REPRAPWORLD_KEYPAD_F1 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F1))
|
||||
#define EN_REPRAPWORLD_KEYPAD_F2 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F2))
|
||||
#define EN_REPRAPWORLD_KEYPAD_F3 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F3))
|
||||
#define EN_REPRAPWORLD_KEYPAD_DOWN (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_DOWN))
|
||||
#define EN_REPRAPWORLD_KEYPAD_RIGHT (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_RIGHT))
|
||||
#define EN_REPRAPWORLD_KEYPAD_MIDDLE (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_MIDDLE))
|
||||
#define EN_REPRAPWORLD_KEYPAD_UP (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_UP))
|
||||
#define EN_REPRAPWORLD_KEYPAD_LEFT (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_LEFT))
|
||||
|
||||
#define RRK(B) (buttons_reprapworld_keypad & (B))
|
||||
|
||||
#ifndef BUTTON_CLICK
|
||||
#ifdef EN_C
|
||||
#define LCD_CLICKED() ((buttons & EN_C) || RRK(EN_REPRAPWORLD_KEYPAD_MIDDLE))
|
||||
#define BUTTON_CLICK() (buttons & EN_C)
|
||||
#else
|
||||
#define LCD_CLICKED() RRK(EN_REPRAPWORLD_KEYPAD_MIDDLE)
|
||||
#endif
|
||||
|
||||
#endif // REPRAPWORLD_KEYPAD
|
||||
|
||||
#ifndef LCD_CLICKED
|
||||
#ifdef EN_C
|
||||
#define LCD_CLICKED() (buttons & EN_C)
|
||||
#else
|
||||
#define LCD_CLICKED() false
|
||||
#define BUTTON_CLICK() false
|
||||
#endif
|
||||
#endif
|
||||
|
||||
extern uint8_t lcd_status_update_delay;
|
||||
extern char lcd_status_message[];
|
||||
#define LCD_MESSAGEPGM(x) ui.setstatusPGM(PSTR(x))
|
||||
#define LCD_ALERTMESSAGEPGM(x) ui.setalertstatusPGM(PSTR(x))
|
||||
|
||||
#define LCD_MESSAGEPGM(x) lcd_setstatusPGM(PSTR(x))
|
||||
#define LCD_ALERTMESSAGEPGM(x) lcd_setalertstatusPGM(PSTR(x))
|
||||
////////////////////////////////////////////
|
||||
//////////// MarlinUI Singleton ////////////
|
||||
////////////////////////////////////////////
|
||||
|
||||
// For i2c define BUZZ to use lcd_buzz
|
||||
#if ENABLED(LCD_USE_I2C_BUZZER)
|
||||
#define BUZZ(d,f) lcd_buzz(d, f)
|
||||
#endif
|
||||
class MarlinUI {
|
||||
public:
|
||||
|
||||
#if ENABLED(SD_REPRINT_LAST_SELECTED_FILE)
|
||||
void lcd_reselect_last_file();
|
||||
#endif
|
||||
|
||||
#if HAS_GRAPHICAL_LCD
|
||||
extern bool drawing_screen, first_page;
|
||||
#elif HAS_SPI_LCD
|
||||
constexpr bool first_page = true;
|
||||
#endif
|
||||
|
||||
// LCD implementations
|
||||
void lcd_implementation_clear();
|
||||
void lcd_implementation_init();
|
||||
|
||||
#if HAS_CHARACTER_LCD
|
||||
|
||||
enum HD44780CharSet : uint8_t { CHARSET_MENU, CHARSET_INFO, CHARSET_BOOT };
|
||||
|
||||
void lcd_set_custom_characters(
|
||||
#if ENABLED(LCD_PROGRESS_BAR) || ENABLED(SHOW_BOOTSCREEN)
|
||||
const HD44780CharSet screen_charset=CHARSET_INFO
|
||||
MarlinUI() {
|
||||
#if HAS_LCD_MENU
|
||||
currentScreen = status_screen;
|
||||
#endif
|
||||
);
|
||||
#if ENABLED(LCD_PROGRESS_BAR)
|
||||
#define LCD_SET_CHARSET(C) lcd_set_custom_characters(C)
|
||||
#else
|
||||
#define LCD_SET_CHARSET(C) lcd_set_custom_characters()
|
||||
}
|
||||
|
||||
static inline void buzz(const long duration, const uint16_t freq) {
|
||||
#if ENABLED(LCD_USE_I2C_BUZZER)
|
||||
lcd.buzz(duration, freq);
|
||||
#elif PIN_EXISTS(BEEPER)
|
||||
buzzer.tone(duration, freq);
|
||||
#else
|
||||
UNUSED(duration); UNUSED(freq);
|
||||
#endif
|
||||
}
|
||||
|
||||
// LCD implementations
|
||||
static void clear_lcd();
|
||||
static void init_lcd();
|
||||
|
||||
#if HAS_SPI_LCD || ENABLED(MALYAN_LCD) || ENABLED(EXTENSIBLE_UI)
|
||||
static void init();
|
||||
static void update();
|
||||
static bool detected();
|
||||
static void setalertstatusPGM(PGM_P message);
|
||||
#else // NO LCD
|
||||
static inline void init() {}
|
||||
static inline void update() {}
|
||||
static constexpr bool detected() { return true; }
|
||||
static inline void setalertstatusPGM(PGM_P message) { UNUSED(message); }
|
||||
#endif
|
||||
|
||||
#endif
|
||||
#if HAS_SPI_LCD || ENABLED(EXTENSIBLE_UI)
|
||||
|
||||
#if HAS_SPI_LCD
|
||||
|
||||
static LCDViewAction lcdDrawUpdate;
|
||||
static inline bool should_draw() { return bool(lcdDrawUpdate); }
|
||||
static inline void refresh(const LCDViewAction type) { lcdDrawUpdate = type; }
|
||||
static inline void refresh() { refresh(LCDVIEW_CLEAR_CALL_REDRAW); }
|
||||
|
||||
#if ENABLED(SHOW_BOOTSCREEN)
|
||||
static void show_bootscreen();
|
||||
#endif
|
||||
|
||||
#if HAS_GRAPHICAL_LCD
|
||||
|
||||
static bool drawing_screen, first_page;
|
||||
|
||||
static void set_font(const MarlinFont font_nr);
|
||||
|
||||
#else
|
||||
|
||||
static constexpr bool drawing_screen = false, first_page = true;
|
||||
|
||||
enum HD44780CharSet : uint8_t { CHARSET_MENU, CHARSET_INFO, CHARSET_BOOT };
|
||||
|
||||
static void set_custom_characters(
|
||||
#if ENABLED(LCD_PROGRESS_BAR) || ENABLED(SHOW_BOOTSCREEN)
|
||||
const HD44780CharSet screen_charset=CHARSET_INFO
|
||||
#endif
|
||||
);
|
||||
|
||||
#if ENABLED(LCD_PROGRESS_BAR)
|
||||
static millis_t progress_bar_ms; // Start time for the current progress bar cycle
|
||||
#if PROGRESS_MSG_EXPIRE > 0
|
||||
static millis_t MarlinUI::expire_status_ms; // = 0
|
||||
static inline void reset_progress_bar_timeout() { expire_status_ms = 0; }
|
||||
#endif
|
||||
#define LCD_SET_CHARSET(C) set_custom_characters(C)
|
||||
#else
|
||||
#define LCD_SET_CHARSET(C) set_custom_characters()
|
||||
#endif
|
||||
|
||||
#endif
|
||||
|
||||
// Status message
|
||||
static char status_message[];
|
||||
#if ENABLED(STATUS_MESSAGE_SCROLLING)
|
||||
static uint8_t status_scroll_offset;
|
||||
#endif
|
||||
|
||||
static uint8_t lcd_status_update_delay;
|
||||
static uint8_t status_message_level; // Higher levels block lower levels
|
||||
static inline void reset_alert_level() { status_message_level = 0; }
|
||||
|
||||
#if HAS_PRINT_PROGRESS
|
||||
#if ENABLED(LCD_SET_PROGRESS_MANUALLY)
|
||||
static uint8_t progress_bar_percent;
|
||||
static void set_progress(const uint8_t progress) { progress_bar_percent = MIN(progress, 100); }
|
||||
#endif
|
||||
static uint8_t get_progress();
|
||||
#else
|
||||
static constexpr uint8_t get_progress() { return 0; }
|
||||
#endif
|
||||
|
||||
#if HAS_LCD_CONTRAST
|
||||
static int16_t contrast;
|
||||
static void set_contrast(const int16_t value);
|
||||
static inline void refresh_contrast() { set_contrast(contrast); }
|
||||
#endif
|
||||
|
||||
#if ENABLED(FILAMENT_LCD_DISPLAY) && ENABLED(SDSUPPORT)
|
||||
static millis_t next_filament_display;
|
||||
#endif
|
||||
|
||||
static void quick_feedback(const bool clear_buttons=true);
|
||||
static void completion_feedback(const bool good=true);
|
||||
|
||||
#if DISABLED(LIGHTWEIGHT_UI)
|
||||
static void draw_status_message(const bool blink);
|
||||
#endif
|
||||
|
||||
#if ENABLED(ADVANCED_PAUSE_FEATURE)
|
||||
static void draw_hotend_status(const uint8_t row, const uint8_t extruder);
|
||||
#endif
|
||||
|
||||
static void status_screen();
|
||||
|
||||
#else
|
||||
|
||||
static void refresh();
|
||||
static void reset_alert_level();
|
||||
|
||||
#endif
|
||||
|
||||
static bool get_blink();
|
||||
static void kill_screen(PGM_P const lcd_msg);
|
||||
static void draw_kill_screen();
|
||||
static bool hasstatus();
|
||||
static void setstatus(const char* const message, const bool persist=false);
|
||||
static void setstatusPGM(PGM_P const message, const int8_t level=0);
|
||||
static void status_printf_P(const uint8_t level, PGM_P const fmt, ...);
|
||||
static void reset_status();
|
||||
|
||||
#else // MALYAN_LCD or NO LCD
|
||||
|
||||
static inline void refresh() {}
|
||||
static constexpr bool hasstatus() { return false; }
|
||||
static inline void setstatus(const char* const message, const bool persist=false) { UNUSED(message); UNUSED(persist); }
|
||||
static inline void setstatusPGM(PGM_P const message, const int8_t level=0) { UNUSED(message); UNUSED(level); }
|
||||
static inline void status_printf_P(const uint8_t level, PGM_P const fmt, ...) { UNUSED(level); UNUSED(fmt); }
|
||||
static inline void reset_status() {}
|
||||
static inline void reset_alert_level() {}
|
||||
|
||||
#endif
|
||||
|
||||
#if HAS_LCD_MENU
|
||||
|
||||
#if ENABLED(ENCODER_RATE_MULTIPLIER)
|
||||
static bool encoderRateMultiplierEnabled;
|
||||
static millis_t lastEncoderMovementMillis;
|
||||
static void enable_encoder_multiplier(const bool onoff);
|
||||
#endif
|
||||
|
||||
#if ENABLED(SCROLL_LONG_FILENAMES)
|
||||
static uint8_t filename_scroll_pos, filename_scroll_max;
|
||||
#endif
|
||||
|
||||
#if IS_KINEMATIC
|
||||
static bool processing_manual_move;
|
||||
#else
|
||||
static constexpr bool processing_manual_move = false;
|
||||
#endif
|
||||
|
||||
#if E_MANUAL > 1
|
||||
static int8_t manual_move_e_index;
|
||||
#else
|
||||
static constexpr int8_t manual_move_e_index = 0;
|
||||
#endif
|
||||
|
||||
static int16_t preheat_hotend_temp[2], preheat_bed_temp[2];
|
||||
static uint8_t preheat_fan_speed[2];
|
||||
|
||||
static void manage_manual_move();
|
||||
|
||||
static bool lcd_clicked;
|
||||
static bool use_click();
|
||||
|
||||
static void synchronize(PGM_P const msg=NULL);
|
||||
|
||||
static screenFunc_t currentScreen;
|
||||
static void goto_screen(const screenFunc_t screen, const uint32_t encoder=0);
|
||||
static void save_previous_screen();
|
||||
static void goto_previous_screen();
|
||||
static void return_to_status();
|
||||
static inline bool on_status_screen() { return currentScreen == status_screen; }
|
||||
static inline void run_current_screen() { (*currentScreen)(); }
|
||||
|
||||
static inline void defer_status_screen(const bool defer) {
|
||||
#if LCD_TIMEOUT_TO_STATUS
|
||||
defer_return_to_status = defer;
|
||||
#else
|
||||
UNUSED(defer);
|
||||
#endif
|
||||
}
|
||||
|
||||
static inline void goto_previous_screen_no_defer() {
|
||||
defer_status_screen(false);
|
||||
goto_previous_screen();
|
||||
}
|
||||
|
||||
#if ENABLED(SD_REPRINT_LAST_SELECTED_FILE)
|
||||
static void reselect_last_file();
|
||||
#endif
|
||||
|
||||
#if ENABLED(G26_MESH_VALIDATION)
|
||||
static inline void chirp() { buzz(LCD_FEEDBACK_FREQUENCY_DURATION_MS, LCD_FEEDBACK_FREQUENCY_HZ); }
|
||||
#endif
|
||||
|
||||
#if ENABLED(AUTO_BED_LEVELING_UBL)
|
||||
static void ubl_plot(const uint8_t x, const uint8_t inverted_y);
|
||||
#endif
|
||||
|
||||
#elif HAS_SPI_LCD
|
||||
|
||||
static constexpr bool lcd_clicked = false;
|
||||
static constexpr bool on_status_screen() { return true; }
|
||||
static inline void run_current_screen() { status_screen(); }
|
||||
|
||||
#endif
|
||||
|
||||
#if ENABLED(LCD_BED_LEVELING) && (ENABLED(PROBE_MANUALLY) || ENABLED(MESH_BED_LEVELING))
|
||||
static bool wait_for_bl_move;
|
||||
#else
|
||||
static constexpr bool wait_for_bl_move = false;
|
||||
#endif
|
||||
|
||||
#if HAS_LCD_MENU && (ENABLED(AUTO_BED_LEVELING_UBL) || ENABLED(G26_MESH_VALIDATION))
|
||||
static bool external_control;
|
||||
FORCE_INLINE static void capture() { external_control = true; }
|
||||
FORCE_INLINE static void release() { external_control = false; }
|
||||
#else
|
||||
static constexpr bool external_control = false;
|
||||
#endif
|
||||
|
||||
#if HAS_ENCODER_ACTION
|
||||
|
||||
static volatile uint8_t buttons;
|
||||
#if ENABLED(LCD_HAS_SLOW_BUTTONS)
|
||||
static volatile uint8_t slow_buttons;
|
||||
static uint8_t read_slow_buttons();
|
||||
#endif
|
||||
static void update_buttons();
|
||||
static inline bool button_pressed() { return BUTTON_CLICK(); }
|
||||
#if ENABLED(AUTO_BED_LEVELING_UBL) || ENABLED(G26_MESH_VALIDATION)
|
||||
static void wait_for_release();
|
||||
#endif
|
||||
|
||||
static uint32_t encoderPosition;
|
||||
|
||||
#if ENABLED(REVERSE_ENCODER_DIRECTION)
|
||||
#define ENCODERBASE -1
|
||||
#else
|
||||
#define ENCODERBASE +1
|
||||
#endif
|
||||
#if ENABLED(REVERSE_MENU_DIRECTION)
|
||||
static int8_t encoderDirection;
|
||||
static inline void encoder_direction_normal() { encoderDirection = +(ENCODERBASE); }
|
||||
static inline void encoder_direction_menus() { encoderDirection = -(ENCODERBASE); }
|
||||
#else
|
||||
static constexpr int8_t encoderDirection = ENCODERBASE;
|
||||
static inline void encoder_direction_normal() { }
|
||||
static inline void encoder_direction_menus() { }
|
||||
#endif
|
||||
|
||||
#else
|
||||
|
||||
static inline void update_buttons() { }
|
||||
|
||||
#endif
|
||||
|
||||
private:
|
||||
|
||||
static void _synchronize();
|
||||
|
||||
#if HAS_SPI_LCD
|
||||
#if HAS_LCD_MENU
|
||||
#if LCD_TIMEOUT_TO_STATUS
|
||||
static bool defer_return_to_status;
|
||||
#else
|
||||
static constexpr bool defer_return_to_status = false;
|
||||
#endif
|
||||
#endif
|
||||
static void draw_status_screen();
|
||||
static void finishstatus(const bool persist);
|
||||
#endif
|
||||
};
|
||||
|
||||
extern MarlinUI ui;
|
||||
|
||||
Reference in New Issue
Block a user