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

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017
  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 safe_delay(uint16_t del){
  390. while (del > 50) {
  391. del -= 50;
  392. delay(50);
  393. thermalManager.manage_heater();
  394. }
  395. delay(del);
  396. }
  397. void bootscreen() {
  398. byte top_left[8] = {
  399. B00000,
  400. B00000,
  401. B00000,
  402. B00000,
  403. B00001,
  404. B00010,
  405. B00100,
  406. B00100
  407. };
  408. byte top_right[8] = {
  409. B00000,
  410. B00000,
  411. B00000,
  412. B11100,
  413. B11100,
  414. B01100,
  415. B00100,
  416. B00100
  417. };
  418. byte botom_left[8] = {
  419. B00100,
  420. B00010,
  421. B00001,
  422. B00000,
  423. B00000,
  424. B00000,
  425. B00000,
  426. B00000
  427. };
  428. byte botom_right[8] = {
  429. B00100,
  430. B01000,
  431. B10000,
  432. B00000,
  433. B00000,
  434. B00000,
  435. B00000,
  436. B00000
  437. };
  438. lcd.createChar(0, top_left);
  439. lcd.createChar(1, top_right);
  440. lcd.createChar(2, botom_left);
  441. lcd.createChar(3, botom_right);
  442. lcd.clear();
  443. #define LCD_EXTRA_SPACE (LCD_WIDTH-8)
  444. #define CENTER_OR_SCROLL(STRING,DELAY) \
  445. lcd_erase_line(3); \
  446. if (strlen(STRING) <= LCD_WIDTH) { \
  447. lcd.setCursor((LCD_WIDTH - lcd_strlen_P(PSTR(STRING))) / 2, 3); \
  448. lcd_printPGM(PSTR(STRING)); \
  449. safe_delay(DELAY); \
  450. } \
  451. else { \
  452. lcd_scroll(0, 3, PSTR(STRING), LCD_WIDTH, DELAY); \
  453. }
  454. #ifdef STRING_SPLASH_LINE1
  455. //
  456. // Show the Marlin logo with splash line 1
  457. //
  458. if (LCD_EXTRA_SPACE >= strlen(STRING_SPLASH_LINE1) + 1) {
  459. //
  460. // Show the Marlin logo, splash line1, and splash line 2
  461. //
  462. logo_lines(PSTR(" " STRING_SPLASH_LINE1));
  463. #ifdef STRING_SPLASH_LINE2
  464. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 2000);
  465. #else
  466. safe_delay(2000);
  467. #endif
  468. }
  469. else {
  470. //
  471. // Show the Marlin logo with splash line 1
  472. // After a delay show splash line 2, if it exists
  473. //
  474. #ifdef STRING_SPLASH_LINE2
  475. #define _SPLASH_WAIT_1 1500
  476. #else
  477. #define _SPLASH_WAIT_1 2000
  478. #endif
  479. logo_lines(PSTR(""));
  480. CENTER_OR_SCROLL(STRING_SPLASH_LINE1, _SPLASH_WAIT_1);
  481. #ifdef STRING_SPLASH_LINE2
  482. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 1500);
  483. #endif
  484. }
  485. #elif defined(STRING_SPLASH_LINE2)
  486. //
  487. // Show splash line 2 only, alongside the logo if possible
  488. //
  489. if (LCD_EXTRA_SPACE >= strlen(STRING_SPLASH_LINE2) + 1) {
  490. logo_lines(PSTR(" " STRING_SPLASH_LINE2));
  491. safe_delay(2000);
  492. }
  493. else {
  494. logo_lines(PSTR(""));
  495. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 2000);
  496. }
  497. #else
  498. //
  499. // Show only the Marlin logo
  500. //
  501. logo_lines(PSTR(""));
  502. safe_delay(2000);
  503. #endif
  504. lcd_set_custom_characters(
  505. #if ENABLED(LCD_PROGRESS_BAR)
  506. false
  507. #endif
  508. );
  509. }
  510. #endif // SHOW_BOOTSCREEN
  511. void lcd_kill_screen() {
  512. lcd.setCursor(0, 0);
  513. lcd_print(lcd_status_message);
  514. #if LCD_HEIGHT < 4
  515. lcd.setCursor(0, 2);
  516. #else
  517. lcd.setCursor(0, 2);
  518. lcd_printPGM(PSTR(MSG_HALTED));
  519. lcd.setCursor(0, 3);
  520. #endif
  521. lcd_printPGM(PSTR(MSG_PLEASE_RESET));
  522. }
  523. FORCE_INLINE void _draw_axis_label(AxisEnum axis, const char *pstr, bool blink) {
  524. if (blink)
  525. lcd_printPGM(pstr);
  526. else {
  527. if (!axis_homed[axis])
  528. lcd_printPGM(PSTR("?"));
  529. else {
  530. #if DISABLED(DISABLE_REDUCED_ACCURACY_WARNING)
  531. if (!axis_known_position[axis])
  532. lcd_printPGM(PSTR(" "));
  533. else
  534. #endif
  535. lcd_printPGM(pstr);
  536. }
  537. }
  538. }
  539. /**
  540. Possible status screens:
  541. 16x2 |000/000 B000/000|
  542. |0123456789012345|
  543. 16x4 |000/000 B000/000|
  544. |SD100% Z 000.00|
  545. |F100% T--:--|
  546. |0123456789012345|
  547. 20x2 |T000/000D B000/000D |
  548. |01234567890123456789|
  549. 20x4 |T000/000D B000/000D |
  550. |X 000 Y 000 Z 000.00|
  551. |F100% SD100% T--:--|
  552. |01234567890123456789|
  553. 20x4 |T000/000D B000/000D |
  554. |T000/000D Z 000.00|
  555. |F100% SD100% T--:--|
  556. |01234567890123456789|
  557. */
  558. static void lcd_implementation_status_screen() {
  559. #define LCD_TEMP_ONLY(T1,T2) \
  560. lcd.print(itostr3(T1 + 0.5)); \
  561. lcd.print('/'); \
  562. lcd.print(itostr3left(T2 + 0.5))
  563. #define LCD_TEMP(T1,T2,PREFIX) \
  564. lcd.print(PREFIX); \
  565. LCD_TEMP_ONLY(T1,T2); \
  566. lcd_printPGM(PSTR(LCD_STR_DEGREE " ")); \
  567. if (T2 < 10) lcd.print(' ')
  568. //
  569. // Line 1
  570. //
  571. lcd.setCursor(0, 0);
  572. #if LCD_WIDTH < 20
  573. //
  574. // Hotend 0 Temperature
  575. //
  576. LCD_TEMP_ONLY(thermalManager.degHotend(0), thermalManager.degTargetHotend(0));
  577. //
  578. // Hotend 1 or Bed Temperature
  579. //
  580. #if HOTENDS > 1 || TEMP_SENSOR_BED != 0
  581. lcd.setCursor(8, 0);
  582. #if HOTENDS > 1
  583. lcd.print(LCD_STR_THERMOMETER[0]);
  584. LCD_TEMP_ONLY(thermalManager.degHotend(1), thermalManager.degTargetHotend(1));
  585. #else
  586. lcd.print(LCD_STR_BEDTEMP[0]);
  587. LCD_TEMP_ONLY(thermalManager.degBed(), thermalManager.degTargetBed());
  588. #endif
  589. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  590. #else // LCD_WIDTH >= 20
  591. //
  592. // Hotend 0 Temperature
  593. //
  594. LCD_TEMP(thermalManager.degHotend(0), thermalManager.degTargetHotend(0), LCD_STR_THERMOMETER[0]);
  595. //
  596. // Hotend 1 or Bed Temperature
  597. //
  598. #if HOTENDS > 1 || TEMP_SENSOR_BED != 0
  599. lcd.setCursor(10, 0);
  600. #if HOTENDS > 1
  601. LCD_TEMP(thermalManager.degHotend(1), thermalManager.degTargetHotend(1), LCD_STR_THERMOMETER[0]);
  602. #else
  603. LCD_TEMP(thermalManager.degBed(), thermalManager.degTargetBed(), LCD_STR_BEDTEMP[0]);
  604. #endif
  605. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  606. #endif // LCD_WIDTH >= 20
  607. //
  608. // Line 2
  609. //
  610. #if LCD_HEIGHT > 2
  611. bool blink = lcd_blink();
  612. #if LCD_WIDTH < 20
  613. #if ENABLED(SDSUPPORT)
  614. lcd.setCursor(0, 2);
  615. lcd_printPGM(PSTR("SD"));
  616. if (IS_SD_PRINTING)
  617. lcd.print(itostr3(card.percentDone()));
  618. else
  619. lcd_printPGM(PSTR("---"));
  620. lcd.print('%');
  621. #endif // SDSUPPORT
  622. #else // LCD_WIDTH >= 20
  623. lcd.setCursor(0, 1);
  624. #if HOTENDS > 1 && TEMP_SENSOR_BED != 0
  625. // If we both have a 2nd extruder and a heated bed,
  626. // show the heated bed temp on the left,
  627. // since the first line is filled with extruder temps
  628. LCD_TEMP(thermalManager.degBed(), thermalManager.degTargetBed(), LCD_STR_BEDTEMP[0]);
  629. #else
  630. // Before homing the axis letters are blinking 'X' <-> '?'.
  631. // When axis is homed but axis_known_position is false the axis letters are blinking 'X' <-> ' '.
  632. // When everything is ok you see a constant 'X'.
  633. _draw_axis_label(X_AXIS, PSTR(MSG_X), blink);
  634. lcd.print(ftostr4sign(current_position[X_AXIS]));
  635. lcd_printPGM(PSTR(" "));
  636. _draw_axis_label(Y_AXIS, PSTR(MSG_Y), blink);
  637. lcd.print(ftostr4sign(current_position[Y_AXIS]));
  638. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  639. #endif // LCD_WIDTH >= 20
  640. lcd.setCursor(LCD_WIDTH - 8, 1);
  641. _draw_axis_label(Z_AXIS, PSTR(MSG_Z), blink);
  642. lcd.print(ftostr52sp(current_position[Z_AXIS] + 0.00001));
  643. #endif // LCD_HEIGHT > 2
  644. //
  645. // Line 3
  646. //
  647. #if LCD_HEIGHT > 3
  648. lcd.setCursor(0, 2);
  649. lcd.print(LCD_STR_FEEDRATE[0]);
  650. lcd.print(itostr3(feedrate_multiplier));
  651. lcd.print('%');
  652. #if LCD_WIDTH > 19 && ENABLED(SDSUPPORT)
  653. lcd.setCursor(7, 2);
  654. lcd_printPGM(PSTR("SD"));
  655. if (IS_SD_PRINTING)
  656. lcd.print(itostr3(card.percentDone()));
  657. else
  658. lcd_printPGM(PSTR("---"));
  659. lcd.print('%');
  660. #endif // LCD_WIDTH > 19 && SDSUPPORT
  661. lcd.setCursor(LCD_WIDTH - 6, 2);
  662. lcd.print(LCD_STR_CLOCK[0]);
  663. uint16_t time = print_job_timer.duration() / 60;
  664. if (time != 0) {
  665. lcd.print(itostr2(time / 60));
  666. lcd.print(':');
  667. lcd.print(itostr2(time % 60));
  668. }
  669. else {
  670. lcd_printPGM(PSTR("--:--"));
  671. }
  672. #endif // LCD_HEIGHT > 3
  673. //
  674. // Last Line
  675. // Status Message (which may be a Progress Bar or Filament display)
  676. //
  677. lcd.setCursor(0, LCD_HEIGHT - 1);
  678. #if ENABLED(LCD_PROGRESS_BAR)
  679. if (card.isFileOpen()) {
  680. // Draw the progress bar if the message has shown long enough
  681. // or if there is no message set.
  682. if (ELAPSED(millis(), progress_bar_ms + PROGRESS_BAR_MSG_TIME) || !lcd_status_message[0]) {
  683. int tix = (int)(card.percentDone() * (LCD_WIDTH) * 3) / 100,
  684. cel = tix / 3, rem = tix % 3, i = LCD_WIDTH;
  685. char msg[LCD_WIDTH + 1], b = ' ';
  686. msg[i] = '\0';
  687. while (i--) {
  688. if (i == cel - 1)
  689. b = LCD_STR_PROGRESS[2];
  690. else if (i == cel && rem != 0)
  691. b = LCD_STR_PROGRESS[rem - 1];
  692. msg[i] = b;
  693. }
  694. lcd.print(msg);
  695. return;
  696. }
  697. } //card.isFileOpen
  698. #elif ENABLED(FILAMENT_LCD_DISPLAY)
  699. // Show Filament Diameter and Volumetric Multiplier %
  700. // After allowing lcd_status_message to show for 5 seconds
  701. if (ELAPSED(millis(), previous_lcd_status_ms + 5000UL)) {
  702. lcd_printPGM(PSTR("Dia "));
  703. lcd.print(ftostr12ns(filament_width_meas));
  704. lcd_printPGM(PSTR(" V"));
  705. lcd.print(itostr3(100.0 * volumetric_multiplier[FILAMENT_SENSOR_EXTRUDER_NUM]));
  706. lcd.print('%');
  707. return;
  708. }
  709. #endif // FILAMENT_LCD_DISPLAY
  710. lcd_print(lcd_status_message);
  711. }
  712. #if ENABLED(LCD_INFO_MENU) || ENABLED(FILAMENT_CHANGE_FEATURE)
  713. static void lcd_implementation_drawmenu_static(uint8_t row, const char* pstr, const char *valstr=NULL, bool center=true) {
  714. char c;
  715. int8_t n = LCD_WIDTH;
  716. lcd.setCursor(0, row);
  717. if (center && !valstr) {
  718. int8_t pad = (LCD_WIDTH - lcd_strlen_P(pstr)) / 2;
  719. while (--pad >= 0) { lcd.print(' '); n--; }
  720. }
  721. while ((c = pgm_read_byte(pstr)) && n > 0) {
  722. n -= lcd_print(c);
  723. pstr++;
  724. }
  725. if (valstr) {
  726. lcd_print(valstr);
  727. n -= lcd_strlen(valstr);
  728. }
  729. while (n-- > 0) lcd.print(' ');
  730. }
  731. #endif // LCD_INFO_MENU || FILAMENT_CHANGE_FEATURE
  732. static void lcd_implementation_drawmenu_generic(bool sel, uint8_t row, const char* pstr, char pre_char, char post_char) {
  733. char c;
  734. uint8_t n = LCD_WIDTH - 2;
  735. lcd.setCursor(0, row);
  736. lcd.print(sel ? pre_char : ' ');
  737. while ((c = pgm_read_byte(pstr)) && n > 0) {
  738. n -= lcd_print(c);
  739. pstr++;
  740. }
  741. while (n--) lcd.print(' ');
  742. lcd.print(post_char);
  743. }
  744. static void lcd_implementation_drawmenu_setting_edit_generic(bool sel, uint8_t row, const char* pstr, char pre_char, char* data) {
  745. char c;
  746. uint8_t n = LCD_WIDTH - 2 - lcd_strlen(data);
  747. lcd.setCursor(0, row);
  748. lcd.print(sel ? pre_char : ' ');
  749. while ((c = pgm_read_byte(pstr)) && n > 0) {
  750. n -= lcd_print(c);
  751. pstr++;
  752. }
  753. lcd.print(':');
  754. while (n--) lcd.print(' ');
  755. lcd_print(data);
  756. }
  757. static void lcd_implementation_drawmenu_setting_edit_generic_P(bool sel, uint8_t row, const char* pstr, char pre_char, const char* data) {
  758. char c;
  759. uint8_t n = LCD_WIDTH - 2 - lcd_strlen_P(data);
  760. lcd.setCursor(0, row);
  761. lcd.print(sel ? pre_char : ' ');
  762. while ((c = pgm_read_byte(pstr)) && n > 0) {
  763. n -= lcd_print(c);
  764. pstr++;
  765. }
  766. lcd.print(':');
  767. while (n--) lcd.print(' ');
  768. lcd_printPGM(data);
  769. }
  770. #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)))
  771. #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)))
  772. #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)))
  773. #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)))
  774. #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)))
  775. #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)))
  776. #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)))
  777. #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)))
  778. #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))
  779. //Add version for callback functions
  780. #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)))
  781. #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)))
  782. #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)))
  783. #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)))
  784. #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)))
  785. #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)))
  786. #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)))
  787. #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)))
  788. #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))
  789. void lcd_implementation_drawedit(const char* pstr, const char* value=NULL) {
  790. lcd.setCursor(1, 1);
  791. lcd_printPGM(pstr);
  792. if (value != NULL) {
  793. lcd.print(':');
  794. lcd.setCursor(LCD_WIDTH - lcd_strlen(value), 1);
  795. lcd_print(value);
  796. }
  797. }
  798. #if ENABLED(SDSUPPORT)
  799. 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) {
  800. UNUSED(pstr);
  801. char c;
  802. uint8_t n = LCD_WIDTH - concat;
  803. lcd.setCursor(0, row);
  804. lcd.print(sel ? '>' : ' ');
  805. if (longFilename[0]) {
  806. filename = longFilename;
  807. longFilename[n] = '\0';
  808. }
  809. while ((c = *filename) && n > 0) {
  810. n -= lcd_print(c);
  811. filename++;
  812. }
  813. while (n--) lcd.print(' ');
  814. lcd.print(post_char);
  815. }
  816. static void lcd_implementation_drawmenu_sdfile(bool sel, uint8_t row, const char* pstr, const char* filename, char* longFilename) {
  817. lcd_implementation_drawmenu_sd(sel, row, pstr, filename, longFilename, 2, ' ');
  818. }
  819. static void lcd_implementation_drawmenu_sddirectory(bool sel, uint8_t row, const char* pstr, const char* filename, char* longFilename) {
  820. lcd_implementation_drawmenu_sd(sel, row, pstr, filename, longFilename, 2, LCD_STR_FOLDER[0]);
  821. }
  822. #endif //SDSUPPORT
  823. #define lcd_implementation_drawmenu_back(sel, row, pstr) lcd_implementation_drawmenu_generic(sel, row, pstr, LCD_STR_UPLEVEL[0], LCD_STR_UPLEVEL[0])
  824. #define lcd_implementation_drawmenu_submenu(sel, row, pstr, data) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', LCD_STR_ARROW_RIGHT[0])
  825. #define lcd_implementation_drawmenu_gcode(sel, row, pstr, gcode) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', ' ')
  826. #define lcd_implementation_drawmenu_function(sel, row, pstr, data) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', ' ')
  827. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  828. static void lcd_implementation_update_indicators() {
  829. // Set the LEDS - referred to as backlights by the LiquidTWI2 library
  830. static uint8_t ledsprev = 0;
  831. uint8_t leds = 0;
  832. if (thermalManager.degTargetBed() > 0) leds |= LED_A;
  833. if (thermalManager.degTargetHotend(0) > 0) leds |= LED_B;
  834. #if FAN_COUNT > 0
  835. if (0
  836. #if HAS_FAN0
  837. || fanSpeeds[0]
  838. #endif
  839. #if HAS_FAN1
  840. || fanSpeeds[1]
  841. #endif
  842. #if HAS_FAN2
  843. || fanSpeeds[2]
  844. #endif
  845. ) leds |= LED_C;
  846. #endif // FAN_COUNT > 0
  847. #if HOTENDS > 1
  848. if (thermalManager.degTargetHotend(1) > 0) leds |= LED_C;
  849. #endif
  850. if (leds != ledsprev) {
  851. lcd.setBacklight(leds);
  852. ledsprev = leds;
  853. }
  854. }
  855. #endif // LCD_HAS_STATUS_INDICATORS
  856. #if ENABLED(LCD_HAS_SLOW_BUTTONS)
  857. extern millis_t next_button_update_ms;
  858. static uint8_t lcd_implementation_read_slow_buttons() {
  859. #if ENABLED(LCD_I2C_TYPE_MCP23017)
  860. // Reading these buttons this is likely to be too slow to call inside interrupt context
  861. // so they are called during normal lcd_update
  862. uint8_t slow_bits = lcd.readButtons() << B_I2C_BTN_OFFSET;
  863. #if ENABLED(LCD_I2C_VIKI)
  864. if ((slow_bits & (B_MI | B_RI)) && PENDING(millis(), next_button_update_ms)) // LCD clicked
  865. slow_bits &= ~(B_MI | B_RI); // Disable LCD clicked buttons if screen is updated
  866. #endif // LCD_I2C_VIKI
  867. return slow_bits;
  868. #endif // LCD_I2C_TYPE_MCP23017
  869. }
  870. #endif // LCD_HAS_SLOW_BUTTONS
  871. #endif // ULTRALCD_IMPLEMENTATION_HITACHI_HD44780_H