ultralcd.h 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  1. #ifndef ULTRALCD_H
  2. #define ULTRALCD_H
  3. #include "Marlin.h"
  4. #include "mesh_bed_calibration.h"
  5. #ifdef ULTRA_LCD
  6. void lcd_update(uint8_t lcdDrawUpdateOverride = 0);
  7. // Call with a false parameter to suppress the LCD update from various places like the planner or the temp control.
  8. void lcd_update_enable(bool enable);
  9. void lcd_init();
  10. void lcd_setstatus(const char* message);
  11. void lcd_setstatuspgm(const char* message);
  12. void lcd_setalertstatuspgm(const char* message);
  13. void lcd_reset_alert_level();
  14. void lcd_adjust_z();
  15. void lcd_pick_babystep();
  16. void lcd_alright();
  17. void EEPROM_save_B(int pos, int* value);
  18. void EEPROM_read_B(int pos, int* value);
  19. void lcd_wait_interact();
  20. void lcd_change_filament();
  21. void lcd_loading_filament();
  22. void lcd_change_success();
  23. void lcd_loading_color();
  24. void lcd_force_language_selection();
  25. void lcd_sdcard_stop();
  26. void prusa_statistics(int _message);
  27. void lcd_confirm_print();
  28. void lcd_mylang();
  29. bool lcd_detected(void);
  30. static void lcd_selftest();
  31. static bool lcd_selfcheck_endstops();
  32. static bool lcd_selfcheck_axis(int _axis, int _travel);
  33. static bool lcd_selfcheck_check_heater(bool _isbed);
  34. static int lcd_selftest_screen(int _step, int _progress, int _progress_scale, bool _clear, int _delay);
  35. static void lcd_selftest_screen_step(int _row, int _col, int _state, const char *_name, const char *_indicator);
  36. static void lcd_selftest_error(int _error_no, const char *_error_1, const char *_error_2);
  37. static void lcd_menu_statistics();
  38. extern const char* lcd_display_message_fullscreen_P(const char *msg, uint8_t &nlines);
  39. inline const char* lcd_display_message_fullscreen_P(const char *msg)
  40. { uint8_t nlines; return lcd_display_message_fullscreen_P(msg, nlines); }
  41. extern void lcd_wait_for_click();
  42. extern void lcd_show_fullscreen_message_and_wait_P(const char *msg);
  43. // 0: no, 1: yes, -1: timeouted
  44. extern int8_t lcd_show_fullscreen_message_yes_no_and_wait_P(const char *msg, bool allow_timeouting = true);
  45. // Ask the user to move the Z axis up to the end stoppers and let
  46. // the user confirm that it has been done.
  47. extern bool lcd_calibrate_z_end_stop_manual(bool only_z);
  48. // Show the result of the calibration process on the LCD screen.
  49. extern void lcd_bed_calibration_show_result(BedSkewOffsetDetectionResultType result, uint8_t point_too_far_mask);
  50. extern void lcd_diag_show_end_stops();
  51. #ifdef DOGLCD
  52. extern int lcd_contrast;
  53. void lcd_setcontrast(uint8_t value);
  54. #endif
  55. static unsigned char blink = 0; // Variable for visualization of fan rotation in GLCD
  56. #define LCD_MESSAGEPGM(x) lcd_setstatuspgm(PSTR(x))
  57. #define LCD_ALERTMESSAGEPGM(x) lcd_setalertstatuspgm(PSTR(x))
  58. #define LCD_MESSAGERPGM(x) lcd_setstatuspgm((x))
  59. #define LCD_ALERTMESSAGERPGM(x) lcd_setalertstatuspgm((x))
  60. #define LCD_UPDATE_INTERVAL 100
  61. #define LCD_TIMEOUT_TO_STATUS 15000
  62. #ifdef ULTIPANEL
  63. void lcd_buttons_update();
  64. extern volatile uint8_t buttons; //the last checked buttons in a bit array.
  65. #ifdef REPRAPWORLD_KEYPAD
  66. extern volatile uint8_t buttons_reprapworld_keypad; // to store the keypad shift register values
  67. #endif
  68. #else
  69. FORCE_INLINE void lcd_buttons_update() {}
  70. #endif
  71. // To be used in lcd_commands_type.
  72. #define LCD_COMMAND_IDLE 0
  73. #define LCD_COMMAND_LOAD_FILAMENT 1
  74. #define LCD_COMMAND_STOP_PRINT 2
  75. #define LCD_COMMAND_FARM_MODE_CONFIRM 4
  76. extern int lcd_commands_type;
  77. extern bool farm_mode;
  78. extern int farm_no;
  79. extern int farm_timer;
  80. extern int farm_status;
  81. extern bool cancel_heatup;
  82. #ifdef FILAMENT_LCD_DISPLAY
  83. extern unsigned long message_millis;
  84. #endif
  85. void lcd_buzz(long duration,uint16_t freq);
  86. bool lcd_clicked();
  87. void lcd_ignore_click(bool b=true);
  88. void lcd_commands();
  89. #ifdef NEWPANEL
  90. #define EN_C (1<<BLEN_C)
  91. #define EN_B (1<<BLEN_B)
  92. #define EN_A (1<<BLEN_A)
  93. #define LCD_CLICKED (buttons&EN_C)
  94. #ifdef REPRAPWORLD_KEYPAD
  95. #define EN_REPRAPWORLD_KEYPAD_F3 (1<<BLEN_REPRAPWORLD_KEYPAD_F3)
  96. #define EN_REPRAPWORLD_KEYPAD_F2 (1<<BLEN_REPRAPWORLD_KEYPAD_F2)
  97. #define EN_REPRAPWORLD_KEYPAD_F1 (1<<BLEN_REPRAPWORLD_KEYPAD_F1)
  98. #define EN_REPRAPWORLD_KEYPAD_UP (1<<BLEN_REPRAPWORLD_KEYPAD_UP)
  99. #define EN_REPRAPWORLD_KEYPAD_RIGHT (1<<BLEN_REPRAPWORLD_KEYPAD_RIGHT)
  100. #define EN_REPRAPWORLD_KEYPAD_MIDDLE (1<<BLEN_REPRAPWORLD_KEYPAD_MIDDLE)
  101. #define EN_REPRAPWORLD_KEYPAD_DOWN (1<<BLEN_REPRAPWORLD_KEYPAD_DOWN)
  102. #define EN_REPRAPWORLD_KEYPAD_LEFT (1<<BLEN_REPRAPWORLD_KEYPAD_LEFT)
  103. #define LCD_CLICKED ((buttons&EN_C) || (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_F1))
  104. #define REPRAPWORLD_KEYPAD_MOVE_Z_UP (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_F2)
  105. #define REPRAPWORLD_KEYPAD_MOVE_Z_DOWN (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_F3)
  106. #define REPRAPWORLD_KEYPAD_MOVE_X_LEFT (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_LEFT)
  107. #define REPRAPWORLD_KEYPAD_MOVE_X_RIGHT (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_RIGHT)
  108. #define REPRAPWORLD_KEYPAD_MOVE_Y_DOWN (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_DOWN)
  109. #define REPRAPWORLD_KEYPAD_MOVE_Y_UP (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_UP)
  110. #define REPRAPWORLD_KEYPAD_MOVE_HOME (buttons_reprapworld_keypad&EN_REPRAPWORLD_KEYPAD_MIDDLE)
  111. #endif //REPRAPWORLD_KEYPAD
  112. #else
  113. //atomic, do not change
  114. #define B_LE (1<<BL_LE)
  115. #define B_UP (1<<BL_UP)
  116. #define B_MI (1<<BL_MI)
  117. #define B_DW (1<<BL_DW)
  118. #define B_RI (1<<BL_RI)
  119. #define B_ST (1<<BL_ST)
  120. #define EN_B (1<<BLEN_B)
  121. #define EN_A (1<<BLEN_A)
  122. #define LCD_CLICKED ((buttons&B_MI)||(buttons&B_ST))
  123. #endif//NEWPANEL
  124. #else //no LCD
  125. FORCE_INLINE void
  126. {}
  127. FORCE_INLINE void lcd_init() {}
  128. FORCE_INLINE void lcd_setstatus(const char* message) {}
  129. FORCE_INLINE void lcd_buttons_update() {}
  130. FORCE_INLINE void lcd_reset_alert_level() {}
  131. FORCE_INLINE void lcd_buzz(long duration,uint16_t freq) {}
  132. FORCE_INLINE bool lcd_detected(void) { return true; }
  133. #define LCD_MESSAGEPGM(x)
  134. #define LCD_ALERTMESSAGEPGM(x)
  135. #endif //ULTRA_LCD
  136. char *itostr2(const uint8_t &x);
  137. char *itostr31(const int &xx);
  138. char *itostr3(const int &xx);
  139. char *itostr3left(const int &xx);
  140. char *itostr4(const int &xx);
  141. char *ftostr3(const float &x);
  142. char *ftostr31ns(const float &x); // float to string without sign character
  143. char *ftostr31(const float &x);
  144. char *ftostr32(const float &x);
  145. char *ftostr32ns(const float &x);
  146. char *ftostr43(const float &x);
  147. char *ftostr12ns(const float &x);
  148. char *ftostr13ns(const float &x);
  149. char *ftostr32sp(const float &x); // remove zero-padding from ftostr32
  150. char *ftostr5(const float &x);
  151. char *ftostr51(const float &x);
  152. char *ftostr52(const float &x);
  153. extern void lcd_implementation_clear();
  154. extern void lcd_printPGM(const char* str);
  155. extern void lcd_print_at_PGM(uint8_t x, uint8_t y, const char* str);
  156. extern void lcd_implementation_write(char c);
  157. extern void lcd_implementation_print(const char *str);
  158. extern void lcd_implementation_print(int8_t i);
  159. extern void lcd_implementation_print_at(uint8_t x, uint8_t y, int8_t i);
  160. extern void lcd_implementation_print(int i);
  161. extern void lcd_implementation_print_at(uint8_t x, uint8_t y, int i);
  162. extern void lcd_implementation_print(float f);
  163. extern void lcd_implementation_print_at(uint8_t x, uint8_t y, const char *str);
  164. #endif //ULTRALCD_H