lcd.h 5.9 KB

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