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.

marlinui.h 22KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726
  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 <https://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #pragma once
  23. #include "../inc/MarlinConfig.h"
  24. #include "../module/motion.h"
  25. #include "buttons.h"
  26. #if HAS_BUZZER
  27. #include "../libs/buzzer.h"
  28. #endif
  29. #if ENABLED(SDSUPPORT)
  30. #include "../sd/cardreader.h"
  31. #endif
  32. #if ENABLED(TOUCH_SCREEN_CALIBRATION)
  33. #include "tft_io/touch_calibration.h"
  34. #endif
  35. #if ANY(HAS_LCD_MENU, ULTIPANEL_FEEDMULTIPLY, SOFT_RESET_ON_KILL)
  36. #define HAS_ENCODER_ACTION 1
  37. #endif
  38. #if HAS_STATUS_MESSAGE
  39. #define START_OF_UTF8_CHAR(C) (((C) & 0xC0u) != 0x80U)
  40. #endif
  41. #if E_MANUAL > 1
  42. #define MULTI_E_MANUAL 1
  43. #endif
  44. #if HAS_DISPLAY
  45. #include "../module/printcounter.h"
  46. #endif
  47. #if ENABLED(ADVANCED_PAUSE_FEATURE) && ANY(HAS_LCD_MENU, EXTENSIBLE_UI, DWIN_CREALITY_LCD_JYERSUI)
  48. #include "../feature/pause.h"
  49. #include "../module/motion.h" // for active_extruder
  50. #endif
  51. #define START_OF_UTF8_CHAR(C) (((C) & 0xC0u) != 0x80U)
  52. #if HAS_WIRED_LCD
  53. enum LCDViewAction : uint8_t {
  54. LCDVIEW_NONE,
  55. LCDVIEW_REDRAW_NOW,
  56. LCDVIEW_CALL_REDRAW_NEXT,
  57. LCDVIEW_CLEAR_CALL_REDRAW,
  58. LCDVIEW_CALL_NO_REDRAW
  59. };
  60. #if HAS_ADC_BUTTONS
  61. uint8_t get_ADC_keyValue();
  62. #endif
  63. #if HAS_LCD_MENU
  64. #include "lcdprint.h"
  65. #if !HAS_GRAPHICAL_TFT
  66. void _wrap_string(uint8_t &col, uint8_t &row, const char * const string, read_byte_cb_t cb_read_byte, const bool wordwrap=false);
  67. 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); }
  68. 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); }
  69. #endif
  70. typedef void (*screenFunc_t)();
  71. typedef void (*menuAction_t)();
  72. #endif // HAS_LCD_MENU
  73. #endif // HAS_WIRED_LCD
  74. #if EITHER(HAS_WIRED_LCD, DWIN_CREALITY_LCD_JYERSUI)
  75. #define LCD_UPDATE_INTERVAL TERN(HAS_TOUCH_BUTTONS, 50, 100)
  76. #endif
  77. #if HAS_MARLINUI_U8GLIB
  78. enum MarlinFont : uint8_t {
  79. FONT_STATUSMENU = 1,
  80. FONT_EDIT,
  81. FONT_MENU
  82. };
  83. #else
  84. enum HD44780CharSet : uint8_t {
  85. CHARSET_MENU,
  86. CHARSET_INFO,
  87. CHARSET_BOOT
  88. };
  89. #endif
  90. #if PREHEAT_COUNT
  91. typedef struct {
  92. #if HAS_HOTEND
  93. celsius_t hotend_temp;
  94. #endif
  95. #if HAS_HEATED_BED
  96. celsius_t bed_temp;
  97. #endif
  98. #if HAS_FAN
  99. uint16_t fan_speed;
  100. #endif
  101. } preheat_t;
  102. #endif
  103. #if HAS_LCD_MENU
  104. // Manual Movement class
  105. class ManualMove {
  106. private:
  107. static AxisEnum axis;
  108. #if MULTI_E_MANUAL
  109. static int8_t e_index;
  110. #else
  111. static int8_t constexpr e_index = 0;
  112. #endif
  113. static millis_t start_time;
  114. #if IS_KINEMATIC
  115. static xyze_pos_t all_axes_destination;
  116. #endif
  117. public:
  118. static float menu_scale;
  119. #if IS_KINEMATIC
  120. static float offset;
  121. #endif
  122. template <typename T>
  123. void set_destination(const T& dest) {
  124. #if IS_KINEMATIC
  125. // Moves are segmented, so the entire move is not submitted at once.
  126. // Using a separate variable prevents corrupting the in-progress move.
  127. all_axes_destination = current_position;
  128. all_axes_destination.set(dest);
  129. #else
  130. // Moves are submitted as single line to the planner using buffer_line.
  131. current_position.set(dest);
  132. #endif
  133. }
  134. float axis_value(const AxisEnum axis) {
  135. return NATIVE_TO_LOGICAL(processing ? destination[axis] : SUM_TERN(IS_KINEMATIC, current_position[axis], offset), axis);
  136. }
  137. bool apply_diff(const AxisEnum axis, const_float_t diff, const_float_t min, const_float_t max) {
  138. #if IS_KINEMATIC
  139. float &valref = offset;
  140. const float rmin = min - current_position[axis], rmax = max - current_position[axis];
  141. #else
  142. float &valref = current_position[axis];
  143. const float rmin = min, rmax = max;
  144. #endif
  145. valref += diff;
  146. const float pre = valref;
  147. if (min != max) {
  148. if (diff < 0)
  149. NOLESS(valref, rmin);
  150. else
  151. NOMORE(valref, rmax);
  152. }
  153. return pre != valref;
  154. }
  155. #if IS_KINEMATIC
  156. static bool processing;
  157. #else
  158. static bool constexpr processing = false;
  159. #endif
  160. static void task();
  161. static void soon(const AxisEnum axis OPTARG(MULTI_E_MANUAL, const int8_t eindex=active_extruder));
  162. };
  163. #endif
  164. ////////////////////////////////////////////
  165. //////////// MarlinUI Singleton ////////////
  166. ////////////////////////////////////////////
  167. class MarlinUI {
  168. public:
  169. MarlinUI() {
  170. TERN_(HAS_LCD_MENU, currentScreen = status_screen);
  171. }
  172. #if HAS_MULTI_LANGUAGE
  173. static uint8_t language;
  174. static void set_language(const uint8_t lang);
  175. #endif
  176. #if HAS_MARLINUI_U8GLIB
  177. static void update_language_font();
  178. #endif
  179. #if ENABLED(SOUND_MENU_ITEM)
  180. static bool buzzer_enabled; // Initialized by settings.load()
  181. #else
  182. static constexpr bool buzzer_enabled = true;
  183. #endif
  184. #if HAS_BUZZER
  185. static void buzz(const long duration, const uint16_t freq);
  186. #endif
  187. FORCE_INLINE static void chirp() {
  188. TERN_(HAS_CHIRP, buzz(LCD_FEEDBACK_FREQUENCY_DURATION_MS, LCD_FEEDBACK_FREQUENCY_HZ));
  189. }
  190. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  191. static void update_indicators();
  192. #endif
  193. // LCD implementations
  194. static void clear_lcd();
  195. #if BOTH(HAS_LCD_MENU, TOUCH_SCREEN_CALIBRATION)
  196. static void check_touch_calibration() {
  197. if (touch_calibration.need_calibration()) currentScreen = touch_calibration_screen;
  198. }
  199. #endif
  200. #if ENABLED(SDSUPPORT)
  201. #define MEDIA_MENU_GATEWAY TERN(PASSWORD_ON_SD_PRINT_MENU, password.media_gatekeeper, menu_media)
  202. static void media_changed(const uint8_t old_stat, const uint8_t stat);
  203. #endif
  204. #if HAS_LCD_BRIGHTNESS
  205. #ifndef MIN_LCD_BRIGHTNESS
  206. #define MIN_LCD_BRIGHTNESS 1
  207. #endif
  208. #ifndef MAX_LCD_BRIGHTNESS
  209. #define MAX_LCD_BRIGHTNESS 255
  210. #endif
  211. #ifndef DEFAULT_LCD_BRIGHTNESS
  212. #define DEFAULT_LCD_BRIGHTNESS MAX_LCD_BRIGHTNESS
  213. #endif
  214. static uint8_t brightness;
  215. static bool backlight;
  216. static void set_brightness(const uint8_t value);
  217. FORCE_INLINE static void refresh_brightness() { set_brightness(brightness); }
  218. #endif
  219. #if ENABLED(DWIN_CREALITY_LCD)
  220. static void refresh();
  221. #else
  222. FORCE_INLINE static void refresh() {
  223. TERN_(HAS_WIRED_LCD, refresh(LCDVIEW_CLEAR_CALL_REDRAW));
  224. }
  225. #endif
  226. #if HAS_WIRED_LCD
  227. static bool detected();
  228. static void init_lcd();
  229. #else
  230. static inline bool detected() { return true; }
  231. static inline void init_lcd() {}
  232. #endif
  233. #if HAS_PRINT_PROGRESS
  234. #if HAS_PRINT_PROGRESS_PERMYRIAD
  235. typedef uint16_t progress_t;
  236. #define PROGRESS_SCALE 100U
  237. #define PROGRESS_MASK 0x7FFF
  238. #else
  239. typedef uint8_t progress_t;
  240. #define PROGRESS_SCALE 1U
  241. #define PROGRESS_MASK 0x7F
  242. #endif
  243. #if ENABLED(LCD_SET_PROGRESS_MANUALLY)
  244. static progress_t progress_override;
  245. static void set_progress(const progress_t p) { progress_override = _MIN(p, 100U * (PROGRESS_SCALE)); }
  246. static void set_progress_done() { progress_override = (PROGRESS_MASK + 1U) + 100U * (PROGRESS_SCALE); }
  247. static void progress_reset() { if (progress_override & (PROGRESS_MASK + 1U)) set_progress(0); }
  248. #if ENABLED(SHOW_REMAINING_TIME)
  249. static inline uint32_t _calculated_remaining_time() {
  250. const duration_t elapsed = print_job_timer.duration();
  251. const progress_t progress = _get_progress();
  252. return progress ? elapsed.value * (100 * (PROGRESS_SCALE) - progress) / progress : 0;
  253. }
  254. #if ENABLED(USE_M73_REMAINING_TIME)
  255. static uint32_t remaining_time;
  256. FORCE_INLINE static void set_remaining_time(const uint32_t r) { remaining_time = r; }
  257. FORCE_INLINE static uint32_t get_remaining_time() { return remaining_time ?: _calculated_remaining_time(); }
  258. FORCE_INLINE static void reset_remaining_time() { set_remaining_time(0); }
  259. #else
  260. FORCE_INLINE static uint32_t get_remaining_time() { return _calculated_remaining_time(); }
  261. #endif
  262. #endif
  263. #endif
  264. static progress_t _get_progress();
  265. #if HAS_PRINT_PROGRESS_PERMYRIAD
  266. FORCE_INLINE static uint16_t get_progress_permyriad() { return _get_progress(); }
  267. #endif
  268. static uint8_t get_progress_percent() { return uint8_t(_get_progress() / (PROGRESS_SCALE)); }
  269. #else
  270. static constexpr uint8_t get_progress_percent() { return 0; }
  271. #endif
  272. #if HAS_STATUS_MESSAGE
  273. #if HAS_WIRED_LCD
  274. #if ENABLED(STATUS_MESSAGE_SCROLLING)
  275. #define MAX_MESSAGE_LENGTH _MAX(LONG_FILENAME_LENGTH, MAX_LANG_CHARSIZE * 2 * (LCD_WIDTH))
  276. #else
  277. #define MAX_MESSAGE_LENGTH (MAX_LANG_CHARSIZE * (LCD_WIDTH))
  278. #endif
  279. #else
  280. #define MAX_MESSAGE_LENGTH 63
  281. #endif
  282. static char status_message[];
  283. static uint8_t alert_level; // Higher levels block lower levels
  284. #if ENABLED(STATUS_MESSAGE_SCROLLING)
  285. static uint8_t status_scroll_offset;
  286. static void advance_status_scroll();
  287. static char* status_and_len(uint8_t &len);
  288. #endif
  289. static bool has_status();
  290. static void reset_status(const bool no_welcome=false);
  291. static void set_status(const char * const message, const bool persist=false);
  292. static void set_status_P(PGM_P const message, const int8_t level=0);
  293. static void status_printf_P(const uint8_t level, PGM_P const fmt, ...);
  294. static void set_alert_status_P(PGM_P const message);
  295. static inline void reset_alert_level() { alert_level = 0; }
  296. #else
  297. static constexpr bool has_status() { return false; }
  298. static inline void reset_status(const bool=false) {}
  299. static void set_status(const char *message, const bool=false);
  300. static void set_status_P(PGM_P message, const int8_t=0);
  301. static void status_printf_P(const uint8_t, PGM_P message, ...);
  302. static inline void set_alert_status_P(PGM_P const) {}
  303. static inline void reset_alert_level() {}
  304. #endif
  305. #if HAS_DISPLAY
  306. static void init();
  307. static void update();
  308. static void abort_print();
  309. static void pause_print();
  310. static void resume_print();
  311. static void flow_fault();
  312. #if BOTH(PSU_CONTROL, PS_OFF_CONFIRM)
  313. static void poweroff();
  314. #endif
  315. #if EITHER(HAS_WIRED_LCD, DWIN_CREALITY_LCD_JYERSUI)
  316. static bool get_blink();
  317. #endif
  318. #if HAS_WIRED_LCD
  319. static millis_t next_button_update_ms;
  320. static LCDViewAction lcdDrawUpdate;
  321. FORCE_INLINE static bool should_draw() { return bool(lcdDrawUpdate); }
  322. FORCE_INLINE static void refresh(const LCDViewAction type) { lcdDrawUpdate = type; }
  323. #if ENABLED(SHOW_CUSTOM_BOOTSCREEN)
  324. static void draw_custom_bootscreen(const uint8_t frame=0);
  325. static void show_custom_bootscreen();
  326. #endif
  327. #if ENABLED(SHOW_BOOTSCREEN)
  328. #ifndef BOOTSCREEN_TIMEOUT
  329. #define BOOTSCREEN_TIMEOUT 2500
  330. #endif
  331. static void draw_marlin_bootscreen(const bool line2=false);
  332. static void show_marlin_bootscreen();
  333. static void show_bootscreen();
  334. static void bootscreen_completion(const millis_t sofar);
  335. #endif
  336. #if HAS_MARLINUI_U8GLIB
  337. static void set_font(const MarlinFont font_nr);
  338. #elif IS_DWIN_MARLINUI
  339. static void set_font(const uint8_t font_nr);
  340. #endif
  341. #if HAS_MARLINUI_HD44780
  342. static void set_custom_characters(const HD44780CharSet screen_charset=CHARSET_INFO);
  343. #endif
  344. #if ENABLED(LCD_PROGRESS_BAR) && !HAS_MARLINUI_U8GLIB
  345. static millis_t progress_bar_ms; // Start time for the current progress bar cycle
  346. static void draw_progress_bar(const uint8_t percent);
  347. #if PROGRESS_MSG_EXPIRE > 0
  348. static millis_t expire_status_ms; // = 0
  349. FORCE_INLINE static void reset_progress_bar_timeout() { expire_status_ms = 0; }
  350. #endif
  351. #endif
  352. static uint8_t lcd_status_update_delay;
  353. #if HAS_LCD_CONTRAST
  354. static int16_t contrast;
  355. static void set_contrast(const int16_t value);
  356. FORCE_INLINE static void refresh_contrast() { set_contrast(contrast); }
  357. #endif
  358. #if BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
  359. static millis_t next_filament_display;
  360. #endif
  361. static void quick_feedback(const bool clear_buttons=true);
  362. #if HAS_BUZZER
  363. static void completion_feedback(const bool good=true);
  364. #else
  365. static inline void completion_feedback(const bool=true) {}
  366. #endif
  367. #if DISABLED(LIGHTWEIGHT_UI)
  368. static void draw_status_message(const bool blink);
  369. #endif
  370. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  371. static void draw_hotend_status(const uint8_t row, const uint8_t extruder);
  372. #endif
  373. #if HAS_TOUCH_BUTTONS
  374. static bool on_edit_screen;
  375. static void screen_click(const uint8_t row, const uint8_t col, const uint8_t x, const uint8_t y);
  376. #endif
  377. static void status_screen();
  378. #endif
  379. #if HAS_MARLINUI_U8GLIB
  380. static bool drawing_screen, first_page;
  381. #else
  382. static constexpr bool drawing_screen = false, first_page = true;
  383. #endif
  384. #if IS_DWIN_MARLINUI
  385. static bool did_first_redraw;
  386. #endif
  387. static void kill_screen(PGM_P const lcd_error, PGM_P const lcd_component);
  388. static void draw_kill_screen();
  389. #else // No LCD
  390. static inline void init() {}
  391. static inline void update() {}
  392. static inline void return_to_status() {}
  393. #endif
  394. #if ENABLED(SDSUPPORT)
  395. #if BOTH(SCROLL_LONG_FILENAMES, HAS_LCD_MENU)
  396. #define MARLINUI_SCROLL_NAME 1
  397. #endif
  398. #if MARLINUI_SCROLL_NAME
  399. static uint8_t filename_scroll_pos, filename_scroll_max;
  400. #endif
  401. static const char * scrolled_filename(CardReader &theCard, const uint8_t maxlen, uint8_t hash, const bool doScroll);
  402. #endif
  403. #if PREHEAT_COUNT
  404. static preheat_t material_preset[PREHEAT_COUNT];
  405. static PGM_P get_preheat_label(const uint8_t m);
  406. #endif
  407. #if SCREENS_CAN_TIME_OUT
  408. static inline void reset_status_timeout(const millis_t ms) { return_to_status_ms = ms + LCD_TIMEOUT_TO_STATUS; }
  409. #else
  410. static inline void reset_status_timeout(const millis_t) {}
  411. #endif
  412. #if HAS_LCD_MENU
  413. #if HAS_TOUCH_BUTTONS
  414. static uint8_t touch_buttons;
  415. static uint8_t repeat_delay;
  416. #else
  417. static constexpr uint8_t touch_buttons = 0;
  418. #endif
  419. #if ENABLED(ENCODER_RATE_MULTIPLIER)
  420. static bool encoderRateMultiplierEnabled;
  421. static millis_t lastEncoderMovementMillis;
  422. static void enable_encoder_multiplier(const bool onoff);
  423. #define ENCODER_RATE_MULTIPLY(F) (ui.encoderRateMultiplierEnabled = F)
  424. #else
  425. #define ENCODER_RATE_MULTIPLY(F) NOOP
  426. #endif
  427. // Manual Movement
  428. static ManualMove manual_move;
  429. // Select Screen (modal NO/YES style dialog)
  430. static bool selection;
  431. static void set_selection(const bool sel) { selection = sel; }
  432. static bool update_selection();
  433. static void synchronize(PGM_P const msg=nullptr);
  434. static screenFunc_t currentScreen;
  435. static bool screen_changed;
  436. static void goto_screen(const screenFunc_t screen, const uint16_t encoder=0, const uint8_t top=0, const uint8_t items=0);
  437. static void push_current_screen();
  438. // goto_previous_screen and go_back may also be used as menu item callbacks
  439. static void _goto_previous_screen(TERN_(TURBO_BACK_MENU_ITEM, const bool is_back));
  440. static inline void goto_previous_screen() { _goto_previous_screen(TERN_(TURBO_BACK_MENU_ITEM, false)); }
  441. static inline void go_back() { _goto_previous_screen(TERN_(TURBO_BACK_MENU_ITEM, true)); }
  442. static void return_to_status();
  443. static inline bool on_status_screen() { return currentScreen == status_screen; }
  444. FORCE_INLINE static void run_current_screen() { (*currentScreen)(); }
  445. #if ENABLED(LIGHTWEIGHT_UI)
  446. static void lcd_in_status(const bool inStatus);
  447. #endif
  448. FORCE_INLINE static bool screen_is_sticky() {
  449. return TERN1(SCREENS_CAN_TIME_OUT, defer_return_to_status);
  450. }
  451. FORCE_INLINE static void defer_status_screen(const bool defer=true) {
  452. TERN(SCREENS_CAN_TIME_OUT, defer_return_to_status = defer, UNUSED(defer));
  453. }
  454. static inline void goto_previous_screen_no_defer() {
  455. defer_status_screen(false);
  456. goto_previous_screen();
  457. }
  458. #if ENABLED(SD_REPRINT_LAST_SELECTED_FILE)
  459. static void reselect_last_file();
  460. #endif
  461. #if ENABLED(AUTO_BED_LEVELING_UBL)
  462. static void ubl_plot(const uint8_t x_plot, const uint8_t y_plot);
  463. #endif
  464. #if ENABLED(AUTO_BED_LEVELING_UBL)
  465. static void ubl_mesh_edit_start(const_float_t initial);
  466. static float ubl_mesh_value();
  467. #endif
  468. static void draw_select_screen_prompt(PGM_P const pref, const char * const string=nullptr, PGM_P const suff=nullptr);
  469. #else
  470. static constexpr bool on_status_screen() { return true; }
  471. #if HAS_WIRED_LCD
  472. FORCE_INLINE static void run_current_screen() { status_screen(); }
  473. #endif
  474. #endif
  475. #if EITHER(HAS_LCD_MENU, EXTENSIBLE_UI)
  476. static bool lcd_clicked;
  477. static inline bool use_click() {
  478. const bool click = lcd_clicked;
  479. lcd_clicked = false;
  480. return click;
  481. }
  482. #else
  483. static constexpr bool lcd_clicked = false;
  484. static inline bool use_click() { return false; }
  485. #endif
  486. #if ENABLED(ADVANCED_PAUSE_FEATURE) && ANY(HAS_LCD_MENU, EXTENSIBLE_UI, DWIN_CREALITY_LCD_JYERSUI)
  487. static void pause_show_message(const PauseMessage message, const PauseMode mode=PAUSE_MODE_SAME, const uint8_t extruder=active_extruder);
  488. #else
  489. static inline void _pause_show_message() {}
  490. #define pause_show_message(...) _pause_show_message()
  491. #endif
  492. //
  493. // EEPROM: Reset / Init / Load / Store
  494. //
  495. #if HAS_LCD_MENU
  496. static void reset_settings();
  497. #endif
  498. #if ENABLED(EEPROM_SETTINGS)
  499. #if HAS_LCD_MENU
  500. static void init_eeprom();
  501. static void load_settings();
  502. static void store_settings();
  503. #endif
  504. #if DISABLED(EEPROM_AUTO_INIT)
  505. static void eeprom_alert(const uint8_t msgid);
  506. static inline void eeprom_alert_crc() { eeprom_alert(0); }
  507. static inline void eeprom_alert_index() { eeprom_alert(1); }
  508. static inline void eeprom_alert_version() { eeprom_alert(2); }
  509. #endif
  510. #endif
  511. //
  512. // Special handling if a move is underway
  513. //
  514. #if ANY(DELTA_CALIBRATION_MENU, DELTA_AUTO_CALIBRATION, PROBE_OFFSET_WIZARD) || (ENABLED(LCD_BED_LEVELING) && EITHER(PROBE_MANUALLY, MESH_BED_LEVELING))
  515. #define LCD_HAS_WAIT_FOR_MOVE 1
  516. static bool wait_for_move;
  517. #else
  518. static constexpr bool wait_for_move = false;
  519. #endif
  520. //
  521. // Block interaction while under external control
  522. //
  523. #if HAS_LCD_MENU && EITHER(AUTO_BED_LEVELING_UBL, G26_MESH_VALIDATION)
  524. static bool external_control;
  525. FORCE_INLINE static void capture() { external_control = true; }
  526. FORCE_INLINE static void release() { external_control = false; }
  527. #if ENABLED(AUTO_BED_LEVELING_UBL)
  528. static void external_encoder();
  529. #endif
  530. #else
  531. static constexpr bool external_control = false;
  532. #endif
  533. #if HAS_ENCODER_ACTION
  534. static volatile uint8_t buttons;
  535. #if IS_RRW_KEYPAD
  536. static volatile uint8_t keypad_buttons;
  537. static bool handle_keypad();
  538. #endif
  539. #if HAS_SLOW_BUTTONS
  540. static volatile uint8_t slow_buttons;
  541. static uint8_t read_slow_buttons();
  542. #endif
  543. static void update_buttons();
  544. static inline bool button_pressed() { return BUTTON_CLICK() || TERN(TOUCH_SCREEN, touch_pressed(), false); }
  545. #if EITHER(AUTO_BED_LEVELING_UBL, G26_MESH_VALIDATION)
  546. static void wait_for_release();
  547. #endif
  548. static uint32_t encoderPosition;
  549. #define ENCODERBASE (TERN(REVERSE_ENCODER_DIRECTION, -1, +1))
  550. #if EITHER(REVERSE_MENU_DIRECTION, REVERSE_SELECT_DIRECTION)
  551. static int8_t encoderDirection;
  552. #else
  553. static constexpr int8_t encoderDirection = ENCODERBASE;
  554. #endif
  555. FORCE_INLINE static void encoder_direction_normal() {
  556. #if EITHER(REVERSE_MENU_DIRECTION, REVERSE_SELECT_DIRECTION)
  557. encoderDirection = ENCODERBASE;
  558. #endif
  559. }
  560. FORCE_INLINE static void encoder_direction_menus() {
  561. TERN_(REVERSE_MENU_DIRECTION, encoderDirection = -(ENCODERBASE));
  562. }
  563. FORCE_INLINE static void encoder_direction_select() {
  564. TERN_(REVERSE_SELECT_DIRECTION, encoderDirection = -(ENCODERBASE));
  565. }
  566. #else
  567. static inline void update_buttons() {}
  568. #endif
  569. #if ENABLED(TOUCH_SCREEN_CALIBRATION)
  570. static void touch_calibration_screen();
  571. #endif
  572. #if HAS_GRAPHICAL_TFT
  573. static void move_axis_screen();
  574. #endif
  575. private:
  576. #if SCREENS_CAN_TIME_OUT
  577. static millis_t return_to_status_ms;
  578. static bool defer_return_to_status;
  579. #else
  580. static constexpr bool defer_return_to_status = false;
  581. #endif
  582. #if HAS_STATUS_MESSAGE
  583. static void finish_status(const bool persist);
  584. #endif
  585. #if HAS_WIRED_LCD
  586. static void draw_status_screen();
  587. #if HAS_GRAPHICAL_TFT
  588. static void tft_idle();
  589. #if ENABLED(TOUCH_SCREEN)
  590. static bool touch_pressed();
  591. #endif
  592. #endif
  593. #endif
  594. };
  595. extern MarlinUI ui;
  596. #define LCD_MESSAGEPGM_P(x) ui.set_status_P(x)
  597. #define LCD_ALERTMESSAGEPGM_P(x) ui.set_alert_status_P(x)
  598. #define LCD_MESSAGEPGM(x) LCD_MESSAGEPGM_P(GET_TEXT(x))
  599. #define LCD_ALERTMESSAGEPGM(x) LCD_ALERTMESSAGEPGM_P(GET_TEXT(x))