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 29KB

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