My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ultralcd.h 21KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2020 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #pragma once
  23. #include "../inc/MarlinConfig.h"
  24. #if HAS_BUZZER
  25. #include "../libs/buzzer.h"
  26. #endif
  27. #if ENABLED(SDSUPPORT)
  28. #include "../sd/cardreader.h"
  29. #endif
  30. #if EITHER(HAS_LCD_MENU, ULTIPANEL_FEEDMULTIPLY)
  31. #define HAS_ENCODER_ACTION 1
  32. #endif
  33. #if (!HAS_ADC_BUTTONS && ENABLED(NEWPANEL)) || BUTTONS_EXIST(EN1, EN2)
  34. #define HAS_ENCODER_WHEEL 1
  35. #endif
  36. #if HAS_ENCODER_WHEEL || ANY_BUTTON(ENC, BACK, UP, DWN, LFT, RT)
  37. #define HAS_DIGITAL_BUTTONS 1
  38. #endif
  39. #if !HAS_ADC_BUTTONS && (ENABLED(REPRAPWORLD_KEYPAD) || (HAS_SPI_LCD && DISABLED(NEWPANEL)))
  40. #define HAS_SHIFT_ENCODER 1
  41. #endif
  42. // I2C buttons must be read in the main thread
  43. #if EITHER(LCD_I2C_VIKI, LCD_I2C_PANELOLU2)
  44. #define HAS_SLOW_BUTTONS 1
  45. #endif
  46. #if E_MANUAL > 1
  47. #define MULTI_MANUAL 1
  48. #endif
  49. #if HAS_SPI_LCD
  50. #include "../MarlinCore.h"
  51. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  52. #include "../feature/pause.h"
  53. #include "../module/motion.h" // for active_extruder
  54. #endif
  55. enum LCDViewAction : uint8_t {
  56. LCDVIEW_NONE,
  57. LCDVIEW_REDRAW_NOW,
  58. LCDVIEW_CALL_REDRAW_NEXT,
  59. LCDVIEW_CLEAR_CALL_REDRAW,
  60. LCDVIEW_CALL_NO_REDRAW
  61. };
  62. #if HAS_ADC_BUTTONS
  63. uint8_t get_ADC_keyValue();
  64. #endif
  65. #define LCD_UPDATE_INTERVAL TERN(TOUCH_BUTTONS, 50, 100)
  66. #if HAS_LCD_MENU
  67. #include "lcdprint.h"
  68. void _wrap_string(uint8_t &col, uint8_t &row, const char * const string, read_byte_cb_t cb_read_byte, const bool wordwrap=false);
  69. inline void wrap_string_P(uint8_t &col, uint8_t &row, PGM_P const pstr, const bool wordwrap=false) { _wrap_string(col, row, pstr, read_byte_rom, wordwrap); }
  70. inline void wrap_string(uint8_t &col, uint8_t &row, const char * const string, const bool wordwrap=false) { _wrap_string(col, row, string, read_byte_ram, wordwrap); }
  71. #if ENABLED(SDSUPPORT)
  72. #include "../sd/cardreader.h"
  73. #endif
  74. typedef void (*screenFunc_t)();
  75. typedef void (*menuAction_t)();
  76. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  77. void lcd_pause_show_message(const PauseMessage message,
  78. const PauseMode mode=PAUSE_MODE_SAME,
  79. const uint8_t extruder=active_extruder);
  80. #endif
  81. #if ENABLED(AUTO_BED_LEVELING_UBL)
  82. void lcd_mesh_edit_setup(const float &initial);
  83. float lcd_mesh_edit();
  84. #endif
  85. #endif // HAS_LCD_MENU
  86. #endif // HAS_SPI_LCD
  87. // REPRAPWORLD_KEYPAD (and ADC_KEYPAD)
  88. #if ENABLED(REPRAPWORLD_KEYPAD)
  89. #define BTN_OFFSET 0 // Bit offset into buttons for shift register values
  90. #define BLEN_KEYPAD_F3 0
  91. #define BLEN_KEYPAD_F2 1
  92. #define BLEN_KEYPAD_F1 2
  93. #define BLEN_KEYPAD_DOWN 3
  94. #define BLEN_KEYPAD_RIGHT 4
  95. #define BLEN_KEYPAD_MIDDLE 5
  96. #define BLEN_KEYPAD_UP 6
  97. #define BLEN_KEYPAD_LEFT 7
  98. #define EN_KEYPAD_F1 _BV(BTN_OFFSET + BLEN_KEYPAD_F1)
  99. #define EN_KEYPAD_F2 _BV(BTN_OFFSET + BLEN_KEYPAD_F2)
  100. #define EN_KEYPAD_F3 _BV(BTN_OFFSET + BLEN_KEYPAD_F3)
  101. #define EN_KEYPAD_DOWN _BV(BTN_OFFSET + BLEN_KEYPAD_DOWN)
  102. #define EN_KEYPAD_RIGHT _BV(BTN_OFFSET + BLEN_KEYPAD_RIGHT)
  103. #define EN_KEYPAD_MIDDLE _BV(BTN_OFFSET + BLEN_KEYPAD_MIDDLE)
  104. #define EN_KEYPAD_UP _BV(BTN_OFFSET + BLEN_KEYPAD_UP)
  105. #define EN_KEYPAD_LEFT _BV(BTN_OFFSET + BLEN_KEYPAD_LEFT)
  106. #define RRK(B) (keypad_buttons & (B))
  107. #ifdef EN_C
  108. #define BUTTON_CLICK() ((buttons & EN_C) || RRK(EN_KEYPAD_MIDDLE))
  109. #else
  110. #define BUTTON_CLICK() RRK(EN_KEYPAD_MIDDLE)
  111. #endif
  112. #endif
  113. #if HAS_DIGITAL_BUTTONS
  114. // Wheel spin pins where BA is 00, 10, 11, 01 (1 bit always changes)
  115. #define BLEN_A 0
  116. #define BLEN_B 1
  117. #define EN_A _BV(BLEN_A)
  118. #define EN_B _BV(BLEN_B)
  119. #define BUTTON_PRESSED(BN) !READ(BTN_## BN)
  120. #if BUTTON_EXISTS(ENC) || ENABLED(TOUCH_BUTTONS)
  121. #define BLEN_C 2
  122. #define EN_C _BV(BLEN_C)
  123. #endif
  124. #if ENABLED(LCD_I2C_VIKI)
  125. #include <LiquidTWI2.h>
  126. #define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
  127. // button and encoder bit positions within 'buttons'
  128. #define B_LE (BUTTON_LEFT << B_I2C_BTN_OFFSET) // The remaining normalized buttons are all read via I2C
  129. #define B_UP (BUTTON_UP << B_I2C_BTN_OFFSET)
  130. #define B_MI (BUTTON_SELECT << B_I2C_BTN_OFFSET)
  131. #define B_DW (BUTTON_DOWN << B_I2C_BTN_OFFSET)
  132. #define B_RI (BUTTON_RIGHT << B_I2C_BTN_OFFSET)
  133. #if BUTTON_EXISTS(ENC) // The pause/stop/restart button is connected to BTN_ENC when used
  134. #define B_ST (EN_C) // Map the pause/stop/resume button into its normalized functional name
  135. #define BUTTON_CLICK() (buttons & (B_MI|B_RI|B_ST)) // Pause/stop also acts as click until a proper pause/stop is implemented.
  136. #else
  137. #define BUTTON_CLICK() (buttons & (B_MI|B_RI))
  138. #endif
  139. // I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
  140. #elif ENABLED(LCD_I2C_PANELOLU2)
  141. #if !BUTTON_EXISTS(ENC) // Use I2C if not directly connected to a pin
  142. #define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
  143. #define B_MI (PANELOLU2_ENCODER_C << B_I2C_BTN_OFFSET) // requires LiquidTWI2 library v1.2.3 or later
  144. #define BUTTON_CLICK() (buttons & B_MI)
  145. #endif
  146. #endif
  147. #else
  148. #undef BUTTON_EXISTS
  149. #define BUTTON_EXISTS(...) false
  150. // Shift register bits correspond to buttons:
  151. #define BL_LE 7 // Left
  152. #define BL_UP 6 // Up
  153. #define BL_MI 5 // Middle
  154. #define BL_DW 4 // Down
  155. #define BL_RI 3 // Right
  156. #define BL_ST 2 // Red Button
  157. #define B_LE _BV(BL_LE)
  158. #define B_UP _BV(BL_UP)
  159. #define B_MI _BV(BL_MI)
  160. #define B_DW _BV(BL_DW)
  161. #define B_RI _BV(BL_RI)
  162. #define B_ST _BV(BL_ST)
  163. #ifndef BUTTON_CLICK
  164. #define BUTTON_CLICK() (buttons & (B_MI|B_ST))
  165. #endif
  166. #endif
  167. #if BUTTON_EXISTS(BACK) || ENABLED(TOUCH_BUTTONS)
  168. #define BLEN_D 3
  169. #define EN_D _BV(BLEN_D)
  170. #define LCD_BACK_CLICKED() (buttons & EN_D)
  171. #else
  172. #define LCD_BACK_CLICKED() false
  173. #endif
  174. #ifndef BUTTON_CLICK
  175. #ifdef EN_C
  176. #define BUTTON_CLICK() (buttons & EN_C)
  177. #else
  178. #define BUTTON_CLICK() false
  179. #endif
  180. #endif
  181. #if HAS_GRAPHICAL_LCD
  182. enum MarlinFont : uint8_t {
  183. FONT_STATUSMENU = 1,
  184. FONT_EDIT,
  185. FONT_MENU
  186. };
  187. #else
  188. enum HD44780CharSet : uint8_t {
  189. CHARSET_MENU,
  190. CHARSET_INFO,
  191. CHARSET_BOOT
  192. };
  193. #endif
  194. #if PREHEAT_COUNT
  195. typedef struct {
  196. TERN_(HAS_HOTEND, uint16_t hotend_temp);
  197. TERN_(HAS_HEATED_BED, uint16_t bed_temp );
  198. TERN_(HAS_FAN, uint16_t fan_speed );
  199. } preheat_t;
  200. #endif
  201. #if HAS_LCD_MENU
  202. // Manual Movement class
  203. class ManualMove {
  204. public:
  205. static millis_t start_time;
  206. static float menu_scale;
  207. TERN_(IS_KINEMATIC, static float offset);
  208. #if IS_KINEMATIC
  209. static bool processing;
  210. #else
  211. static bool constexpr processing = false;
  212. #endif
  213. #if MULTI_MANUAL
  214. static int8_t e_index;
  215. #else
  216. static int8_t constexpr e_index = 0;
  217. #endif
  218. static uint8_t axis;
  219. static void task();
  220. static void soon(AxisEnum axis
  221. #if MULTI_MANUAL
  222. , const int8_t eindex=-1
  223. #endif
  224. );
  225. };
  226. #endif
  227. ////////////////////////////////////////////
  228. //////////// MarlinUI Singleton ////////////
  229. ////////////////////////////////////////////
  230. class MarlinUI {
  231. public:
  232. MarlinUI() {
  233. TERN_(HAS_LCD_MENU, currentScreen = status_screen);
  234. }
  235. #if HAS_BUZZER
  236. static void buzz(const long duration, const uint16_t freq);
  237. #endif
  238. FORCE_INLINE static void chirp() {
  239. TERN_(HAS_CHIRP, buzz(LCD_FEEDBACK_FREQUENCY_DURATION_MS, LCD_FEEDBACK_FREQUENCY_HZ));
  240. }
  241. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  242. static void update_indicators();
  243. #endif
  244. // LCD implementations
  245. static void clear_lcd();
  246. #if ENABLED(SDSUPPORT)
  247. static void media_changed(const uint8_t old_stat, const uint8_t stat);
  248. #endif
  249. #if HAS_SPI_LCD
  250. static bool detected();
  251. static void init_lcd();
  252. FORCE_INLINE static void refresh() { refresh(LCDVIEW_CLEAR_CALL_REDRAW); }
  253. #else
  254. #if ENABLED(DWIN_CREALITY_LCD)
  255. static void refresh();
  256. #else
  257. static inline void refresh() {}
  258. #endif
  259. static inline bool detected() { return true; }
  260. static inline void init_lcd() {}
  261. #endif
  262. #if HAS_DISPLAY
  263. static void init();
  264. static void update();
  265. static void set_alert_status_P(PGM_P const message);
  266. static char status_message[];
  267. static bool has_status();
  268. static uint8_t alert_level; // Higher levels block lower levels
  269. static inline void reset_alert_level() { alert_level = 0; }
  270. #if ENABLED(STATUS_MESSAGE_SCROLLING)
  271. static uint8_t status_scroll_offset;
  272. static void advance_status_scroll();
  273. static char* status_and_len(uint8_t &len);
  274. #endif
  275. static void abort_print();
  276. static void pause_print();
  277. static void resume_print();
  278. #if HAS_PRINT_PROGRESS
  279. #if HAS_PRINT_PROGRESS_PERMYRIAD
  280. typedef uint16_t progress_t;
  281. #define PROGRESS_SCALE 100U
  282. #define PROGRESS_MASK 0x7FFF
  283. #else
  284. typedef uint8_t progress_t;
  285. #define PROGRESS_SCALE 1U
  286. #define PROGRESS_MASK 0x7F
  287. #endif
  288. #if ENABLED(LCD_SET_PROGRESS_MANUALLY)
  289. static progress_t progress_override;
  290. static void set_progress(const progress_t p) { progress_override = _MIN(p, 100U * (PROGRESS_SCALE)); }
  291. static void set_progress_done() { progress_override = (PROGRESS_MASK + 1U) + 100U * (PROGRESS_SCALE); }
  292. static void progress_reset() { if (progress_override & (PROGRESS_MASK + 1U)) set_progress(0); }
  293. #if BOTH(LCD_SET_PROGRESS_MANUALLY, USE_M73_REMAINING_TIME)
  294. static uint32_t remaining_time;
  295. FORCE_INLINE static void set_remaining_time(const uint32_t r) { remaining_time = r; }
  296. FORCE_INLINE static uint32_t get_remaining_time() { return remaining_time; }
  297. FORCE_INLINE static void reset_remaining_time() { set_remaining_time(0); }
  298. #endif
  299. #endif
  300. static progress_t _get_progress();
  301. #if HAS_PRINT_PROGRESS_PERMYRIAD
  302. FORCE_INLINE static uint16_t get_progress_permyriad() { return _get_progress(); }
  303. #endif
  304. static uint8_t get_progress_percent() { return uint8_t(_get_progress() / (PROGRESS_SCALE)); }
  305. #else
  306. static constexpr uint8_t get_progress_percent() { return 0; }
  307. #endif
  308. #if HAS_SPI_LCD
  309. static millis_t next_button_update_ms;
  310. static LCDViewAction lcdDrawUpdate;
  311. FORCE_INLINE static bool should_draw() { return bool(lcdDrawUpdate); }
  312. FORCE_INLINE static void refresh(const LCDViewAction type) { lcdDrawUpdate = type; }
  313. #if ENABLED(SHOW_CUSTOM_BOOTSCREEN)
  314. static void draw_custom_bootscreen(const uint8_t frame=0);
  315. static void show_custom_bootscreen();
  316. #endif
  317. #if ENABLED(SHOW_BOOTSCREEN)
  318. #ifndef BOOTSCREEN_TIMEOUT
  319. #define BOOTSCREEN_TIMEOUT 2500
  320. #endif
  321. static void draw_marlin_bootscreen(const bool line2=false);
  322. static void show_marlin_bootscreen();
  323. static void show_bootscreen();
  324. #endif
  325. #if HAS_GRAPHICAL_LCD
  326. static bool drawing_screen, first_page;
  327. static void set_font(const MarlinFont font_nr);
  328. #else
  329. static constexpr bool drawing_screen = false, first_page = true;
  330. static void set_custom_characters(const HD44780CharSet screen_charset=CHARSET_INFO);
  331. #if ENABLED(LCD_PROGRESS_BAR)
  332. static millis_t progress_bar_ms; // Start time for the current progress bar cycle
  333. static void draw_progress_bar(const uint8_t percent);
  334. #if PROGRESS_MSG_EXPIRE > 0
  335. static millis_t expire_status_ms; // = 0
  336. FORCE_INLINE static void reset_progress_bar_timeout() { expire_status_ms = 0; }
  337. #endif
  338. #endif
  339. #endif
  340. static uint8_t lcd_status_update_delay;
  341. #if HAS_LCD_CONTRAST
  342. static int16_t contrast;
  343. static void set_contrast(const int16_t value);
  344. FORCE_INLINE static void refresh_contrast() { set_contrast(contrast); }
  345. #endif
  346. #if BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
  347. static millis_t next_filament_display;
  348. #endif
  349. static void quick_feedback(const bool clear_buttons=true);
  350. #if HAS_BUZZER
  351. static void completion_feedback(const bool good=true);
  352. #else
  353. static inline void completion_feedback(const bool=true) {}
  354. #endif
  355. #if DISABLED(LIGHTWEIGHT_UI)
  356. static void draw_status_message(const bool blink);
  357. #endif
  358. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  359. static void draw_hotend_status(const uint8_t row, const uint8_t extruder);
  360. #endif
  361. #if ENABLED(TOUCH_BUTTONS)
  362. static bool on_edit_screen;
  363. static void screen_click(const uint8_t row, const uint8_t col, const uint8_t x, const uint8_t y);
  364. #endif
  365. static void status_screen();
  366. #endif
  367. static bool get_blink();
  368. static void kill_screen(PGM_P const lcd_error, PGM_P const lcd_component);
  369. static void draw_kill_screen();
  370. static void set_status(const char* const message, const bool persist=false);
  371. static void set_status_P(PGM_P const message, const int8_t level=0);
  372. static void status_printf_P(const uint8_t level, PGM_P const fmt, ...);
  373. static void reset_status(const bool no_welcome=false);
  374. #else // No LCD
  375. // Send status to host as a notification
  376. static void set_status(const char* message, const bool=false);
  377. static void set_status_P(PGM_P message, const int8_t=0);
  378. static void status_printf_P(const uint8_t, PGM_P message, ...);
  379. static inline void init() {}
  380. static inline void update() {}
  381. static inline void return_to_status() {}
  382. static inline void set_alert_status_P(PGM_P const) {}
  383. static inline void reset_status(const bool=false) {}
  384. static inline void reset_alert_level() {}
  385. static constexpr bool has_status() { return false; }
  386. #endif
  387. #if ENABLED(SDSUPPORT)
  388. #if BOTH(SCROLL_LONG_FILENAMES, HAS_LCD_MENU)
  389. #define MARLINUI_SCROLL_NAME 1
  390. #endif
  391. #if MARLINUI_SCROLL_NAME
  392. static uint8_t filename_scroll_pos, filename_scroll_max;
  393. #endif
  394. static const char * scrolled_filename(CardReader &theCard, const uint8_t maxlen, uint8_t hash, const bool doScroll);
  395. #endif
  396. #if PREHEAT_COUNT
  397. static preheat_t material_preset[PREHEAT_COUNT];
  398. static PGM_P get_preheat_label(const uint8_t m);
  399. #endif
  400. #if HAS_LCD_MENU
  401. #if ENABLED(TOUCH_BUTTONS)
  402. static uint8_t touch_buttons;
  403. static uint8_t repeat_delay;
  404. #endif
  405. #if ENABLED(ENCODER_RATE_MULTIPLIER)
  406. static bool encoderRateMultiplierEnabled;
  407. static millis_t lastEncoderMovementMillis;
  408. static void enable_encoder_multiplier(const bool onoff);
  409. #endif
  410. // Manual Movement
  411. static ManualMove manual_move;
  412. // Select Screen (modal NO/YES style dialog)
  413. static bool selection;
  414. static void set_selection(const bool sel) { selection = sel; }
  415. static bool update_selection();
  416. static bool lcd_clicked;
  417. static bool use_click();
  418. static void synchronize(PGM_P const msg=nullptr);
  419. static screenFunc_t currentScreen;
  420. static bool screen_changed;
  421. static void goto_screen(const screenFunc_t screen, const uint16_t encoder=0, const uint8_t top=0, const uint8_t items=0);
  422. static void save_previous_screen();
  423. // goto_previous_screen and go_back may also be used as menu item callbacks
  424. static void _goto_previous_screen(TERN_(TURBO_BACK_MENU_ITEM, const bool is_back));
  425. static inline void goto_previous_screen() { _goto_previous_screen(TERN_(TURBO_BACK_MENU_ITEM, false)); }
  426. static inline void go_back() { _goto_previous_screen(TERN_(TURBO_BACK_MENU_ITEM, true)); }
  427. static void return_to_status();
  428. static inline bool on_status_screen() { return currentScreen == status_screen; }
  429. FORCE_INLINE static void run_current_screen() { (*currentScreen)(); }
  430. #if ENABLED(LIGHTWEIGHT_UI)
  431. static void lcd_in_status(const bool inStatus);
  432. #endif
  433. FORCE_INLINE static void defer_status_screen(const bool defer=true) {
  434. #if LCD_TIMEOUT_TO_STATUS > 0
  435. defer_return_to_status = defer;
  436. #else
  437. UNUSED(defer);
  438. #endif
  439. }
  440. static inline void goto_previous_screen_no_defer() {
  441. defer_status_screen(false);
  442. goto_previous_screen();
  443. }
  444. #if ENABLED(SD_REPRINT_LAST_SELECTED_FILE)
  445. static void reselect_last_file();
  446. #endif
  447. #if ENABLED(AUTO_BED_LEVELING_UBL)
  448. static void ubl_plot(const uint8_t x_plot, const uint8_t y_plot);
  449. #endif
  450. static void draw_select_screen_prompt(PGM_P const pref, const char * const string=nullptr, PGM_P const suff=nullptr);
  451. #elif HAS_SPI_LCD
  452. static constexpr bool lcd_clicked = false;
  453. static constexpr bool on_status_screen() { return true; }
  454. FORCE_INLINE static void run_current_screen() { status_screen(); }
  455. #endif
  456. //
  457. // EEPROM: Reset / Init / Load / Store
  458. //
  459. #if HAS_LCD_MENU
  460. static void reset_settings();
  461. #endif
  462. #if ENABLED(EEPROM_SETTINGS)
  463. #if HAS_LCD_MENU
  464. static void init_eeprom();
  465. static void load_settings();
  466. static void store_settings();
  467. #endif
  468. #if DISABLED(EEPROM_AUTO_INIT)
  469. static void eeprom_alert(const uint8_t msgid);
  470. static inline void eeprom_alert_crc() { eeprom_alert(0); }
  471. static inline void eeprom_alert_index() { eeprom_alert(1); }
  472. static inline void eeprom_alert_version() { eeprom_alert(2); }
  473. #endif
  474. #endif
  475. //
  476. // Special handling if a move is underway
  477. //
  478. #if EITHER(DELTA_CALIBRATION_MENU, DELTA_AUTO_CALIBRATION) || (ENABLED(LCD_BED_LEVELING) && EITHER(PROBE_MANUALLY, MESH_BED_LEVELING))
  479. #define LCD_HAS_WAIT_FOR_MOVE 1
  480. static bool wait_for_move;
  481. #else
  482. static constexpr bool wait_for_move = false;
  483. #endif
  484. //
  485. // Block interaction while under external control
  486. //
  487. #if HAS_LCD_MENU && EITHER(AUTO_BED_LEVELING_UBL, G26_MESH_VALIDATION)
  488. static bool external_control;
  489. FORCE_INLINE static void capture() { external_control = true; }
  490. FORCE_INLINE static void release() { external_control = false; }
  491. #if ENABLED(AUTO_BED_LEVELING_UBL)
  492. static void external_encoder();
  493. #endif
  494. #else
  495. static constexpr bool external_control = false;
  496. #endif
  497. #if HAS_ENCODER_ACTION
  498. static volatile uint8_t buttons;
  499. #if ENABLED(REPRAPWORLD_KEYPAD)
  500. static volatile uint8_t keypad_buttons;
  501. static bool handle_keypad();
  502. #endif
  503. #if HAS_SLOW_BUTTONS
  504. static volatile uint8_t slow_buttons;
  505. static uint8_t read_slow_buttons();
  506. #endif
  507. static void update_buttons();
  508. static inline bool button_pressed() { return BUTTON_CLICK(); }
  509. #if EITHER(AUTO_BED_LEVELING_UBL, G26_MESH_VALIDATION)
  510. static void wait_for_release();
  511. #endif
  512. static uint32_t encoderPosition;
  513. #define ENCODERBASE (TERN(REVERSE_ENCODER_DIRECTION, -1, +1))
  514. #if EITHER(REVERSE_MENU_DIRECTION, REVERSE_SELECT_DIRECTION)
  515. static int8_t encoderDirection;
  516. #else
  517. static constexpr int8_t encoderDirection = ENCODERBASE;
  518. #endif
  519. FORCE_INLINE static void encoder_direction_normal() {
  520. #if EITHER(REVERSE_MENU_DIRECTION, REVERSE_SELECT_DIRECTION)
  521. encoderDirection = ENCODERBASE;
  522. #endif
  523. }
  524. FORCE_INLINE static void encoder_direction_menus() {
  525. TERN_(REVERSE_MENU_DIRECTION, encoderDirection = -(ENCODERBASE));
  526. }
  527. FORCE_INLINE static void encoder_direction_select() {
  528. TERN_(REVERSE_SELECT_DIRECTION, encoderDirection = -(ENCODERBASE));
  529. }
  530. #else
  531. static inline void update_buttons() {}
  532. #endif
  533. private:
  534. #if HAS_DISPLAY
  535. static void finish_status(const bool persist);
  536. #endif
  537. #if HAS_SPI_LCD
  538. #if HAS_LCD_MENU && LCD_TIMEOUT_TO_STATUS > 0
  539. static bool defer_return_to_status;
  540. #else
  541. static constexpr bool defer_return_to_status = false;
  542. #endif
  543. static void draw_status_screen();
  544. #endif
  545. };
  546. extern MarlinUI ui;
  547. #define LCD_MESSAGEPGM_P(x) ui.set_status_P(x)
  548. #define LCD_ALERTMESSAGEPGM_P(x) ui.set_alert_status_P(x)
  549. #define LCD_MESSAGEPGM(x) LCD_MESSAGEPGM_P(GET_TEXT(x))
  550. #define LCD_ALERTMESSAGEPGM(x) LCD_ALERTMESSAGEPGM_P(GET_TEXT(x))