ultralcd.h 7.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246
  1. #ifndef ULTRALCD_H
  2. #define ULTRALCD_H
  3. #include "mesh_bed_calibration.h"
  4. #include "config.h"
  5. extern void menu_lcd_longpress_func(void);
  6. extern void menu_lcd_lcdupdate_func(void);
  7. // Call with a false parameter to suppress the LCD update from various places like the planner or the temp control.
  8. void ultralcd_init();
  9. void lcd_setstatus(const char* message);
  10. void lcd_setstatuspgm(const char* message);
  11. //! LCD status severities
  12. #define LCD_STATUS_CRITICAL 2 //< Heater failure
  13. #define LCD_STATUS_ALERT 1 //< Other hardware issue
  14. #define LCD_STATUS_NONE 0 //< No alert message set
  15. //! return to the main status screen and display the alert message
  16. //! Beware - it has sideeffects:
  17. //! - always returns the display to the main status screen
  18. //! - always makes lcd_reset (which is slow and causes flicker)
  19. //! - does not update the message if there is one with the same (or higher) severity present
  20. void lcd_setalertstatus(const char* message, uint8_t severity = LCD_STATUS_ALERT);
  21. void lcd_setalertstatuspgm(const char* message, uint8_t severity = LCD_STATUS_ALERT);
  22. //! only update the alert message on the main status screen
  23. //! has no sideeffects, may be called multiple times
  24. void lcd_updatestatus(const char *message);
  25. void lcd_updatestatuspgm(const char *message);
  26. void lcd_reset_alert_level();
  27. uint8_t get_message_level();
  28. void lcd_adjust_z();
  29. void lcd_pick_babystep();
  30. void lcd_alright();
  31. void show_preheat_nozzle_warning();
  32. void lcd_wait_interact();
  33. void lcd_loading_filament();
  34. void lcd_change_success();
  35. void lcd_loading_color();
  36. void lcd_sdcard_stop();
  37. void lcd_pause_print();
  38. void lcd_pause_usb_print();
  39. void lcd_resume_print();
  40. void lcd_print_stop();
  41. void prusa_statistics(uint8_t _message, uint8_t _col_nr = 0);
  42. void lcd_load_filament_color_check();
  43. //void lcd_mylang();
  44. extern void lcd_belttest();
  45. extern bool lcd_selftest();
  46. void lcd_menu_statistics();
  47. void lcd_status_screen(); // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
  48. void lcd_menu_extruder_info(); // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
  49. void lcd_menu_show_sensors_state(); // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
  50. #ifdef TMC2130
  51. bool lcd_crash_detect_enabled();
  52. void lcd_crash_detect_enable();
  53. void lcd_crash_detect_disable();
  54. #endif
  55. extern const char* lcd_display_message_fullscreen_P(const char *msg, uint8_t &nlines);
  56. extern const char* lcd_display_message_fullscreen_P(const char *msg);
  57. extern void lcd_return_to_status();
  58. extern void lcd_wait_for_click();
  59. extern bool lcd_wait_for_click_delay(uint16_t nDelay);
  60. extern void lcd_show_fullscreen_message_and_wait_P(const char *msg);
  61. // 0: no, 1: yes, -1: timeouted
  62. extern int8_t lcd_show_yes_no_and_wait(bool allow_timeouting = true, bool default_yes = false);
  63. // 0: no, 1: yes, -1: timeouted
  64. extern int8_t lcd_show_fullscreen_message_yes_no_and_wait_P(const char *msg, bool allow_timeouting = true, bool default_yes = false);
  65. extern int8_t lcd_show_multiscreen_message_two_choices_and_wait_P(const char *msg, bool allow_timeouting, bool default_yes,
  66. const char *first_choice, const char *second_choice);
  67. extern int8_t lcd_show_multiscreen_message_yes_no_and_wait_P(const char *msg, bool allow_timeouting = true, bool default_yes = false);
  68. // Ask the user to move the Z axis up to the end stoppers and let
  69. // the user confirm that it has been done.
  70. #ifndef TMC2130
  71. extern bool lcd_calibrate_z_end_stop_manual(bool only_z);
  72. #endif
  73. // Show the result of the calibration process on the LCD screen.
  74. extern void lcd_bed_calibration_show_result(BedSkewOffsetDetectionResultType result, uint8_t point_too_far_mask);
  75. extern void lcd_diag_show_end_stops();
  76. #define LCD_MESSAGEPGM(x) lcd_setstatuspgm(PSTR(x))
  77. #define LCD_ALERTMESSAGEPGM(x) lcd_setalertstatuspgm(PSTR(x))
  78. #define LCD_MESSAGERPGM(x) lcd_setstatuspgm((x))
  79. #define LCD_ALERTMESSAGERPGM(x) lcd_setalertstatuspgm((x))
  80. // To be used in lcd_commands_type.
  81. enum class LcdCommands : uint_least8_t
  82. {
  83. Idle,
  84. LoadFilament,
  85. StopPrint,
  86. FarmModeConfirm,
  87. LongPause,
  88. PidExtruder,
  89. Layer1Cal,
  90. };
  91. extern LcdCommands lcd_commands_type;
  92. extern int8_t FSensorStateMenu;
  93. enum class CustomMsg : uint_least8_t
  94. {
  95. Status, //!< status message from lcd_status_message variable
  96. MeshBedLeveling, //!< Mesh bed leveling in progress
  97. FilamentLoading, //!< Loading filament in progress
  98. PidCal, //!< PID tuning in progress
  99. TempCal, //!< PINDA temperature calibration
  100. TempCompPreheat, //!< Temperature compensation preheat
  101. M0Wait, //!< M0/M1 Wait command working even from SD
  102. M117, //!< M117 Set the status line message on the LCD
  103. Resuming, //!< Resuming message
  104. };
  105. extern CustomMsg custom_message_type;
  106. extern uint8_t custom_message_state;
  107. extern uint8_t farm_mode;
  108. extern bool UserECoolEnabled();
  109. extern bool FarmOrUserECool();
  110. #ifdef TMC2130
  111. #define SILENT_MODE_NORMAL 0
  112. #define SILENT_MODE_STEALTH 1
  113. #define SILENT_MODE_OFF SILENT_MODE_NORMAL
  114. #else
  115. #define SILENT_MODE_POWER 0
  116. #define SILENT_MODE_SILENT 1
  117. #define SILENT_MODE_AUTO 2
  118. #define SILENT_MODE_OFF SILENT_MODE_POWER
  119. #endif
  120. #ifdef IR_SENSOR_ANALOG
  121. extern bool bMenuFSDetect;
  122. void printf_IRSensorAnalogBoardChange();
  123. #endif //IR_SENSOR_ANALOG
  124. extern int8_t SilentModeMenu;
  125. extern uint8_t SilentModeMenu_MMU;
  126. extern bool cancel_heatup;
  127. extern bool isPrintPaused;
  128. extern uint8_t scrollstuff;
  129. void lcd_ignore_click(bool b=true);
  130. void lcd_commands();
  131. extern bool bSettings; // flag (i.e. 'fake parameter') for 'lcd_hw_setup_menu()' function
  132. void lcd_hw_setup_menu(void); // NOT static due to using inside "util" module ("nozzle_diameter_check()")
  133. enum class FilamentAction : uint_least8_t
  134. {
  135. None, //!< 'none' state is used as flag for (filament) autoLoad (i.e. opposite for 'autoLoad' state)
  136. Load,
  137. AutoLoad,
  138. UnLoad,
  139. MmuLoad,
  140. MmuUnLoad,
  141. MmuEject,
  142. MmuCut,
  143. Preheat,
  144. Lay1Cal,
  145. };
  146. extern FilamentAction eFilamentAction;
  147. extern bool bFilamentFirstRun;
  148. extern bool bFilamentPreheatState;
  149. extern bool bFilamentAction;
  150. void mFilamentItem(uint16_t nTemp,uint16_t nTempBed);
  151. void mFilamentItemForce();
  152. void lcd_generic_preheat_menu();
  153. void unload_filament(bool automatic = false);
  154. void lcd_printer_connected();
  155. void lcd_ping();
  156. void lcd_wait_for_heater();
  157. void lcd_wait_for_cool_down();
  158. void lcd_move_e(); // NOT static due to usage in Marlin_main
  159. void lcd_temp_cal_show_result(bool result);
  160. #ifdef PINDA_THERMISTOR
  161. bool lcd_wait_for_pinda(float temp);
  162. #endif //PINDA_THERMISTOR
  163. char reset_menu();
  164. uint8_t choose_menu_P(const char *header, const char *item, const char *last_item = nullptr);
  165. void lcd_calibrate_pinda();
  166. void lcd_temp_calibration_set();
  167. #if (LANG_MODE != 0)
  168. void lcd_language();
  169. #endif
  170. void lcd_wizard();
  171. bool lcd_autoDepleteEnabled();
  172. //! @brief Wizard state
  173. enum class WizState : uint8_t
  174. {
  175. Run, //!< run wizard? Main entry point.
  176. Restore, //!< restore calibration status
  177. Selftest, //!< self test
  178. Xyz, //!< xyz calibration
  179. Z, //!< z calibration
  180. IsFil, //!< Is filament loaded? First step of 1st layer calibration
  181. PreheatPla, //!< waiting for preheat nozzle for PLA
  182. Preheat, //!< Preheat for any material
  183. LoadFilCold, //!< Load filament for MMU
  184. LoadFilHot, //!< Load filament without MMU
  185. IsPla, //!< Is PLA filament?
  186. Lay1CalCold, //!< First layer calibration, temperature not selected yet
  187. Lay1CalHot, //!< First layer calibration, temperature already selected
  188. RepeatLay1Cal, //!< Repeat first layer calibration?
  189. Finish, //!< Deactivate wizard
  190. };
  191. void lcd_wizard(WizState state);
  192. extern void lcd_experimental_toggle();
  193. extern void lcd_experimental_menu();
  194. #ifdef PINDA_TEMP_COMP
  195. extern void lcd_pinda_temp_compensation_toggle();
  196. #endif //PINDA_TEMP_COMP
  197. #endif //ULTRALCD_H