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

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