lcd.h 6.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219
  1. //! @file
  2. #ifndef _LCD_H
  3. #define _LCD_H
  4. #include <inttypes.h>
  5. #include <stdio.h>
  6. #include "Timer.h"
  7. extern FILE _lcdout;
  8. #define lcdout (&_lcdout)
  9. extern void lcd_init(void);
  10. extern void lcd_refresh(void);
  11. extern void lcd_refresh_noclear(void);
  12. extern void lcd_clear(void);
  13. extern void lcd_home(void);
  14. /*extern void lcd_no_display(void);
  15. extern void lcd_display(void);
  16. extern void lcd_no_blink(void);
  17. extern void lcd_blink(void);
  18. extern void lcd_no_cursor(void);
  19. extern void lcd_cursor(void);
  20. extern void lcd_scrollDisplayLeft(void);
  21. extern void lcd_scrollDisplayRight(void);
  22. extern void lcd_leftToRight(void);
  23. extern void lcd_rightToLeft(void);
  24. extern void lcd_autoscroll(void);
  25. extern void lcd_no_autoscroll(void);*/
  26. extern void lcd_set_cursor(uint8_t col, uint8_t row);
  27. extern void lcd_createChar_P(uint8_t, const uint8_t*);
  28. // char c is non-standard, however it saves 1B on stack
  29. extern int lcd_putc(char c);
  30. extern int lcd_putc_at(uint8_t c, uint8_t r, char ch);
  31. extern int lcd_puts_P(const char* str);
  32. extern int lcd_puts_at_P(uint8_t c, uint8_t r, const char* str);
  33. extern int lcd_printf_P(const char* format, ...);
  34. extern void lcd_space(uint8_t n);
  35. extern void lcd_printNumber(unsigned long n, uint8_t base);
  36. extern void lcd_printFloat(double number, uint8_t digits);
  37. extern void lcd_print(const char*);
  38. extern void lcd_print(char, int = 0);
  39. extern void lcd_print(unsigned char, int = 0);
  40. extern void lcd_print(int, int = 10);
  41. extern void lcd_print(unsigned int, int = 10);
  42. extern void lcd_print(long, int = 10);
  43. extern void lcd_print(unsigned long, int = 10);
  44. extern void lcd_print(double, int = 2);
  45. //! @brief Clear screen
  46. #define ESC_2J "\x1b[2J"
  47. //! @brief Show cursor
  48. #define ESC_25h "\x1b[?25h"
  49. //! @brief Hide cursor
  50. #define ESC_25l "\x1b[?25l"
  51. //! @brief Set cursor to
  52. //! @param c column
  53. //! @param r row
  54. #define ESC_H(c,r) "\x1b["#r";"#c"H"
  55. #define LCD_UPDATE_INTERVAL 100
  56. #define LCD_TIMEOUT_TO_STATUS 30000ul //!< Generic timeout to status screen in ms, when no user action.
  57. #define LCD_TIMEOUT_TO_STATUS_BABYSTEP_Z 90000ul //!< Specific timeout for lcd_babystep_z screen in ms.
  58. typedef void (*lcd_longpress_func_t)(void);
  59. typedef void (*lcd_charsetup_func_t)(void);
  60. typedef void (*lcd_lcdupdate_func_t)(void);
  61. //Set to none-zero when the LCD needs to draw, decreased after every draw. Set to 2 in LCD routines so the LCD gets at least 1 full redraw (first redraw is partial)
  62. extern uint8_t lcd_draw_update;
  63. extern int32_t lcd_encoder;
  64. extern uint8_t lcd_encoder_bits;
  65. // lcd_encoder_diff is updated from interrupt context and added to lcd_encoder every LCD update
  66. extern int8_t lcd_encoder_diff;
  67. //the last checked lcd_buttons in a bit array.
  68. extern uint8_t lcd_buttons;
  69. extern uint8_t lcd_button_pressed;
  70. extern uint8_t lcd_update_enabled;
  71. extern LongTimer lcd_timeoutToStatus;
  72. extern uint32_t lcd_next_update_millis;
  73. extern uint8_t lcd_status_update_delay;
  74. extern lcd_longpress_func_t lcd_longpress_func;
  75. extern bool lcd_longpress_trigger;
  76. extern lcd_charsetup_func_t lcd_charsetup_func;
  77. extern lcd_lcdupdate_func_t lcd_lcdupdate_func;
  78. extern uint8_t lcd_clicked(void);
  79. extern void lcd_beeper_quick_feedback(void);
  80. //Cause an LCD refresh, and give the user visual or audible feedback that something has happened
  81. extern void lcd_quick_feedback(void);
  82. extern void lcd_update(uint8_t lcdDrawUpdateOverride);
  83. extern void lcd_update_enable(uint8_t enabled);
  84. extern void lcd_buttons_update(void);
  85. //! @brief Helper class to temporarily disable LCD updates
  86. //!
  87. //! When constructed (on stack), original state state of lcd_update_enabled is stored
  88. //! and LCD updates are disabled.
  89. //! When destroyed (gone out of scope), original state of LCD update is restored.
  90. //! It has zero overhead compared to storing bool saved = lcd_update_enabled
  91. //! and calling lcd_update_enable(false) and lcd_update_enable(saved).
  92. class LcdUpdateDisabler
  93. {
  94. public:
  95. LcdUpdateDisabler(): m_updateEnabled(lcd_update_enabled)
  96. {
  97. lcd_update_enable(false);
  98. }
  99. ~LcdUpdateDisabler()
  100. {
  101. lcd_update_enable(m_updateEnabled);
  102. }
  103. private:
  104. bool m_updateEnabled;
  105. };
  106. ////////////////////////////////////
  107. // Setup button and encode mappings for each panel (into 'lcd_buttons' variable
  108. //
  109. // This is just to map common functions (across different panels) onto the same
  110. // macro name. The mapping is independent of whether the button is directly connected or
  111. // via a shift/i2c register.
  112. #define BLEN_B 1
  113. #define BLEN_A 0
  114. #define EN_B (1<<BLEN_B) // The two encoder pins are connected through BTN_EN1 and BTN_EN2
  115. #define EN_A (1<<BLEN_A)
  116. #define BLEN_C 2
  117. #define EN_C (1<<BLEN_C)
  118. //! @brief Was button clicked?
  119. //!
  120. //! Doesn't consume button click event. See lcd_clicked()
  121. //! for function consuming the event.
  122. //!
  123. //! Generally is used in non-modal menus.
  124. //!
  125. //! @retval 0 button was not clicked
  126. //! @retval 1 button was clicked
  127. #define LCD_CLICKED (lcd_buttons&EN_C)
  128. ////////////////////////
  129. // Setup Rotary Encoder Bit Values (for two pin encoders to indicate movement)
  130. // These values are independent of which pins are used for EN_A and EN_B indications
  131. // The rotary encoder part is also independent to the chipset used for the LCD
  132. #define encrot0 0
  133. #define encrot1 2
  134. #define encrot2 3
  135. #define encrot3 1
  136. //Custom characters defined in the first 8 characters of the LCD
  137. #define LCD_STR_BEDTEMP "\x00"
  138. #define LCD_STR_DEGREE "\x01"
  139. #define LCD_STR_THERMOMETER "\x02"
  140. #define LCD_STR_UPLEVEL "\x03"
  141. #define LCD_STR_REFRESH "\x04"
  142. #define LCD_STR_FOLDER "\x05"
  143. #define LCD_STR_FEEDRATE "\x06"
  144. #define LCD_STR_CLOCK "\x07"
  145. #define LCD_STR_ARROW_UP "\x0B"
  146. #define LCD_STR_ARROW_DOWN "\x01"
  147. #define LCD_STR_ARROW_RIGHT "\x7E" //from the default character set
  148. extern void lcd_set_custom_characters(void);
  149. extern void lcd_set_custom_characters_arrows(void);
  150. extern void lcd_set_custom_characters_nextpage(void);
  151. extern void lcd_set_custom_characters_degree(void);
  152. //! @brief Consume click event
  153. inline void lcd_consume_click()
  154. {
  155. lcd_button_pressed = 0;
  156. lcd_buttons &= 0xff^EN_C;
  157. }
  158. #endif //_LCD_H