My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ultralcd_impl_HD44780.h 30KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #ifndef ULTRALCD_IMPL_HD44780_H
  23. #define ULTRALCD_IMPL_HD44780_H
  24. /**
  25. * Implementation of the LCD display routines for a Hitachi HD44780 display.
  26. * These are the most common LCD character displays.
  27. */
  28. #include "utility.h"
  29. #include "duration_t.h"
  30. extern volatile uint8_t buttons; //an extended version of the last checked buttons in a bit array.
  31. ////////////////////////////////////
  32. // Setup button and encode mappings for each panel (into 'buttons' variable
  33. //
  34. // This is just to map common functions (across different panels) onto the same
  35. // macro name. The mapping is independent of whether the button is directly connected or
  36. // via a shift/i2c register.
  37. #if ENABLED(ULTIPANEL)
  38. //
  39. // Setup other button mappings of each panel
  40. //
  41. #if ENABLED(LCD_I2C_VIKI)
  42. #define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
  43. // button and encoder bit positions within 'buttons'
  44. #define B_LE (BUTTON_LEFT<<B_I2C_BTN_OFFSET) // The remaining normalized buttons are all read via I2C
  45. #define B_UP (BUTTON_UP<<B_I2C_BTN_OFFSET)
  46. #define B_MI (BUTTON_SELECT<<B_I2C_BTN_OFFSET)
  47. #define B_DW (BUTTON_DOWN<<B_I2C_BTN_OFFSET)
  48. #define B_RI (BUTTON_RIGHT<<B_I2C_BTN_OFFSET)
  49. #if BUTTON_EXISTS(ENC)
  50. // the pause/stop/restart button is connected to BTN_ENC when used
  51. #define B_ST (EN_C) // Map the pause/stop/resume button into its normalized functional name
  52. #undef LCD_CLICKED
  53. #define LCD_CLICKED (buttons&(B_MI|B_RI|B_ST)) // pause/stop button also acts as click until we implement proper pause/stop.
  54. #else
  55. #undef LCD_CLICKED
  56. #define LCD_CLICKED (buttons&(B_MI|B_RI))
  57. #endif
  58. // I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
  59. #define LCD_HAS_SLOW_BUTTONS
  60. #elif ENABLED(LCD_I2C_PANELOLU2)
  61. #if !BUTTON_EXISTS(ENC) // Use I2C if not directly connected to a pin
  62. #define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
  63. #define B_MI (PANELOLU2_ENCODER_C<<B_I2C_BTN_OFFSET) // requires LiquidTWI2 library v1.2.3 or later
  64. #undef LCD_CLICKED
  65. #define LCD_CLICKED (buttons & B_MI)
  66. // I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
  67. #define LCD_HAS_SLOW_BUTTONS
  68. #endif
  69. #elif DISABLED(NEWPANEL) // old style ULTIPANEL
  70. // Shift register bits correspond to buttons:
  71. #define BL_LE 7 // Left
  72. #define BL_UP 6 // Up
  73. #define BL_MI 5 // Middle
  74. #define BL_DW 4 // Down
  75. #define BL_RI 3 // Right
  76. #define BL_ST 2 // Red Button
  77. #define B_LE (_BV(BL_LE))
  78. #define B_UP (_BV(BL_UP))
  79. #define B_MI (_BV(BL_MI))
  80. #define B_DW (_BV(BL_DW))
  81. #define B_RI (_BV(BL_RI))
  82. #define B_ST (_BV(BL_ST))
  83. #define LCD_CLICKED ((buttons & B_MI) || (buttons & B_ST))
  84. #endif
  85. #endif // ULTIPANEL
  86. ////////////////////////////////////
  87. // Create LCD class instance and chipset-specific information
  88. #if ENABLED(LCD_I2C_TYPE_PCF8575)
  89. // note: these are register mapped pins on the PCF8575 controller not Arduino pins
  90. #define LCD_I2C_PIN_BL 3
  91. #define LCD_I2C_PIN_EN 2
  92. #define LCD_I2C_PIN_RW 1
  93. #define LCD_I2C_PIN_RS 0
  94. #define LCD_I2C_PIN_D4 4
  95. #define LCD_I2C_PIN_D5 5
  96. #define LCD_I2C_PIN_D6 6
  97. #define LCD_I2C_PIN_D7 7
  98. #include <Wire.h>
  99. #include <LCD.h>
  100. #include <LiquidCrystal_I2C.h>
  101. #define LCD_CLASS LiquidCrystal_I2C
  102. LCD_CLASS lcd(LCD_I2C_ADDRESS, LCD_I2C_PIN_EN, LCD_I2C_PIN_RW, LCD_I2C_PIN_RS, LCD_I2C_PIN_D4, LCD_I2C_PIN_D5, LCD_I2C_PIN_D6, LCD_I2C_PIN_D7);
  103. #elif ENABLED(LCD_I2C_TYPE_MCP23017)
  104. //for the LED indicators (which maybe mapped to different things in lcd_implementation_update_indicators())
  105. #define LED_A 0x04 //100
  106. #define LED_B 0x02 //010
  107. #define LED_C 0x01 //001
  108. #define LCD_HAS_STATUS_INDICATORS
  109. #include <Wire.h>
  110. #include <LiquidTWI2.h>
  111. #define LCD_CLASS LiquidTWI2
  112. #if ENABLED(DETECT_DEVICE)
  113. LCD_CLASS lcd(LCD_I2C_ADDRESS, 1);
  114. #else
  115. LCD_CLASS lcd(LCD_I2C_ADDRESS);
  116. #endif
  117. #elif ENABLED(LCD_I2C_TYPE_MCP23008)
  118. #include <Wire.h>
  119. #include <LiquidTWI2.h>
  120. #define LCD_CLASS LiquidTWI2
  121. #if ENABLED(DETECT_DEVICE)
  122. LCD_CLASS lcd(LCD_I2C_ADDRESS, 1);
  123. #else
  124. LCD_CLASS lcd(LCD_I2C_ADDRESS);
  125. #endif
  126. #elif ENABLED(LCD_I2C_TYPE_PCA8574)
  127. #include <LiquidCrystal_I2C.h>
  128. #define LCD_CLASS LiquidCrystal_I2C
  129. LCD_CLASS lcd(LCD_I2C_ADDRESS, LCD_WIDTH, LCD_HEIGHT);
  130. // 2 wire Non-latching LCD SR from:
  131. // https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/schematics#!shiftregister-connection
  132. #elif ENABLED(SR_LCD_2W_NL)
  133. extern "C" void __cxa_pure_virtual() { while (1); }
  134. #include <LCD.h>
  135. #include <LiquidCrystal_SR.h>
  136. #define LCD_CLASS LiquidCrystal_SR
  137. #if PIN_EXISTS(SR_STROBE)
  138. LCD_CLASS lcd(SR_DATA_PIN, SR_CLK_PIN, SR_STROBE_PIN);
  139. #else
  140. LCD_CLASS lcd(SR_DATA_PIN, SR_CLK_PIN);
  141. #endif
  142. #elif ENABLED(LCM1602)
  143. #include <Wire.h>
  144. #include <LCD.h>
  145. #include <LiquidCrystal_I2C.h>
  146. #define LCD_CLASS LiquidCrystal_I2C
  147. LCD_CLASS lcd(0x27, 2, 1, 0, 4, 5, 6, 7, 3, POSITIVE);
  148. #else
  149. // Standard directly connected LCD implementations
  150. #include <LiquidCrystal.h>
  151. #define LCD_CLASS LiquidCrystal
  152. LCD_CLASS lcd(LCD_PINS_RS, LCD_PINS_ENABLE, LCD_PINS_D4, LCD_PINS_D5, LCD_PINS_D6, LCD_PINS_D7); //RS,Enable,D4,D5,D6,D7
  153. #endif
  154. #include "utf_mapper.h"
  155. #if ENABLED(LCD_PROGRESS_BAR)
  156. static millis_t progress_bar_ms = 0;
  157. #if PROGRESS_MSG_EXPIRE > 0
  158. static millis_t expire_status_ms = 0;
  159. #endif
  160. #define LCD_STR_PROGRESS "\x03\x04\x05"
  161. #endif
  162. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  163. static void lcd_implementation_update_indicators();
  164. #endif
  165. static void lcd_set_custom_characters(
  166. #if ENABLED(LCD_PROGRESS_BAR)
  167. const bool info_screen_charset = true
  168. #endif
  169. ) {
  170. static byte bedTemp[8] = {
  171. B00000,
  172. B11111,
  173. B10101,
  174. B10001,
  175. B10101,
  176. B11111,
  177. B00000,
  178. B00000
  179. }; //thanks Sonny Mounicou
  180. static byte degree[8] = {
  181. B01100,
  182. B10010,
  183. B10010,
  184. B01100,
  185. B00000,
  186. B00000,
  187. B00000,
  188. B00000
  189. };
  190. static byte thermometer[8] = {
  191. B00100,
  192. B01010,
  193. B01010,
  194. B01010,
  195. B01010,
  196. B10001,
  197. B10001,
  198. B01110
  199. };
  200. static byte uplevel[8] = {
  201. B00100,
  202. B01110,
  203. B11111,
  204. B00100,
  205. B11100,
  206. B00000,
  207. B00000,
  208. B00000
  209. }; //thanks joris
  210. static byte feedrate[8] = {
  211. B11100,
  212. B10000,
  213. B11000,
  214. B10111,
  215. B00101,
  216. B00110,
  217. B00101,
  218. B00000
  219. }; //thanks Sonny Mounicou
  220. static byte clock[8] = {
  221. B00000,
  222. B01110,
  223. B10011,
  224. B10101,
  225. B10001,
  226. B01110,
  227. B00000,
  228. B00000
  229. }; //thanks Sonny Mounicou
  230. lcd.createChar(LCD_STR_BEDTEMP[0], bedTemp);
  231. lcd.createChar(LCD_STR_DEGREE[0], degree);
  232. lcd.createChar(LCD_STR_THERMOMETER[0], thermometer);
  233. lcd.createChar(LCD_STR_FEEDRATE[0], feedrate);
  234. lcd.createChar(LCD_STR_CLOCK[0], clock);
  235. #if ENABLED(SDSUPPORT)
  236. static byte refresh[8] = {
  237. B00000,
  238. B00110,
  239. B11001,
  240. B11000,
  241. B00011,
  242. B10011,
  243. B01100,
  244. B00000,
  245. }; //thanks joris
  246. static byte folder[8] = {
  247. B00000,
  248. B11100,
  249. B11111,
  250. B10001,
  251. B10001,
  252. B11111,
  253. B00000,
  254. B00000
  255. }; //thanks joris
  256. #if ENABLED(LCD_PROGRESS_BAR)
  257. static byte progress[3][8] = { {
  258. B00000,
  259. B10000,
  260. B10000,
  261. B10000,
  262. B10000,
  263. B10000,
  264. B10000,
  265. B00000
  266. }, {
  267. B00000,
  268. B10100,
  269. B10100,
  270. B10100,
  271. B10100,
  272. B10100,
  273. B10100,
  274. B00000
  275. }, {
  276. B00000,
  277. B10101,
  278. B10101,
  279. B10101,
  280. B10101,
  281. B10101,
  282. B10101,
  283. B00000
  284. } };
  285. static bool char_mode = false;
  286. if (info_screen_charset != char_mode) {
  287. char_mode = info_screen_charset;
  288. if (info_screen_charset) { // Progress bar characters for info screen
  289. for (int i = 3; i--;) lcd.createChar(LCD_STR_PROGRESS[i], progress[i]);
  290. }
  291. else { // Custom characters for submenus
  292. lcd.createChar(LCD_STR_UPLEVEL[0], uplevel);
  293. lcd.createChar(LCD_STR_REFRESH[0], refresh);
  294. lcd.createChar(LCD_STR_FOLDER[0], folder);
  295. }
  296. }
  297. #else
  298. lcd.createChar(LCD_STR_UPLEVEL[0], uplevel);
  299. lcd.createChar(LCD_STR_REFRESH[0], refresh);
  300. lcd.createChar(LCD_STR_FOLDER[0], folder);
  301. #endif
  302. #else
  303. lcd.createChar(LCD_STR_UPLEVEL[0], uplevel);
  304. #endif
  305. }
  306. static void lcd_implementation_init(
  307. #if ENABLED(LCD_PROGRESS_BAR)
  308. const bool info_screen_charset = true
  309. #endif
  310. ) {
  311. #if ENABLED(LCD_I2C_TYPE_PCF8575)
  312. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  313. #ifdef LCD_I2C_PIN_BL
  314. lcd.setBacklightPin(LCD_I2C_PIN_BL, POSITIVE);
  315. lcd.setBacklight(HIGH);
  316. #endif
  317. #elif ENABLED(LCD_I2C_TYPE_MCP23017)
  318. lcd.setMCPType(LTI_TYPE_MCP23017);
  319. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  320. lcd_implementation_update_indicators();
  321. #elif ENABLED(LCD_I2C_TYPE_MCP23008)
  322. lcd.setMCPType(LTI_TYPE_MCP23008);
  323. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  324. #elif ENABLED(LCD_I2C_TYPE_PCA8574)
  325. lcd.init();
  326. lcd.backlight();
  327. #else
  328. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  329. #endif
  330. lcd_set_custom_characters(
  331. #if ENABLED(LCD_PROGRESS_BAR)
  332. info_screen_charset
  333. #endif
  334. );
  335. lcd.clear();
  336. }
  337. void lcd_implementation_clear() { lcd.clear(); }
  338. void lcd_print(const char c) { charset_mapper(c); }
  339. void lcd_print(const char *str) { while (*str) lcd.print(*str++); }
  340. void lcd_printPGM(const char *str) { while (const char c = pgm_read_byte(str)) lcd.print(c), ++str; }
  341. void lcd_print_utf(const char *str, uint8_t n=LCD_WIDTH) {
  342. char c;
  343. while (n && (c = *str)) n -= charset_mapper(c), ++str;
  344. }
  345. void lcd_printPGM_utf(const char *str, uint8_t n=LCD_WIDTH) {
  346. char c;
  347. while (n && (c = pgm_read_byte(str))) n -= charset_mapper(c), ++str;
  348. }
  349. #if ENABLED(SHOW_BOOTSCREEN)
  350. void lcd_erase_line(const int line) {
  351. lcd.setCursor(0, line);
  352. for (uint8_t i = LCD_WIDTH + 1; --i;)
  353. lcd.print(' ');
  354. }
  355. // Scroll the PSTR 'text' in a 'len' wide field for 'time' milliseconds at position col,line
  356. void lcd_scroll(const int col, const int line, const char* const text, const int len, const int time) {
  357. char tmp[LCD_WIDTH + 1] = {0};
  358. int n = max(lcd_strlen_P(text) - len, 0);
  359. for (int i = 0; i <= n; i++) {
  360. strncpy_P(tmp, text + i, min(len, LCD_WIDTH));
  361. lcd.setCursor(col, line);
  362. lcd_print(tmp);
  363. delay(time / max(n, 1));
  364. }
  365. }
  366. static void logo_lines(const char* const extra) {
  367. int indent = (LCD_WIDTH - 8 - lcd_strlen_P(extra)) / 2;
  368. lcd.setCursor(indent, 0); lcd.print('\x00'); lcd_printPGM(PSTR( "------" )); lcd.print('\x01');
  369. lcd.setCursor(indent, 1); lcd_printPGM(PSTR("|Marlin|")); lcd_printPGM(extra);
  370. lcd.setCursor(indent, 2); lcd.print('\x02'); lcd_printPGM(PSTR( "------" )); lcd.print('\x03');
  371. }
  372. void bootscreen() {
  373. byte top_left[8] = {
  374. B00000,
  375. B00000,
  376. B00000,
  377. B00000,
  378. B00001,
  379. B00010,
  380. B00100,
  381. B00100
  382. };
  383. byte top_right[8] = {
  384. B00000,
  385. B00000,
  386. B00000,
  387. B11100,
  388. B11100,
  389. B01100,
  390. B00100,
  391. B00100
  392. };
  393. byte botom_left[8] = {
  394. B00100,
  395. B00010,
  396. B00001,
  397. B00000,
  398. B00000,
  399. B00000,
  400. B00000,
  401. B00000
  402. };
  403. byte botom_right[8] = {
  404. B00100,
  405. B01000,
  406. B10000,
  407. B00000,
  408. B00000,
  409. B00000,
  410. B00000,
  411. B00000
  412. };
  413. lcd.createChar(0, top_left);
  414. lcd.createChar(1, top_right);
  415. lcd.createChar(2, botom_left);
  416. lcd.createChar(3, botom_right);
  417. lcd.clear();
  418. #define LCD_EXTRA_SPACE (LCD_WIDTH-8)
  419. #define CENTER_OR_SCROLL(STRING,DELAY) \
  420. lcd_erase_line(3); \
  421. if (strlen(STRING) <= LCD_WIDTH) { \
  422. lcd.setCursor((LCD_WIDTH - lcd_strlen_P(PSTR(STRING))) / 2, 3); \
  423. lcd_printPGM(PSTR(STRING)); \
  424. safe_delay(DELAY); \
  425. } \
  426. else { \
  427. lcd_scroll(0, 3, PSTR(STRING), LCD_WIDTH, DELAY); \
  428. }
  429. #ifdef STRING_SPLASH_LINE1
  430. //
  431. // Show the Marlin logo with splash line 1
  432. //
  433. if (LCD_EXTRA_SPACE >= strlen(STRING_SPLASH_LINE1) + 1) {
  434. //
  435. // Show the Marlin logo, splash line1, and splash line 2
  436. //
  437. logo_lines(PSTR(" " STRING_SPLASH_LINE1));
  438. #ifdef STRING_SPLASH_LINE2
  439. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 2000);
  440. #else
  441. safe_delay(2000);
  442. #endif
  443. }
  444. else {
  445. //
  446. // Show the Marlin logo with splash line 1
  447. // After a delay show splash line 2, if it exists
  448. //
  449. #ifdef STRING_SPLASH_LINE2
  450. #define _SPLASH_WAIT_1 1500
  451. #else
  452. #define _SPLASH_WAIT_1 2000
  453. #endif
  454. logo_lines(PSTR(""));
  455. CENTER_OR_SCROLL(STRING_SPLASH_LINE1, _SPLASH_WAIT_1);
  456. #ifdef STRING_SPLASH_LINE2
  457. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 1500);
  458. #endif
  459. }
  460. #elif defined(STRING_SPLASH_LINE2)
  461. //
  462. // Show splash line 2 only, alongside the logo if possible
  463. //
  464. if (LCD_EXTRA_SPACE >= strlen(STRING_SPLASH_LINE2) + 1) {
  465. logo_lines(PSTR(" " STRING_SPLASH_LINE2));
  466. safe_delay(2000);
  467. }
  468. else {
  469. logo_lines(PSTR(""));
  470. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 2000);
  471. }
  472. #else
  473. //
  474. // Show only the Marlin logo
  475. //
  476. logo_lines(PSTR(""));
  477. safe_delay(2000);
  478. #endif
  479. lcd.clear();
  480. safe_delay(100);
  481. lcd_set_custom_characters(
  482. #if ENABLED(LCD_PROGRESS_BAR)
  483. false
  484. #endif
  485. );
  486. }
  487. #endif // SHOW_BOOTSCREEN
  488. void lcd_kill_screen() {
  489. lcd.setCursor(0, 0);
  490. lcd_print_utf(lcd_status_message);
  491. #if LCD_HEIGHT < 4
  492. lcd.setCursor(0, 2);
  493. #else
  494. lcd.setCursor(0, 2);
  495. lcd_printPGM(PSTR(MSG_HALTED));
  496. lcd.setCursor(0, 3);
  497. #endif
  498. lcd_printPGM(PSTR(MSG_PLEASE_RESET));
  499. }
  500. FORCE_INLINE void _draw_axis_label(const AxisEnum axis, const char* const pstr, const bool blink) {
  501. if (blink)
  502. lcd_printPGM(pstr);
  503. else {
  504. if (!axis_homed[axis])
  505. lcd.print('?');
  506. else {
  507. #if DISABLED(DISABLE_REDUCED_ACCURACY_WARNING)
  508. if (!axis_known_position[axis])
  509. lcd.print(' ');
  510. else
  511. #endif
  512. lcd_printPGM(pstr);
  513. }
  514. }
  515. }
  516. FORCE_INLINE void _draw_heater_status(const int8_t heater, const char prefix, const bool blink) {
  517. const bool isBed = heater < 0;
  518. const float t1 = (isBed ? thermalManager.degBed() : thermalManager.degHotend(heater)),
  519. t2 = (isBed ? thermalManager.degTargetBed() : thermalManager.degTargetHotend(heater));
  520. if (prefix >= 0) lcd.print(prefix);
  521. lcd.print(itostr3(t1 + 0.5));
  522. lcd.print('/');
  523. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  524. const bool is_idle = (!isBed ? thermalManager.is_heater_idle(heater) :
  525. #if HAS_TEMP_BED
  526. thermalManager.is_bed_idle()
  527. #else
  528. false
  529. #endif
  530. );
  531. if (!blink && is_idle) {
  532. lcd.print(' ');
  533. if (t2 >= 10) lcd.print(' ');
  534. if (t2 >= 100) lcd.print(' ');
  535. }
  536. else
  537. #endif
  538. lcd.print(itostr3left(t2 + 0.5));
  539. if (prefix >= 0) {
  540. lcd_printPGM(PSTR(LCD_STR_DEGREE " "));
  541. if (t2 < 10) lcd.print(' ');
  542. }
  543. }
  544. #if ENABLED(LCD_PROGRESS_BAR)
  545. inline void lcd_draw_progress_bar(const uint8_t percent) {
  546. int tix = (int)(percent * (LCD_WIDTH) * 3) / 100,
  547. cel = tix / 3, rem = tix % 3, i = LCD_WIDTH;
  548. char msg[LCD_WIDTH + 1], b = ' ';
  549. msg[i] = '\0';
  550. while (i--) {
  551. if (i == cel - 1)
  552. b = LCD_STR_PROGRESS[2];
  553. else if (i == cel && rem != 0)
  554. b = LCD_STR_PROGRESS[rem - 1];
  555. msg[i] = b;
  556. }
  557. lcd.print(msg);
  558. }
  559. #endif // LCD_PROGRESS_BAR
  560. /**
  561. Possible status screens:
  562. 16x2 |000/000 B000/000|
  563. |0123456789012345|
  564. 16x4 |000/000 B000/000|
  565. |SD100% Z 000.00|
  566. |F100% T--:--|
  567. |0123456789012345|
  568. 20x2 |T000/000D B000/000D |
  569. |01234567890123456789|
  570. 20x4 |T000/000D B000/000D |
  571. |X 000 Y 000 Z 000.00|
  572. |F100% SD100% T--:--|
  573. |01234567890123456789|
  574. 20x4 |T000/000D B000/000D |
  575. |T000/000D Z 000.00|
  576. |F100% SD100% T--:--|
  577. |01234567890123456789|
  578. */
  579. static void lcd_implementation_status_screen() {
  580. const bool blink = lcd_blink();
  581. //
  582. // Line 1
  583. //
  584. lcd.setCursor(0, 0);
  585. #if LCD_WIDTH < 20
  586. //
  587. // Hotend 0 Temperature
  588. //
  589. _draw_heater_status(0, -1, blink);
  590. //
  591. // Hotend 1 or Bed Temperature
  592. //
  593. #if HOTENDS > 1 || TEMP_SENSOR_BED != 0
  594. lcd.setCursor(8, 0);
  595. #if HOTENDS > 1
  596. lcd.print(LCD_STR_THERMOMETER[0]);
  597. _draw_heater_status(1, -1, blink);
  598. #else
  599. lcd.print(LCD_STR_BEDTEMP[0]);
  600. _draw_heater_status(-1, -1, blink);
  601. #endif
  602. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  603. #else // LCD_WIDTH >= 20
  604. //
  605. // Hotend 0 Temperature
  606. //
  607. _draw_heater_status(0, LCD_STR_THERMOMETER[0], blink);
  608. //
  609. // Hotend 1 or Bed Temperature
  610. //
  611. #if HOTENDS > 1 || TEMP_SENSOR_BED != 0
  612. lcd.setCursor(10, 0);
  613. #if HOTENDS > 1
  614. _draw_heater_status(1, LCD_STR_THERMOMETER[0], blink);
  615. #else
  616. _draw_heater_status(-1, LCD_STR_BEDTEMP[0], blink);
  617. #endif
  618. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  619. #endif // LCD_WIDTH >= 20
  620. //
  621. // Line 2
  622. //
  623. #if LCD_HEIGHT > 2
  624. #if LCD_WIDTH < 20
  625. #if ENABLED(SDSUPPORT)
  626. lcd.setCursor(0, 2);
  627. lcd_printPGM(PSTR("SD"));
  628. if (IS_SD_PRINTING)
  629. lcd.print(itostr3(card.percentDone()));
  630. else
  631. lcd_printPGM(PSTR("---"));
  632. lcd.print('%');
  633. #endif // SDSUPPORT
  634. #else // LCD_WIDTH >= 20
  635. lcd.setCursor(0, 1);
  636. #if HOTENDS > 1 && TEMP_SENSOR_BED != 0
  637. // If we both have a 2nd extruder and a heated bed,
  638. // show the heated bed temp on the left,
  639. // since the first line is filled with extruder temps
  640. _draw_heater_status(-1, LCD_STR_BEDTEMP[0], blink);
  641. #else
  642. // Before homing the axis letters are blinking 'X' <-> '?'.
  643. // When axis is homed but axis_known_position is false the axis letters are blinking 'X' <-> ' '.
  644. // When everything is ok you see a constant 'X'.
  645. _draw_axis_label(X_AXIS, PSTR(MSG_X), blink);
  646. lcd.print(ftostr4sign(current_position[X_AXIS]));
  647. lcd.print(' ');
  648. _draw_axis_label(Y_AXIS, PSTR(MSG_Y), blink);
  649. lcd.print(ftostr4sign(current_position[Y_AXIS]));
  650. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  651. #endif // LCD_WIDTH >= 20
  652. lcd.setCursor(LCD_WIDTH - 8, 1);
  653. _draw_axis_label(Z_AXIS, PSTR(MSG_Z), blink);
  654. lcd.print(ftostr52sp(FIXFLOAT(current_position[Z_AXIS])));
  655. #endif // LCD_HEIGHT > 2
  656. //
  657. // Line 3
  658. //
  659. #if LCD_HEIGHT > 3
  660. lcd.setCursor(0, 2);
  661. lcd.print(LCD_STR_FEEDRATE[0]);
  662. lcd.print(itostr3(feedrate_percentage));
  663. lcd.print('%');
  664. #if LCD_WIDTH >= 20 && ENABLED(SDSUPPORT)
  665. lcd.setCursor(7, 2);
  666. lcd_printPGM(PSTR("SD"));
  667. if (IS_SD_PRINTING)
  668. lcd.print(itostr3(card.percentDone()));
  669. else
  670. lcd_printPGM(PSTR("---"));
  671. lcd.print('%');
  672. #endif // LCD_WIDTH >= 20 && SDSUPPORT
  673. char buffer[10];
  674. duration_t elapsed = print_job_timer.duration();
  675. uint8_t len = elapsed.toDigital(buffer);
  676. lcd.setCursor(LCD_WIDTH - len - 1, 2);
  677. lcd.print(LCD_STR_CLOCK[0]);
  678. lcd_print(buffer);
  679. #endif // LCD_HEIGHT > 3
  680. //
  681. // Last Line
  682. // Status Message (which may be a Progress Bar or Filament display)
  683. //
  684. lcd.setCursor(0, LCD_HEIGHT - 1);
  685. #if ENABLED(LCD_PROGRESS_BAR)
  686. // Draw the progress bar if the message has shown long enough
  687. // or if there is no message set.
  688. if (card.isFileOpen() && (ELAPSED(millis(), progress_bar_ms + PROGRESS_BAR_MSG_TIME) || !lcd_status_message[0])) {
  689. const uint8_t percent = card.percentDone();
  690. if (percent) return lcd_draw_progress_bar(percent);
  691. }
  692. #elif ENABLED(FILAMENT_LCD_DISPLAY) && ENABLED(SDSUPPORT)
  693. // Show Filament Diameter and Volumetric Multiplier %
  694. // After allowing lcd_status_message to show for 5 seconds
  695. if (ELAPSED(millis(), previous_lcd_status_ms + 5000UL)) {
  696. lcd_printPGM(PSTR("Dia "));
  697. lcd.print(ftostr12ns(filament_width_meas));
  698. lcd_printPGM(PSTR(" V"));
  699. lcd.print(itostr3(100.0 * volumetric_multiplier[FILAMENT_SENSOR_EXTRUDER_NUM]));
  700. lcd.print('%');
  701. return;
  702. }
  703. #endif // FILAMENT_LCD_DISPLAY && SDSUPPORT
  704. #if ENABLED(STATUS_MESSAGE_SCROLLING)
  705. static bool last_blink = false;
  706. lcd_print_utf(lcd_status_message + status_scroll_pos);
  707. const uint8_t slen = lcd_strlen(lcd_status_message);
  708. if (slen > LCD_WIDTH) {
  709. if (last_blink != blink) {
  710. last_blink = blink;
  711. // Skip any non-printing bytes
  712. while (!PRINTABLE(lcd_status_message[status_scroll_pos])) status_scroll_pos++;
  713. if (++status_scroll_pos > slen - LCD_WIDTH) status_scroll_pos = 0;
  714. }
  715. }
  716. #else
  717. lcd_print_utf(lcd_status_message);
  718. #endif
  719. }
  720. #if ENABLED(ULTIPANEL)
  721. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  722. static void lcd_implementation_hotend_status(const uint8_t row) {
  723. if (row < LCD_HEIGHT) {
  724. lcd.setCursor(LCD_WIDTH - 9, row);
  725. _draw_heater_status(active_extruder, LCD_STR_THERMOMETER[0], lcd_blink());
  726. }
  727. }
  728. #endif // ADVANCED_PAUSE_FEATURE
  729. static void lcd_implementation_drawmenu_static(const uint8_t row, const char* pstr, const bool center=true, const bool invert=false, const char *valstr=NULL) {
  730. UNUSED(invert);
  731. char c;
  732. int8_t n = LCD_WIDTH;
  733. lcd.setCursor(0, row);
  734. if (center && !valstr) {
  735. int8_t pad = (LCD_WIDTH - lcd_strlen_P(pstr)) / 2;
  736. while (--pad >= 0) { lcd.print(' '); n--; }
  737. }
  738. while (n > 0 && (c = pgm_read_byte(pstr))) {
  739. n -= charset_mapper(c);
  740. pstr++;
  741. }
  742. if (valstr) while (n > 0 && (c = *valstr)) {
  743. n -= charset_mapper(c);
  744. valstr++;
  745. }
  746. while (n-- > 0) lcd.print(' ');
  747. }
  748. static void lcd_implementation_drawmenu_generic(const bool sel, const uint8_t row, const char* pstr, const char pre_char, const char post_char) {
  749. char c;
  750. uint8_t n = LCD_WIDTH - 2;
  751. lcd.setCursor(0, row);
  752. lcd.print(sel ? pre_char : ' ');
  753. while ((c = pgm_read_byte(pstr)) && n > 0) {
  754. n -= charset_mapper(c);
  755. pstr++;
  756. }
  757. while (n--) lcd.print(' ');
  758. lcd.print(post_char);
  759. }
  760. static void lcd_implementation_drawmenu_setting_edit_generic(const bool sel, const uint8_t row, const char* pstr, const char pre_char, const char* const data) {
  761. char c;
  762. uint8_t n = LCD_WIDTH - 2 - lcd_strlen(data);
  763. lcd.setCursor(0, row);
  764. lcd.print(sel ? pre_char : ' ');
  765. while ((c = pgm_read_byte(pstr)) && n > 0) {
  766. n -= charset_mapper(c);
  767. pstr++;
  768. }
  769. lcd.print(':');
  770. while (n--) lcd.print(' ');
  771. lcd_print(data);
  772. }
  773. static void lcd_implementation_drawmenu_setting_edit_generic_P(const bool sel, const uint8_t row, const char* pstr, const char pre_char, const char* const data) {
  774. char c;
  775. uint8_t n = LCD_WIDTH - 2 - lcd_strlen_P(data);
  776. lcd.setCursor(0, row);
  777. lcd.print(sel ? pre_char : ' ');
  778. while ((c = pgm_read_byte(pstr)) && n > 0) {
  779. n -= charset_mapper(c);
  780. pstr++;
  781. }
  782. lcd.print(':');
  783. while (n--) lcd.print(' ');
  784. lcd_printPGM(data);
  785. }
  786. #define DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(_type, _name, _strFunc) \
  787. inline void lcd_implementation_drawmenu_setting_edit_ ## _name (const bool sel, const uint8_t row, const char* pstr, const char* pstr2, _type * const data, ...) { \
  788. lcd_implementation_drawmenu_setting_edit_generic(sel, row, pstr, '>', _strFunc(*(data))); \
  789. } \
  790. inline void lcd_implementation_drawmenu_setting_edit_callback_ ## _name (const bool sel, const uint8_t row, const char* pstr, const char* pstr2, _type * const data, ...) { \
  791. lcd_implementation_drawmenu_setting_edit_generic(sel, row, pstr, '>', _strFunc(*(data))); \
  792. } \
  793. inline void lcd_implementation_drawmenu_setting_edit_accessor_ ## _name (const bool sel, const uint8_t row, const char* pstr, const char* pstr2, _type (*pget)(), void (*pset)(_type), ...) { \
  794. lcd_implementation_drawmenu_setting_edit_generic(sel, row, pstr, '>', _strFunc(pget())); \
  795. } \
  796. typedef void _name##_void
  797. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(int, int3, itostr3);
  798. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float3, ftostr3);
  799. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float32, ftostr32);
  800. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float43, ftostr43sign);
  801. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float5, ftostr5rj);
  802. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float51, ftostr51sign);
  803. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float52, ftostr52sign);
  804. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(float, float62, ftostr62rj);
  805. DEFINE_LCD_IMPLEMENTATION_DRAWMENU_SETTING_EDIT_TYPE(unsigned long, long5, ftostr5rj);
  806. #define lcd_implementation_drawmenu_setting_edit_bool(sel, row, pstr, pstr2, data) lcd_implementation_drawmenu_setting_edit_generic_P(sel, row, pstr, '>', (*(data))?PSTR(MSG_ON):PSTR(MSG_OFF))
  807. #define lcd_implementation_drawmenu_setting_edit_callback_bool(sel, row, pstr, pstr2, data, callback) lcd_implementation_drawmenu_setting_edit_generic_P(sel, row, pstr, '>', (*(data))?PSTR(MSG_ON):PSTR(MSG_OFF))
  808. #define lcd_implementation_drawmenu_setting_edit_accessor_bool(sel, row, pstr, pstr2, pget, pset, callback) lcd_implementation_drawmenu_setting_edit_generic_P(sel, row, pstr, '>', (*(data))?PSTR(MSG_ON):PSTR(MSG_OFF))
  809. void lcd_implementation_drawedit(const char* pstr, const char* const value=NULL) {
  810. lcd.setCursor(1, 1);
  811. lcd_printPGM(pstr);
  812. if (value != NULL) {
  813. lcd.print(':');
  814. lcd.setCursor(LCD_WIDTH - lcd_strlen(value), 1);
  815. lcd_print(value);
  816. }
  817. }
  818. #if ENABLED(SDSUPPORT)
  819. static void lcd_implementation_drawmenu_sd(const bool sel, const uint8_t row, const char* const pstr, const char* filename, char* const longFilename, const uint8_t concat, const char post_char) {
  820. UNUSED(pstr);
  821. char c;
  822. uint8_t n = LCD_WIDTH - concat;
  823. lcd.setCursor(0, row);
  824. lcd.print(sel ? '>' : ' ');
  825. if (longFilename[0]) {
  826. filename = longFilename;
  827. longFilename[n] = '\0';
  828. }
  829. while ((c = *filename) && n > 0) {
  830. n -= charset_mapper(c);
  831. filename++;
  832. }
  833. while (n--) lcd.print(' ');
  834. lcd.print(post_char);
  835. }
  836. static void lcd_implementation_drawmenu_sdfile(const bool sel, const uint8_t row, const char* pstr, const char* filename, char* const longFilename) {
  837. lcd_implementation_drawmenu_sd(sel, row, pstr, filename, longFilename, 2, ' ');
  838. }
  839. static void lcd_implementation_drawmenu_sddirectory(const bool sel, const uint8_t row, const char* pstr, const char* filename, char* const longFilename) {
  840. lcd_implementation_drawmenu_sd(sel, row, pstr, filename, longFilename, 2, LCD_STR_FOLDER[0]);
  841. }
  842. #endif // SDSUPPORT
  843. #define lcd_implementation_drawmenu_back(sel, row, pstr, dummy) lcd_implementation_drawmenu_generic(sel, row, pstr, LCD_STR_UPLEVEL[0], LCD_STR_UPLEVEL[0])
  844. #define lcd_implementation_drawmenu_submenu(sel, row, pstr, data) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', LCD_STR_ARROW_RIGHT[0])
  845. #define lcd_implementation_drawmenu_gcode(sel, row, pstr, gcode) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', ' ')
  846. #define lcd_implementation_drawmenu_function(sel, row, pstr, data) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', ' ')
  847. #if ENABLED(LCD_HAS_SLOW_BUTTONS)
  848. extern millis_t next_button_update_ms;
  849. static uint8_t lcd_implementation_read_slow_buttons() {
  850. #if ENABLED(LCD_I2C_TYPE_MCP23017)
  851. // Reading these buttons this is likely to be too slow to call inside interrupt context
  852. // so they are called during normal lcd_update
  853. uint8_t slow_bits = lcd.readButtons() << B_I2C_BTN_OFFSET;
  854. #if ENABLED(LCD_I2C_VIKI)
  855. if ((slow_bits & (B_MI | B_RI)) && PENDING(millis(), next_button_update_ms)) // LCD clicked
  856. slow_bits &= ~(B_MI | B_RI); // Disable LCD clicked buttons if screen is updated
  857. #endif // LCD_I2C_VIKI
  858. return slow_bits;
  859. #endif // LCD_I2C_TYPE_MCP23017
  860. }
  861. #endif // LCD_HAS_SLOW_BUTTONS
  862. #endif // ULTIPANEL
  863. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  864. static void lcd_implementation_update_indicators() {
  865. // Set the LEDS - referred to as backlights by the LiquidTWI2 library
  866. static uint8_t ledsprev = 0;
  867. uint8_t leds = 0;
  868. if (thermalManager.degTargetBed() > 0) leds |= LED_A;
  869. if (thermalManager.degTargetHotend(0) > 0) leds |= LED_B;
  870. #if FAN_COUNT > 0
  871. if (0
  872. #if HAS_FAN0
  873. || fanSpeeds[0]
  874. #endif
  875. #if HAS_FAN1
  876. || fanSpeeds[1]
  877. #endif
  878. #if HAS_FAN2
  879. || fanSpeeds[2]
  880. #endif
  881. ) leds |= LED_C;
  882. #endif // FAN_COUNT > 0
  883. #if HOTENDS > 1
  884. if (thermalManager.degTargetHotend(1) > 0) leds |= LED_C;
  885. #endif
  886. if (leds != ledsprev) {
  887. lcd.setBacklight(leds);
  888. ledsprev = leds;
  889. }
  890. }
  891. #endif // LCD_HAS_STATUS_INDICATORS
  892. #endif // ULTRALCD_IMPL_HD44780_H