ultralcd.h 7.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260
  1. #ifndef ULTRALCD_H
  2. #define ULTRALCD_H
  3. #include "Marlin.h"
  4. #include "lcd.h"
  5. #include "conv2str.h"
  6. #include "menu.h"
  7. #include "mesh_bed_calibration.h"
  8. #include "config.h"
  9. #include "config.h"
  10. extern void menu_lcd_longpress_func(void);
  11. extern void menu_lcd_charsetup_func(void);
  12. extern void menu_lcd_lcdupdate_func(void);
  13. // Call with a false parameter to suppress the LCD update from various places like the planner or the temp control.
  14. void ultralcd_init();
  15. void lcd_setstatus(const char* message);
  16. void lcd_setstatuspgm(const char* message);
  17. //! return to the main status screen and display the alert message
  18. //! Beware - it has sideeffects:
  19. //! - always returns the display to the main status screen
  20. //! - always makes lcd_reset (which is slow and causes flicker)
  21. //! - does not update the message if there is already one (i.e. lcd_status_message_level > 0)
  22. void lcd_setalertstatuspgm(const char* message);
  23. //! only update the alert message on the main status screen
  24. //! has no sideeffects, may be called multiple times
  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 EEPROM_save_B(int pos, int* value);
  33. void EEPROM_read_B(int pos, int* value);
  34. void lcd_wait_interact();
  35. void lcd_loading_filament();
  36. void lcd_change_success();
  37. void lcd_loading_color();
  38. void lcd_sdcard_stop();
  39. void lcd_pause_print();
  40. void lcd_resume_print();
  41. void lcd_print_stop();
  42. void prusa_statistics(int _message, uint8_t _col_nr = 0);
  43. void lcd_confirm_print();
  44. unsigned char lcd_choose_color();
  45. void lcd_load_filament_color_check();
  46. //void lcd_mylang();
  47. extern void lcd_belttest();
  48. extern bool lcd_selftest();
  49. void lcd_menu_statistics();
  50. void lcd_menu_extruder_info(); // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
  51. void lcd_menu_show_sensors_state(); // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
  52. #ifdef TMC2130
  53. bool lcd_crash_detect_enabled();
  54. void lcd_crash_detect_enable();
  55. void lcd_crash_detect_disable();
  56. #endif
  57. extern const char* lcd_display_message_fullscreen_P(const char *msg, uint8_t &nlines);
  58. extern const char* lcd_display_message_fullscreen_P(const char *msg);
  59. extern void lcd_return_to_status();
  60. extern void lcd_wait_for_click();
  61. extern bool lcd_wait_for_click_delay(uint16_t nDelay);
  62. extern void lcd_show_fullscreen_message_and_wait_P(const char *msg);
  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. };
  102. extern CustomMsg custom_message_type;
  103. extern unsigned int custom_message_state;
  104. extern uint8_t farm_mode;
  105. extern int farm_no;
  106. extern int farm_timer;
  107. extern uint8_t farm_status;
  108. #ifdef TMC2130
  109. #define SILENT_MODE_NORMAL 0
  110. #define SILENT_MODE_STEALTH 1
  111. #define SILENT_MODE_OFF SILENT_MODE_NORMAL
  112. #else
  113. #define SILENT_MODE_POWER 0
  114. #define SILENT_MODE_SILENT 1
  115. #define SILENT_MODE_AUTO 2
  116. #define SILENT_MODE_OFF SILENT_MODE_POWER
  117. #endif
  118. extern int8_t SilentModeMenu;
  119. extern uint8_t SilentModeMenu_MMU;
  120. extern bool cancel_heatup;
  121. extern bool isPrintPaused;
  122. extern uint8_t scrollstuff;
  123. void lcd_ignore_click(bool b=true);
  124. void lcd_commands();
  125. extern bool bSettings; // flag (i.e. 'fake parameter') for 'lcd_hw_setup_menu()' function
  126. void lcd_hw_setup_menu(void); // NOT static due to using inside "util" module ("nozzle_diameter_check()")
  127. void change_extr(int extr);
  128. #ifdef SNMM
  129. void extr_unload_all();
  130. void extr_unload_used();
  131. #endif //SNMM
  132. void extr_unload();
  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();
  154. void stack_error();
  155. void lcd_printer_connected();
  156. void lcd_ping();
  157. void lcd_calibrate_extruder();
  158. void lcd_farm_sdcard_menu();
  159. //void getFileDescription(char *name, char *description);
  160. void lcd_farm_sdcard_menu_w();
  161. //void get_description();
  162. void lcd_wait_for_heater();
  163. void lcd_wait_for_cool_down();
  164. void lcd_extr_cal_reset();
  165. void lcd_temp_cal_show_result(bool result);
  166. #ifdef PINDA_THERMISTOR
  167. bool lcd_wait_for_pinda(float temp);
  168. #endif //PINDA_THERMISTOR
  169. void bowden_menu();
  170. char reset_menu();
  171. uint8_t choose_menu_P(const char *header, const char *item, const char *last_item = nullptr);
  172. void lcd_pinda_calibration_menu();
  173. void lcd_calibrate_pinda();
  174. void lcd_temp_calibration_set();
  175. void display_loading();
  176. void lcd_set_degree();
  177. #if (LANG_MODE != 0)
  178. void lcd_language();
  179. #endif
  180. void lcd_wizard();
  181. bool lcd_autoDepleteEnabled();
  182. //! @brief Wizard state
  183. enum class WizState : uint8_t
  184. {
  185. Run, //!< run wizard? Main entry point.
  186. Restore, //!< restore calibration status
  187. Selftest, //!< self test
  188. Xyz, //!< xyz calibration
  189. Z, //!< z calibration
  190. IsFil, //!< Is filament loaded? First step of 1st layer calibration
  191. PreheatPla, //!< waiting for preheat nozzle for PLA
  192. Preheat, //!< Preheat for any material
  193. LoadFilCold, //!< Load filament for MMU
  194. LoadFilHot, //!< Load filament without MMU
  195. IsPla, //!< Is PLA filament?
  196. Lay1CalCold, //!< First layer calibration, temperature not selected yet
  197. Lay1CalHot, //!< First layer calibration, temperature already selected
  198. RepeatLay1Cal, //!< Repeat first layer calibration?
  199. Finish, //!< Deactivate wizard
  200. };
  201. void lcd_wizard(WizState state);
  202. #define VOLT_DIV_REF 5
  203. #if IR_SENSOR_ANALOG
  204. #define IRsensor_Hmin_TRESHOLD (3.0*1023*OVERSAMPLENR/VOLT_DIV_REF) // ~3.0V (0.6*Vcc)
  205. #define IRsensor_Lmax_TRESHOLD (1.5*1023*OVERSAMPLENR/VOLT_DIV_REF) // ~1.5V (0.3*Vcc)
  206. #define IRsensor_Hopen_TRESHOLD (4.6*1023*OVERSAMPLENR/VOLT_DIV_REF) // ~4.6V (N.C. @ Ru~20-50k, Rd'=56k, Ru'=10k)
  207. #define IRsensor_Ldiode_TRESHOLD (0.3*1023*OVERSAMPLENR/VOLT_DIV_REF) // ~0.3V
  208. #endif //IR_SENSOR_ANALOG
  209. #endif //ULTRALCD_H