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_implementation_hitachi_HD44780.h 30KB

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