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_HD44780.cpp 47KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (c) 2020 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. #include "../../inc/MarlinConfigPre.h"
  23. #if HAS_CHARACTER_LCD
  24. /**
  25. * ultralcd_HD44780.cpp
  26. *
  27. * LCD display implementations for Hitachi HD44780.
  28. * These are the most common LCD character displays.
  29. */
  30. #include "ultralcd_HD44780.h"
  31. #include "../ultralcd.h"
  32. #include "../../libs/numtostr.h"
  33. #include "../../sd/cardreader.h"
  34. #include "../../module/temperature.h"
  35. #include "../../module/printcounter.h"
  36. #include "../../module/planner.h"
  37. #include "../../module/motion.h"
  38. #if DISABLED(LCD_PROGRESS_BAR) && BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
  39. #include "../../feature/filwidth.h"
  40. #include "../../gcode/parser.h"
  41. #endif
  42. #if ENABLED(AUTO_BED_LEVELING_UBL)
  43. #include "../../feature/bedlevel/bedlevel.h"
  44. #endif
  45. //
  46. // Create LCD instance and chipset-specific information
  47. //
  48. #if ENABLED(LCD_I2C_TYPE_PCF8575)
  49. 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);
  50. #elif EITHER(LCD_I2C_TYPE_MCP23017, LCD_I2C_TYPE_MCP23008)
  51. LCD_CLASS lcd(LCD_I2C_ADDRESS
  52. #ifdef DETECT_DEVICE
  53. , 1
  54. #endif
  55. );
  56. #elif ENABLED(LCD_I2C_TYPE_PCA8574)
  57. LCD_CLASS lcd(LCD_I2C_ADDRESS, LCD_WIDTH, LCD_HEIGHT);
  58. #elif ENABLED(SR_LCD_2W_NL)
  59. // 2 wire Non-latching LCD SR from:
  60. // https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/schematics#!shiftregister-connection
  61. LCD_CLASS lcd(SR_DATA_PIN, SR_CLK_PIN
  62. #if PIN_EXISTS(SR_STROBE)
  63. , SR_STROBE_PIN
  64. #endif
  65. );
  66. #elif ENABLED(SR_LCD_3W_NL)
  67. // NewLiquidCrystal was not working
  68. // https://github.com/mikeshub/SailfishLCD
  69. // uses the code directly from Sailfish
  70. LCD_CLASS lcd(SR_STROBE_PIN, SR_DATA_PIN, SR_CLK_PIN);
  71. #elif ENABLED(LCM1602)
  72. LCD_CLASS lcd(0x27, 2, 1, 0, 4, 5, 6, 7, 3, POSITIVE);
  73. #else
  74. // Standard direct-connected LCD implementations
  75. LCD_CLASS lcd(LCD_PINS_RS, LCD_PINS_ENABLE, LCD_PINS_D4, LCD_PINS_D5, LCD_PINS_D6, LCD_PINS_D7);
  76. #endif
  77. static void createChar_P(const char c, const byte * const ptr) {
  78. byte temp[8];
  79. LOOP_L_N(i, 8)
  80. temp[i] = pgm_read_byte(&ptr[i]);
  81. lcd.createChar(c, temp);
  82. }
  83. #if ENABLED(LCD_PROGRESS_BAR)
  84. #define LCD_STR_PROGRESS "\x03\x04\x05"
  85. #endif
  86. #if ENABLED(LCD_USE_I2C_BUZZER)
  87. void MarlinUI::buzz(const long duration, const uint16_t freq) {
  88. lcd.buzz(duration, freq);
  89. }
  90. #endif
  91. void MarlinUI::set_custom_characters(const HD44780CharSet screen_charset/*=CHARSET_INFO*/) {
  92. #if NONE(LCD_PROGRESS_BAR, SHOW_BOOTSCREEN)
  93. UNUSED(screen_charset);
  94. #endif
  95. // CHARSET_BOOT
  96. #if ENABLED(SHOW_BOOTSCREEN)
  97. const static PROGMEM byte corner[4][8] = { {
  98. B00000,
  99. B00000,
  100. B00000,
  101. B00000,
  102. B00001,
  103. B00010,
  104. B00100,
  105. B00100
  106. }, {
  107. B00000,
  108. B00000,
  109. B00000,
  110. B11100,
  111. B11100,
  112. B01100,
  113. B00100,
  114. B00100
  115. }, {
  116. B00100,
  117. B00010,
  118. B00001,
  119. B00000,
  120. B00000,
  121. B00000,
  122. B00000,
  123. B00000
  124. }, {
  125. B00100,
  126. B01000,
  127. B10000,
  128. B00000,
  129. B00000,
  130. B00000,
  131. B00000,
  132. B00000
  133. } };
  134. #endif // SHOW_BOOTSCREEN
  135. // CHARSET_INFO
  136. const static PROGMEM byte bedTemp[8] = {
  137. B00000,
  138. B11111,
  139. B10101,
  140. B10001,
  141. B10101,
  142. B11111,
  143. B00000,
  144. B00000
  145. };
  146. const static PROGMEM byte degree[8] = {
  147. B01100,
  148. B10010,
  149. B10010,
  150. B01100,
  151. B00000,
  152. B00000,
  153. B00000,
  154. B00000
  155. };
  156. const static PROGMEM byte thermometer[8] = {
  157. B00100,
  158. B01010,
  159. B01010,
  160. B01010,
  161. B01010,
  162. B10001,
  163. B10001,
  164. B01110
  165. };
  166. const static PROGMEM byte uplevel[8] = {
  167. B00100,
  168. B01110,
  169. B11111,
  170. B00100,
  171. B11100,
  172. B00000,
  173. B00000,
  174. B00000
  175. };
  176. const static PROGMEM byte feedrate[8] = {
  177. #if LCD_INFO_SCREEN_STYLE == 1
  178. B00000,
  179. B00100,
  180. B10010,
  181. B01001,
  182. B10010,
  183. B00100,
  184. B00000,
  185. B00000
  186. #else
  187. B11100,
  188. B10000,
  189. B11000,
  190. B10111,
  191. B00101,
  192. B00110,
  193. B00101,
  194. B00000
  195. #endif
  196. };
  197. const static PROGMEM byte clock[8] = {
  198. B00000,
  199. B01110,
  200. B10011,
  201. B10101,
  202. B10001,
  203. B01110,
  204. B00000,
  205. B00000
  206. };
  207. #if ENABLED(LCD_PROGRESS_BAR)
  208. // CHARSET_INFO
  209. const static PROGMEM byte progress[3][8] = { {
  210. B00000,
  211. B10000,
  212. B10000,
  213. B10000,
  214. B10000,
  215. B10000,
  216. B10000,
  217. B00000
  218. }, {
  219. B00000,
  220. B10100,
  221. B10100,
  222. B10100,
  223. B10100,
  224. B10100,
  225. B10100,
  226. B00000
  227. }, {
  228. B00000,
  229. B10101,
  230. B10101,
  231. B10101,
  232. B10101,
  233. B10101,
  234. B10101,
  235. B00000
  236. } };
  237. #endif // LCD_PROGRESS_BAR
  238. #if BOTH(SDSUPPORT, HAS_LCD_MENU)
  239. // CHARSET_MENU
  240. const static PROGMEM byte refresh[8] = {
  241. B00000,
  242. B00110,
  243. B11001,
  244. B11000,
  245. B00011,
  246. B10011,
  247. B01100,
  248. B00000,
  249. };
  250. const static PROGMEM byte folder[8] = {
  251. B00000,
  252. B11100,
  253. B11111,
  254. B10001,
  255. B10001,
  256. B11111,
  257. B00000,
  258. B00000
  259. };
  260. #endif // SDSUPPORT
  261. #if ENABLED(SHOW_BOOTSCREEN)
  262. // Set boot screen corner characters
  263. if (screen_charset == CHARSET_BOOT) {
  264. for (uint8_t i = 4; i--;)
  265. createChar_P(i, corner[i]);
  266. }
  267. else
  268. #endif
  269. { // Info Screen uses 5 special characters
  270. createChar_P(LCD_STR_BEDTEMP[0], bedTemp);
  271. createChar_P(LCD_STR_DEGREE[0], degree);
  272. createChar_P(LCD_STR_THERMOMETER[0], thermometer);
  273. createChar_P(LCD_STR_FEEDRATE[0], feedrate);
  274. createChar_P(LCD_STR_CLOCK[0], clock);
  275. #if ENABLED(LCD_PROGRESS_BAR)
  276. if (screen_charset == CHARSET_INFO) { // 3 Progress bar characters for info screen
  277. for (int16_t i = 3; i--;)
  278. createChar_P(LCD_STR_PROGRESS[i], progress[i]);
  279. }
  280. else
  281. #endif
  282. {
  283. createChar_P(LCD_STR_UPLEVEL[0], uplevel);
  284. #if BOTH(SDSUPPORT, HAS_LCD_MENU)
  285. // SD Card sub-menu special characters
  286. createChar_P(LCD_STR_REFRESH[0], refresh);
  287. createChar_P(LCD_STR_FOLDER[0], folder);
  288. #endif
  289. }
  290. }
  291. }
  292. void MarlinUI::init_lcd() {
  293. #if ENABLED(LCD_I2C_TYPE_PCF8575)
  294. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  295. #ifdef LCD_I2C_PIN_BL
  296. lcd.setBacklightPin(LCD_I2C_PIN_BL, POSITIVE);
  297. lcd.setBacklight(HIGH);
  298. #endif
  299. #elif ENABLED(LCD_I2C_TYPE_MCP23017)
  300. lcd.setMCPType(LTI_TYPE_MCP23017);
  301. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  302. update_indicators();
  303. #elif ENABLED(LCD_I2C_TYPE_MCP23008)
  304. lcd.setMCPType(LTI_TYPE_MCP23008);
  305. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  306. #elif ENABLED(LCD_I2C_TYPE_PCA8574)
  307. lcd.init();
  308. lcd.backlight();
  309. #else
  310. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  311. #endif
  312. set_custom_characters(on_status_screen() ? CHARSET_INFO : CHARSET_MENU);
  313. lcd.clear();
  314. }
  315. bool MarlinUI::detected() {
  316. return (true
  317. #if EITHER(LCD_I2C_TYPE_MCP23017, LCD_I2C_TYPE_MCP23008) && defined(DETECT_DEVICE)
  318. && lcd.LcdDetected() == 1
  319. #endif
  320. );
  321. }
  322. #if HAS_SLOW_BUTTONS
  323. uint8_t MarlinUI::read_slow_buttons() {
  324. #if ENABLED(LCD_I2C_TYPE_MCP23017)
  325. // Reading these buttons is too slow for interrupt context
  326. // so they are read during LCD update in the main loop.
  327. uint8_t slow_bits = lcd.readButtons()
  328. #if !BUTTON_EXISTS(ENC)
  329. << B_I2C_BTN_OFFSET
  330. #endif
  331. ;
  332. #if ENABLED(LCD_I2C_VIKI)
  333. if ((slow_bits & (B_MI | B_RI)) && PENDING(millis(), next_button_update_ms)) // LCD clicked
  334. slow_bits &= ~(B_MI | B_RI); // Disable LCD clicked buttons if screen is updated
  335. #endif
  336. return slow_bits;
  337. #endif // LCD_I2C_TYPE_MCP23017
  338. }
  339. #endif
  340. void MarlinUI::clear_lcd() { lcd.clear(); }
  341. #if ENABLED(SHOW_BOOTSCREEN)
  342. void lcd_erase_line(const lcd_uint_t line) {
  343. lcd_moveto(0, line);
  344. for (uint8_t i = LCD_WIDTH + 1; --i;)
  345. lcd_put_wchar(' ');
  346. }
  347. // Scroll the PSTR 'text' in a 'len' wide field for 'time' milliseconds at position col,line
  348. void lcd_scroll(const lcd_uint_t col, const lcd_uint_t line, PGM_P const text, const uint8_t len, const int16_t time) {
  349. uint8_t slen = utf8_strlen_P(text);
  350. if (slen < len) {
  351. lcd_put_u8str_max_P(col, line, text, len);
  352. for (; slen < len; ++slen) lcd_put_wchar(' ');
  353. safe_delay(time);
  354. }
  355. else {
  356. PGM_P p = text;
  357. int dly = time / _MAX(slen, 1);
  358. LOOP_LE_N(i, slen) {
  359. // Print the text at the correct place
  360. lcd_put_u8str_max_P(col, line, p, len);
  361. // Fill with spaces
  362. for (uint8_t ix = slen - i; ix < len; ++ix) lcd_put_wchar(' ');
  363. // Delay
  364. safe_delay(dly);
  365. // Advance to the next UTF8 valid position
  366. p++;
  367. while (!START_OF_UTF8_CHAR(pgm_read_byte(p))) p++;
  368. }
  369. }
  370. }
  371. static void logo_lines(PGM_P const extra) {
  372. int16_t indent = (LCD_WIDTH - 8 - utf8_strlen_P(extra)) / 2;
  373. lcd_put_wchar(indent, 0, '\x00'); lcd_put_u8str_P(PSTR( "------" )); lcd_put_wchar('\x01');
  374. lcd_put_u8str_P(indent, 1, PSTR("|Marlin|")); lcd_put_u8str_P(extra);
  375. lcd_put_wchar(indent, 2, '\x02'); lcd_put_u8str_P(PSTR( "------" )); lcd_put_wchar('\x03');
  376. }
  377. void MarlinUI::show_bootscreen() {
  378. set_custom_characters(CHARSET_BOOT);
  379. lcd.clear();
  380. #define LCD_EXTRA_SPACE (LCD_WIDTH-8)
  381. #define CENTER_OR_SCROLL(STRING,DELAY) \
  382. lcd_erase_line(3); \
  383. if (utf8_strlen(STRING) <= LCD_WIDTH) { \
  384. lcd_put_u8str_P((LCD_WIDTH - utf8_strlen_P(PSTR(STRING))) / 2, 3, PSTR(STRING)); \
  385. safe_delay(DELAY); \
  386. } \
  387. else { \
  388. lcd_scroll(0, 3, PSTR(STRING), LCD_WIDTH, DELAY); \
  389. }
  390. //
  391. // Show the Marlin logo with splash line 1
  392. //
  393. if (LCD_EXTRA_SPACE >= utf8_strlen(SHORT_BUILD_VERSION) + 1) {
  394. //
  395. // Show the Marlin logo, splash line1, and splash line 2
  396. //
  397. logo_lines(PSTR(" " SHORT_BUILD_VERSION));
  398. CENTER_OR_SCROLL(MARLIN_WEBSITE_URL, 2000);
  399. }
  400. else {
  401. //
  402. // Show the Marlin logo and short build version
  403. // After a delay show the website URL
  404. //
  405. extern const char NUL_STR[];
  406. logo_lines(NUL_STR);
  407. CENTER_OR_SCROLL(SHORT_BUILD_VERSION, 1500);
  408. CENTER_OR_SCROLL(MARLIN_WEBSITE_URL, 1500);
  409. #ifdef STRING_SPLASH_LINE3
  410. CENTER_OR_SCROLL(STRING_SPLASH_LINE3, 1500);
  411. #endif
  412. }
  413. lcd.clear();
  414. safe_delay(100);
  415. set_custom_characters(CHARSET_INFO);
  416. lcd.clear();
  417. }
  418. #endif // SHOW_BOOTSCREEN
  419. void MarlinUI::draw_kill_screen() {
  420. lcd_put_u8str(0, 0, status_message);
  421. lcd_uint_t y = 2;
  422. #if LCD_HEIGHT >= 4
  423. lcd_put_u8str_P(0, y++, GET_TEXT(MSG_HALTED));
  424. #endif
  425. lcd_put_u8str_P(0, y, GET_TEXT(MSG_PLEASE_RESET));
  426. }
  427. //
  428. // Before homing, blink '123' <-> '???'.
  429. // Homed but unknown... '123' <-> ' '.
  430. // Homed and known, display constantly.
  431. //
  432. FORCE_INLINE void _draw_axis_value(const AxisEnum axis, const char *value, const bool blink) {
  433. lcd_put_wchar('X' + uint8_t(axis));
  434. if (blink)
  435. lcd_put_u8str(value);
  436. else {
  437. if (!TEST(axis_homed, axis))
  438. while (const char c = *value++) lcd_put_wchar(c <= '.' ? c : '?');
  439. else {
  440. #if NONE(HOME_AFTER_DEACTIVATE, DISABLE_REDUCED_ACCURACY_WARNING)
  441. if (!TEST(axis_known_position, axis))
  442. lcd_put_u8str_P(axis == Z_AXIS ? PSTR(" ") : PSTR(" "));
  443. else
  444. #endif
  445. lcd_put_u8str(value);
  446. }
  447. }
  448. }
  449. FORCE_INLINE void _draw_heater_status(const heater_ind_t heater, const char prefix, const bool blink) {
  450. #if HAS_HEATED_BED
  451. const bool isBed = heater < 0;
  452. const float t1 = (isBed ? thermalManager.degBed() : thermalManager.degHotend(heater)),
  453. t2 = (isBed ? thermalManager.degTargetBed() : thermalManager.degTargetHotend(heater));
  454. #else
  455. const float t1 = thermalManager.degHotend(heater), t2 = thermalManager.degTargetHotend(heater);
  456. #endif
  457. if (prefix >= 0) lcd_put_wchar(prefix);
  458. lcd_put_u8str(i16tostr3rj(t1 + 0.5));
  459. lcd_put_wchar('/');
  460. #if !HEATER_IDLE_HANDLER
  461. UNUSED(blink);
  462. #else
  463. const bool is_idle = (
  464. #if HAS_HEATED_BED
  465. isBed ? thermalManager.bed_idle.timed_out :
  466. #endif
  467. thermalManager.hotend_idle[heater].timed_out
  468. );
  469. if (!blink && is_idle) {
  470. lcd_put_wchar(' ');
  471. if (t2 >= 10) lcd_put_wchar(' ');
  472. if (t2 >= 100) lcd_put_wchar(' ');
  473. }
  474. else
  475. #endif
  476. lcd_put_u8str(i16tostr3left(t2 + 0.5));
  477. if (prefix >= 0) {
  478. lcd_put_wchar(LCD_STR_DEGREE[0]);
  479. lcd_put_wchar(' ');
  480. if (t2 < 10) lcd_put_wchar(' ');
  481. }
  482. }
  483. FORCE_INLINE void _draw_bed_status(const bool blink) {
  484. _draw_heater_status(H_BED, (
  485. #if HAS_LEVELING
  486. planner.leveling_active && blink ? '_' :
  487. #endif
  488. LCD_STR_BEDTEMP[0]
  489. ),
  490. blink
  491. );
  492. }
  493. #if HAS_PRINT_PROGRESS
  494. FORCE_INLINE void _draw_print_progress() {
  495. const uint8_t progress = ui.get_progress_percent();
  496. lcd_put_u8str_P(PSTR(
  497. #if ENABLED(SDSUPPORT)
  498. "SD"
  499. #elif ENABLED(LCD_SET_PROGRESS_MANUALLY)
  500. "P:"
  501. #endif
  502. ));
  503. if (progress)
  504. lcd_put_u8str(ui8tostr3rj(progress));
  505. else
  506. lcd_put_u8str_P(PSTR("---"));
  507. lcd_put_wchar('%');
  508. }
  509. #endif
  510. #if ENABLED(LCD_PROGRESS_BAR)
  511. void MarlinUI::draw_progress_bar(const uint8_t percent) {
  512. const int16_t tix = (int16_t)(percent * (LCD_WIDTH) * 3) / 100,
  513. cel = tix / 3,
  514. rem = tix % 3;
  515. uint8_t i = LCD_WIDTH;
  516. char msg[LCD_WIDTH + 1], b = ' ';
  517. msg[LCD_WIDTH] = '\0';
  518. while (i--) {
  519. if (i == cel - 1)
  520. b = LCD_STR_PROGRESS[2];
  521. else if (i == cel && rem != 0)
  522. b = LCD_STR_PROGRESS[rem - 1];
  523. msg[i] = b;
  524. }
  525. lcd_put_u8str(msg);
  526. }
  527. #endif // LCD_PROGRESS_BAR
  528. void MarlinUI::draw_status_message(const bool blink) {
  529. lcd_moveto(0, LCD_HEIGHT - 1);
  530. #if ENABLED(LCD_PROGRESS_BAR)
  531. // Draw the progress bar if the message has shown long enough
  532. // or if there is no message set.
  533. if (ELAPSED(millis(), progress_bar_ms + PROGRESS_BAR_MSG_TIME) || !has_status()) {
  534. const uint8_t progress = get_progress_percent();
  535. if (progress > 2) return draw_progress_bar(progress);
  536. }
  537. #elif BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
  538. // Alternate Status message and Filament display
  539. if (ELAPSED(millis(), next_filament_display)) {
  540. lcd_put_u8str_P(PSTR("Dia "));
  541. lcd_put_u8str(ftostr12ns(filwidth.measured_mm));
  542. lcd_put_u8str_P(PSTR(" V"));
  543. lcd_put_u8str(i16tostr3rj(planner.volumetric_percent(parser.volumetric_enabled)));
  544. lcd_put_wchar('%');
  545. return;
  546. }
  547. #endif // FILAMENT_LCD_DISPLAY && SDSUPPORT
  548. #if ENABLED(STATUS_MESSAGE_SCROLLING)
  549. static bool last_blink = false;
  550. // Get the UTF8 character count of the string
  551. uint8_t slen = utf8_strlen(status_message);
  552. // If the string fits into the LCD, just print it and do not scroll it
  553. if (slen <= LCD_WIDTH) {
  554. // The string isn't scrolling and may not fill the screen
  555. lcd_put_u8str(status_message);
  556. // Fill the rest with spaces
  557. while (slen < LCD_WIDTH) { lcd_put_wchar(' '); ++slen; }
  558. }
  559. else {
  560. // String is larger than the available space in screen.
  561. // Get a pointer to the next valid UTF8 character
  562. // and the string remaining length
  563. uint8_t rlen;
  564. const char *stat = status_and_len(rlen);
  565. lcd_put_u8str_max(stat, LCD_WIDTH); // The string leaves space
  566. // If the remaining string doesn't completely fill the screen
  567. if (rlen < LCD_WIDTH) {
  568. lcd_put_wchar('.'); // Always at 1+ spaces left, draw a dot
  569. uint8_t chars = LCD_WIDTH - rlen; // Amount of space left in characters
  570. if (--chars) { // Draw a second dot if there's space
  571. lcd_put_wchar('.');
  572. if (--chars)
  573. lcd_put_u8str_max(status_message, chars); // Print a second copy of the message
  574. }
  575. }
  576. if (last_blink != blink) {
  577. last_blink = blink;
  578. advance_status_scroll();
  579. }
  580. }
  581. #else
  582. UNUSED(blink);
  583. // Get the UTF8 character count of the string
  584. uint8_t slen = utf8_strlen(status_message);
  585. // Just print the string to the LCD
  586. lcd_put_u8str_max(status_message, LCD_WIDTH);
  587. // Fill the rest with spaces if there are missing spaces
  588. while (slen < LCD_WIDTH) {
  589. lcd_put_wchar(' ');
  590. ++slen;
  591. }
  592. #endif
  593. }
  594. /**
  595. * LCD_INFO_SCREEN_STYLE 0 : Classic Status Screen
  596. *
  597. * 16x2 |000/000 B000/000|
  598. * |0123456789012345|
  599. *
  600. * 16x4 |000/000 B000/000|
  601. * |SD---% Z 000.00|
  602. * |F---% T--:--|
  603. * |0123456789012345|
  604. *
  605. * 20x2 |T000/000° B000/000° |
  606. * |01234567890123456789|
  607. *
  608. * 20x4 |T000/000° B000/000° |
  609. * |X 000 Y 000 Z000.000|
  610. * |F---% SD---% T--:--|
  611. * |01234567890123456789|
  612. *
  613. * LCD_INFO_SCREEN_STYLE 1 : Průša-style Status Screen
  614. *
  615. * |T000/000° Z 000.00 |
  616. * |B000/000° F---% |
  617. * |SD---% T--:-- |
  618. * |01234567890123456789|
  619. *
  620. * |T000/000° Z 000.00 |
  621. * |T000/000° F---% |
  622. * |B000/000° SD---% |
  623. * |01234567890123456789|
  624. */
  625. void MarlinUI::draw_status_screen() {
  626. const bool blink = get_blink();
  627. lcd_moveto(0, 0);
  628. #if LCD_INFO_SCREEN_STYLE == 0
  629. // ========== Line 1 ==========
  630. #if LCD_WIDTH < 20
  631. //
  632. // Hotend 0 Temperature
  633. //
  634. _draw_heater_status(H_E0, -1, blink);
  635. //
  636. // Hotend 1 or Bed Temperature
  637. //
  638. #if HAS_MULTI_HOTEND
  639. lcd_moveto(8, 0);
  640. _draw_heater_status(H_E1, LCD_STR_THERMOMETER[0], blink);
  641. #elif HAS_HEATED_BED
  642. lcd_moveto(8, 0);
  643. _draw_bed_status(blink);
  644. #endif
  645. #else // LCD_WIDTH >= 20
  646. //
  647. // Hotend 0 Temperature
  648. //
  649. _draw_heater_status(H_E0, LCD_STR_THERMOMETER[0], blink);
  650. //
  651. // Hotend 1 or Bed Temperature
  652. //
  653. #if HAS_MULTI_HOTEND
  654. lcd_moveto(10, 0);
  655. _draw_heater_status(H_E1, LCD_STR_THERMOMETER[0], blink);
  656. #elif HAS_HEATED_BED
  657. lcd_moveto(10, 0);
  658. _draw_bed_status(blink);
  659. #endif
  660. #endif // LCD_WIDTH >= 20
  661. // ========== Line 2 ==========
  662. #if LCD_HEIGHT > 2
  663. #if LCD_WIDTH < 20
  664. #if HAS_PRINT_PROGRESS
  665. lcd_moveto(0, 2);
  666. _draw_print_progress();
  667. #endif
  668. #else // LCD_WIDTH >= 20
  669. lcd_moveto(0, 1);
  670. // If the first line has two extruder temps,
  671. // show more temperatures on the next line
  672. #if HOTENDS > 2 || (HAS_MULTI_HOTEND && HAS_HEATED_BED)
  673. #if HOTENDS > 2
  674. _draw_heater_status(H_E2, LCD_STR_THERMOMETER[0], blink);
  675. lcd_moveto(10, 1);
  676. #endif
  677. _draw_bed_status(blink);
  678. #else // HOTENDS <= 2 && (HOTENDS <= 1 || !HAS_HEATED_BED)
  679. #if HAS_DUAL_MIXING
  680. // Two-component mix / gradient instead of XY
  681. char mixer_messages[12];
  682. const char *mix_label;
  683. #if ENABLED(GRADIENT_MIX)
  684. if (mixer.gradient.enabled) {
  685. mixer.update_mix_from_gradient();
  686. mix_label = "Gr";
  687. }
  688. else
  689. #endif
  690. {
  691. mixer.update_mix_from_vtool();
  692. mix_label = "Mx";
  693. }
  694. sprintf_P(mixer_messages, PSTR("%s %d;%d%% "), mix_label, int(mixer.mix[0]), int(mixer.mix[1]));
  695. lcd_put_u8str(mixer_messages);
  696. #else // !HAS_DUAL_MIXING
  697. if (TERN1(LCD_SHOW_E_TOTAL, !printingIsActive())) {
  698. const xy_pos_t lpos = current_position.asLogical();
  699. _draw_axis_value(X_AXIS, ftostr4sign(lpos.x), blink);
  700. lcd_put_wchar(' ');
  701. _draw_axis_value(Y_AXIS, ftostr4sign(lpos.y), blink);
  702. }
  703. else {
  704. #if ENABLED(LCD_SHOW_E_TOTAL)
  705. char tmp[20];
  706. const uint8_t escale = e_move_accumulator >= 100000.0f ? 10 : 1; // After 100m switch to cm
  707. sprintf_P(tmp, PSTR("E %ld%cm "), uint32_t(_MAX(e_move_accumulator, 0.0f)) / escale, escale == 10 ? 'c' : 'm'); // 1234567mm
  708. lcd_put_u8str(tmp);
  709. #endif
  710. }
  711. #endif // !HAS_DUAL_MIXING
  712. #endif // HOTENDS <= 2 && (HOTENDS <= 1 || !HAS_HEATED_BED)
  713. #endif // LCD_WIDTH >= 20
  714. lcd_moveto(LCD_WIDTH - 8, 1);
  715. _draw_axis_value(Z_AXIS, ftostr52sp(LOGICAL_Z_POSITION(current_position.z)), blink);
  716. #if HAS_LEVELING && !HAS_HEATED_BED
  717. lcd_put_wchar(planner.leveling_active || blink ? '_' : ' ');
  718. #endif
  719. #endif // LCD_HEIGHT > 2
  720. // ========== Line 3 ==========
  721. #if LCD_HEIGHT > 3
  722. lcd_put_wchar(0, 2, LCD_STR_FEEDRATE[0]);
  723. lcd_put_u8str(i16tostr3rj(feedrate_percentage));
  724. lcd_put_wchar('%');
  725. char buffer[14];
  726. duration_t elapsed = print_job_timer.duration();
  727. const uint8_t len = elapsed.toDigital(buffer),
  728. timepos = LCD_WIDTH - len - 1;
  729. lcd_put_wchar(timepos, 2, LCD_STR_CLOCK[0]);
  730. lcd_put_u8str(buffer);
  731. #if LCD_WIDTH >= 20
  732. lcd_moveto(timepos - 7, 2);
  733. #if HAS_PRINT_PROGRESS
  734. _draw_print_progress();
  735. #else
  736. char c;
  737. uint16_t per;
  738. #if HAS_FAN0
  739. if (true
  740. #if EXTRUDERS && ENABLED(ADAPTIVE_FAN_SLOWING)
  741. && (blink || thermalManager.fan_speed_scaler[0] < 128)
  742. #endif
  743. ) {
  744. uint16_t spd = thermalManager.fan_speed[0];
  745. if (blink) c = 'F';
  746. #if ENABLED(ADAPTIVE_FAN_SLOWING)
  747. else { c = '*'; spd = thermalManager.scaledFanSpeed(0, spd); }
  748. #endif
  749. per = thermalManager.fanPercent(spd);
  750. }
  751. else
  752. #endif
  753. {
  754. #if EXTRUDERS
  755. c = 'E';
  756. per = planner.flow_percentage[0];
  757. #endif
  758. }
  759. lcd_put_wchar(c);
  760. lcd_put_u8str(i16tostr3rj(per));
  761. lcd_put_wchar('%');
  762. #endif
  763. #endif
  764. #endif // LCD_HEIGHT > 3
  765. #elif LCD_INFO_SCREEN_STYLE == 1
  766. // ========== Line 1 ==========
  767. //
  768. // Hotend 0 Temperature
  769. //
  770. _draw_heater_status(H_E0, LCD_STR_THERMOMETER[0], blink);
  771. //
  772. // Z Coordinate
  773. //
  774. lcd_moveto(LCD_WIDTH - 9, 0);
  775. _draw_axis_value(Z_AXIS, ftostr52sp(LOGICAL_Z_POSITION(current_position.z)), blink);
  776. #if HAS_LEVELING && (HAS_MULTI_HOTEND || !HAS_HEATED_BED)
  777. lcd_put_wchar(LCD_WIDTH - 1, 0, planner.leveling_active || blink ? '_' : ' ');
  778. #endif
  779. // ========== Line 2 ==========
  780. //
  781. // Hotend 1 or Bed Temperature
  782. //
  783. lcd_moveto(0, 1);
  784. #if HAS_MULTI_HOTEND
  785. _draw_heater_status(H_E1, LCD_STR_THERMOMETER[0], blink);
  786. #elif HAS_HEATED_BED
  787. _draw_bed_status(blink);
  788. #endif
  789. lcd_put_wchar(LCD_WIDTH - 9, 1, LCD_STR_FEEDRATE[0]);
  790. lcd_put_u8str(i16tostr3rj(feedrate_percentage));
  791. lcd_put_wchar('%');
  792. // ========== Line 3 ==========
  793. //
  794. // SD Percent, Hotend 2, or Bed
  795. //
  796. lcd_moveto(0, 2);
  797. #if HOTENDS > 2
  798. _draw_heater_status(H_E2, LCD_STR_THERMOMETER[0], blink);
  799. #elif HAS_MULTI_HOTEND && HAS_HEATED_BED
  800. _draw_bed_status(blink);
  801. #elif HAS_PRINT_PROGRESS
  802. #define DREW_PRINT_PROGRESS
  803. _draw_print_progress();
  804. #endif
  805. //
  806. // Elapsed Time or SD Percent
  807. //
  808. lcd_moveto(LCD_WIDTH - 9, 2);
  809. #if HAS_PRINT_PROGRESS && !defined(DREW_PRINT_PROGRESS)
  810. _draw_print_progress();
  811. #else
  812. duration_t elapsed = print_job_timer.duration();
  813. char buffer[14];
  814. (void)elapsed.toDigital(buffer);
  815. lcd_put_wchar(LCD_STR_CLOCK[0]);
  816. lcd_put_u8str(buffer);
  817. #endif
  818. #endif // LCD_INFO_SCREEN_STYLE 1
  819. // ========= Last Line ========
  820. //
  821. // Status Message (which may be a Progress Bar or Filament display)
  822. //
  823. draw_status_message(blink);
  824. }
  825. #if HAS_LCD_MENU
  826. #include "../menu/menu.h"
  827. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  828. void MarlinUI::draw_hotend_status(const uint8_t row, const uint8_t extruder) {
  829. if (row < LCD_HEIGHT) {
  830. lcd_moveto(LCD_WIDTH - 9, row);
  831. _draw_heater_status((heater_ind_t)extruder, LCD_STR_THERMOMETER[0], get_blink());
  832. }
  833. }
  834. #endif // ADVANCED_PAUSE_FEATURE
  835. // Draw a static item with no left-right margin required. Centered by default.
  836. void MenuItem_static::draw(const uint8_t row, PGM_P const pstr, const uint8_t style/*=SS_DEFAULT*/, const char * const valstr/*=nullptr*/) {
  837. int8_t n = LCD_WIDTH;
  838. lcd_moveto(0, row);
  839. if ((style & SS_CENTER) && !valstr) {
  840. int8_t pad = (LCD_WIDTH - utf8_strlen_P(pstr)) / 2;
  841. while (--pad >= 0) { lcd_put_wchar(' '); n--; }
  842. }
  843. n = lcd_put_u8str_ind_P(pstr, itemIndex, n);
  844. if (valstr) n -= lcd_put_u8str_max(valstr, n);
  845. for (; n > 0; --n) lcd_put_wchar(' ');
  846. }
  847. // Draw a generic menu item with pre_char (if selected) and post_char
  848. void MenuItemBase::_draw(const bool sel, const uint8_t row, PGM_P const pstr, const char pre_char, const char post_char) {
  849. lcd_put_wchar(0, row, sel ? pre_char : ' ');
  850. uint8_t n = lcd_put_u8str_ind_P(pstr, itemIndex, LCD_WIDTH - 2);
  851. for (; n; --n) lcd_put_wchar(' ');
  852. lcd_put_wchar(post_char);
  853. }
  854. // Draw a menu item with a (potentially) editable value
  855. void MenuEditItemBase::draw(const bool sel, const uint8_t row, PGM_P const pstr, const char* const data, const bool pgm) {
  856. const uint8_t vlen = data ? (pgm ? utf8_strlen_P(data) : utf8_strlen(data)) : 0;
  857. lcd_put_wchar(0, row, sel ? LCD_STR_ARROW_RIGHT[0] : ' ');
  858. uint8_t n = lcd_put_u8str_ind_P(pstr, itemIndex, LCD_WIDTH - 2 - vlen);
  859. if (vlen) {
  860. lcd_put_wchar(':');
  861. for (; n; --n) lcd_put_wchar(' ');
  862. if (pgm) lcd_put_u8str_P(data); else lcd_put_u8str(data);
  863. }
  864. }
  865. // Low-level draw_edit_screen can be used to draw an edit screen from anyplace
  866. void MenuEditItemBase::draw_edit_screen(PGM_P const pstr, const char* const value/*=nullptr*/) {
  867. ui.encoder_direction_normal();
  868. uint8_t n = lcd_put_u8str_ind_P(0, 1, pstr, itemIndex, LCD_WIDTH - 1);
  869. if (value != nullptr) {
  870. lcd_put_wchar(':');
  871. int len = utf8_strlen(value);
  872. const lcd_uint_t valrow = (n < len + 1) ? 2 : 1; // Value on the next row if it won't fit
  873. lcd_put_wchar((LCD_WIDTH - 1) - (len + 1), valrow, ' '); // Right-justified, padded, leading space
  874. lcd_put_u8str(value);
  875. }
  876. }
  877. // The Select Screen presents a prompt and two "buttons"
  878. void MenuItem_confirm::draw_select_screen(PGM_P const yes, PGM_P const no, const bool yesno, PGM_P const pref, const char * const string/*=nullptr*/, PGM_P const suff/*=nullptr*/) {
  879. ui.draw_select_screen_prompt(pref, string, suff);
  880. SETCURSOR(0, LCD_HEIGHT - 1);
  881. lcd_put_wchar(yesno ? ' ' : '['); lcd_put_u8str_P(no); lcd_put_wchar(yesno ? ' ' : ']');
  882. SETCURSOR_RJ(utf8_strlen_P(yes) + 2, LCD_HEIGHT - 1);
  883. lcd_put_wchar(yesno ? '[' : ' '); lcd_put_u8str_P(yes); lcd_put_wchar(yesno ? ']' : ' ');
  884. }
  885. #if ENABLED(SDSUPPORT)
  886. void MenuItem_sdbase::draw(const bool sel, const uint8_t row, PGM_P const, CardReader &theCard, const bool isDir) {
  887. lcd_put_wchar(0, row, sel ? LCD_STR_ARROW_RIGHT[0] : ' ');
  888. constexpr uint8_t maxlen = LCD_WIDTH - 2;
  889. uint8_t n = maxlen - lcd_put_u8str_max(ui.scrolled_filename(theCard, maxlen, row, sel), maxlen);
  890. for (; n; --n) lcd_put_wchar(' ');
  891. lcd_put_wchar(isDir ? LCD_STR_FOLDER[0] : ' ');
  892. }
  893. #endif
  894. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  895. void MarlinUI::update_indicators() {
  896. // Set the LEDS - referred to as backlights by the LiquidTWI2 library
  897. static uint8_t ledsprev = 0;
  898. uint8_t leds = 0;
  899. if (TERN0(HAS_HEATED_BED, thermalManager.degTargetBed() > 0)) leds |= LED_A;
  900. if (TERN0(HAS_HOTEND, thermalManager.degTargetHotend(0) > 0)) leds |= LED_B;
  901. #if HAS_FAN
  902. if ( TERN0(HAS_FAN0, thermalManager.fan_speed[0])
  903. || TERN0(HAS_FAN1, thermalManager.fan_speed[1])
  904. || TERN0(HAS_FAN2, thermalManager.fan_speed[2])
  905. || TERN0(HAS_FAN3, thermalManager.fan_speed[3])
  906. || TERN0(HAS_FAN4, thermalManager.fan_speed[4])
  907. || TERN0(HAS_FAN5, thermalManager.fan_speed[5])
  908. || TERN0(HAS_FAN6, thermalManager.fan_speed[6])
  909. || TERN0(HAS_FAN7, thermalManager.fan_speed[7])
  910. ) leds |= LED_C;
  911. #endif // HAS_FAN
  912. if (TERN0(HAS_MULTI_HOTEND, thermalManager.degTargetHotend(1) > 0)) leds |= LED_C;
  913. if (leds != ledsprev) {
  914. lcd.setBacklight(leds);
  915. ledsprev = leds;
  916. }
  917. }
  918. #endif // LCD_HAS_STATUS_INDICATORS
  919. #if ENABLED(AUTO_BED_LEVELING_UBL)
  920. #define HD44780_CHAR_WIDTH 5
  921. #define HD44780_CHAR_HEIGHT 8
  922. #define MESH_MAP_COLS 7
  923. #define MESH_MAP_ROWS 4
  924. #define CHAR_LINE_TOP 0
  925. #define CHAR_LINE_BOT 1
  926. #define CHAR_EDGE_L 2
  927. #define CHAR_EDGE_R 3
  928. #define CHAR_UL_UL 4
  929. #define CHAR_LR_UL 5
  930. #define CHAR_UL_LR 6
  931. #define CHAR_LR_LR 7
  932. #define TOP_LEFT _BV(0)
  933. #define TOP_RIGHT _BV(1)
  934. #define LOWER_LEFT _BV(2)
  935. #define LOWER_RIGHT _BV(3)
  936. /**
  937. * Possible map screens:
  938. *
  939. * 16x2 |X000.00 Y000.00|
  940. * |(00,00) Z00.000|
  941. *
  942. * 20x2 | X:000.00 Y:000.00 |
  943. * | (00,00) Z:00.000 |
  944. *
  945. * 16x4 |+-------+(00,00)|
  946. * || |X000.00|
  947. * || |Y000.00|
  948. * |+-------+Z00.000|
  949. *
  950. * 20x4 | +-------+ (00,00) |
  951. * | | | X:000.00|
  952. * | | | Y:000.00|
  953. * | +-------+ Z:00.000|
  954. */
  955. typedef struct {
  956. uint8_t custom_char_bits[HD44780_CHAR_HEIGHT];
  957. } custom_char;
  958. typedef struct {
  959. lcd_uint_t column, row,
  960. x_pixel_offset, y_pixel_offset;
  961. uint8_t x_pixel_mask;
  962. } coordinate;
  963. void add_edges_to_custom_char(custom_char &custom, const coordinate &ul, const coordinate &lr, const coordinate &brc, const uint8_t cell_location);
  964. FORCE_INLINE static void clear_custom_char(custom_char * const cc) { ZERO(cc->custom_char_bits); }
  965. coordinate pixel_location(int16_t x, int16_t y) {
  966. coordinate ret_val;
  967. int16_t xp, yp, r, c;
  968. x++; y++; // +1 because lines on the left and top
  969. c = x / (HD44780_CHAR_WIDTH);
  970. r = y / (HD44780_CHAR_HEIGHT);
  971. ret_val.column = c;
  972. ret_val.row = r;
  973. xp = x - c * (HD44780_CHAR_WIDTH); // Get the pixel offsets into the character cell
  974. xp = HD44780_CHAR_WIDTH - 1 - xp; // Column within relevant character cell (0 on the right)
  975. yp = y - r * (HD44780_CHAR_HEIGHT);
  976. ret_val.x_pixel_mask = _BV(xp);
  977. ret_val.x_pixel_offset = xp;
  978. ret_val.y_pixel_offset = yp;
  979. return ret_val;
  980. }
  981. inline coordinate pixel_location(const lcd_uint_t x, const lcd_uint_t y) { return pixel_location((int16_t)x, (int16_t)y); }
  982. void prep_and_put_map_char(custom_char &chrdata, const coordinate &ul, const coordinate &lr, const coordinate &brc, const uint8_t cl, const char c, const lcd_uint_t x, const lcd_uint_t y) {
  983. add_edges_to_custom_char(chrdata, ul, lr, brc, cl);
  984. lcd.createChar(c, (uint8_t*)&chrdata);
  985. lcd_put_wchar(x, y, c);
  986. }
  987. void MarlinUI::ubl_plot(const uint8_t x_plot, const uint8_t y_plot) {
  988. #if LCD_WIDTH >= 20
  989. #define _LCD_W_POS 12
  990. #define _PLOT_X 1
  991. #define _MAP_X 3
  992. #define _LABEL(C,X,Y) lcd_put_u8str_P(X, Y, C)
  993. #define _XLABEL(X,Y) _LABEL(X_LBL,X,Y)
  994. #define _YLABEL(X,Y) _LABEL(Y_LBL,X,Y)
  995. #define _ZLABEL(X,Y) _LABEL(Z_LBL,X,Y)
  996. #else
  997. #define _LCD_W_POS 8
  998. #define _PLOT_X 0
  999. #define _MAP_X 1
  1000. #define _LABEL(X,Y,C) lcd_put_wchar(X, Y, C)
  1001. #define _XLABEL(X,Y) _LABEL('X',X,Y)
  1002. #define _YLABEL(X,Y) _LABEL('Y',X,Y)
  1003. #define _ZLABEL(X,Y) _LABEL('Z',X,Y)
  1004. #endif
  1005. #if LCD_HEIGHT <= 3 // 16x2 or 20x2 display
  1006. /**
  1007. * Show X and Y positions
  1008. */
  1009. _XLABEL(_PLOT_X, 0);
  1010. lcd_put_u8str(ftostr52(LOGICAL_X_POSITION(ubl.mesh_index_to_xpos(x_plot))));
  1011. _YLABEL(_LCD_W_POS, 0);
  1012. lcd_put_u8str(ftostr52(LOGICAL_Y_POSITION(ubl.mesh_index_to_ypos(y_plot))));
  1013. lcd_moveto(_PLOT_X, 0);
  1014. #else // 16x4 or 20x4 display
  1015. coordinate upper_left, lower_right, bottom_right_corner;
  1016. custom_char new_char;
  1017. uint8_t i, n, n_rows, n_cols;
  1018. lcd_uint_t j, k, l, m, bottom_line, right_edge,
  1019. x_map_pixels, y_map_pixels,
  1020. pixels_per_x_mesh_pnt, pixels_per_y_mesh_pnt,
  1021. suppress_x_offset = 0, suppress_y_offset = 0;
  1022. const uint8_t y_plot_inv = (GRID_MAX_POINTS_Y - 1) - y_plot;
  1023. upper_left.column = 0;
  1024. upper_left.row = 0;
  1025. lower_right.column = 0;
  1026. lower_right.row = 0;
  1027. clear_lcd();
  1028. x_map_pixels = (HD44780_CHAR_WIDTH) * (MESH_MAP_COLS) - 2; // Minus 2 because we are drawing a box around the map
  1029. y_map_pixels = (HD44780_CHAR_HEIGHT) * (MESH_MAP_ROWS) - 2;
  1030. pixels_per_x_mesh_pnt = x_map_pixels / (GRID_MAX_POINTS_X);
  1031. pixels_per_y_mesh_pnt = y_map_pixels / (GRID_MAX_POINTS_Y);
  1032. if (pixels_per_x_mesh_pnt >= HD44780_CHAR_WIDTH) { // There are only 2 custom characters available, so the X
  1033. pixels_per_x_mesh_pnt = HD44780_CHAR_WIDTH; // Size of the mesh point needs to fit within them independent
  1034. suppress_x_offset = 1; // Of where the starting pixel is located.
  1035. }
  1036. if (pixels_per_y_mesh_pnt >= HD44780_CHAR_HEIGHT) { // There are only 2 custom characters available, so the Y
  1037. pixels_per_y_mesh_pnt = HD44780_CHAR_HEIGHT; // Size of the mesh point needs to fit within them independent
  1038. suppress_y_offset = 1; // Of where the starting pixel is located.
  1039. }
  1040. x_map_pixels = pixels_per_x_mesh_pnt * (GRID_MAX_POINTS_X); // Now we have the right number of pixels to make both
  1041. y_map_pixels = pixels_per_y_mesh_pnt * (GRID_MAX_POINTS_Y); // Directions fit nicely
  1042. right_edge = pixels_per_x_mesh_pnt * (GRID_MAX_POINTS_X) + 1; // Find location of right edge within the character cell
  1043. bottom_line = pixels_per_y_mesh_pnt * (GRID_MAX_POINTS_Y) + 1; // Find location of bottome line within the character cell
  1044. n_rows = bottom_line / (HD44780_CHAR_HEIGHT) + 1;
  1045. n_cols = right_edge / (HD44780_CHAR_WIDTH) + 1;
  1046. for (i = 0; i < n_cols; i++) {
  1047. lcd_put_wchar(i, 0, CHAR_LINE_TOP); // Box Top line
  1048. lcd_put_wchar(i, n_rows - 1, CHAR_LINE_BOT); // Box Bottom line
  1049. }
  1050. for (j = 0; j < n_rows; j++) {
  1051. lcd_put_wchar(0, j, CHAR_EDGE_L); // Box Left edge
  1052. lcd_put_wchar(n_cols - 1, j, CHAR_EDGE_R); // Box Right edge
  1053. }
  1054. /**
  1055. * If the entire 4th row is not in use, do not put vertical bars all the way down to the bottom of the display
  1056. */
  1057. k = pixels_per_y_mesh_pnt * (GRID_MAX_POINTS_Y) + 2;
  1058. l = (HD44780_CHAR_HEIGHT) * n_rows;
  1059. if (l > k && l - k >= (HD44780_CHAR_HEIGHT) / 2) {
  1060. lcd_put_wchar(0, n_rows - 1, ' '); // Box Left edge
  1061. lcd_put_wchar(n_cols - 1, n_rows - 1, ' '); // Box Right edge
  1062. }
  1063. clear_custom_char(&new_char);
  1064. new_char.custom_char_bits[0] = 0b11111U; // Char #0 is used for the box top line
  1065. lcd.createChar(CHAR_LINE_TOP, (uint8_t*)&new_char);
  1066. clear_custom_char(&new_char);
  1067. k = (GRID_MAX_POINTS_Y) * pixels_per_y_mesh_pnt + 1; // Row of pixels for the bottom box line
  1068. l = k % (HD44780_CHAR_HEIGHT); // Row within relevant character cell
  1069. new_char.custom_char_bits[l] = 0b11111U; // Char #1 is used for the box bottom line
  1070. lcd.createChar(CHAR_LINE_BOT, (uint8_t*)&new_char);
  1071. clear_custom_char(&new_char);
  1072. for (j = 0; j < HD44780_CHAR_HEIGHT; j++)
  1073. new_char.custom_char_bits[j] = 0b10000U; // Char #2 is used for the box left edge
  1074. lcd.createChar(CHAR_EDGE_L, (uint8_t*)&new_char);
  1075. clear_custom_char(&new_char);
  1076. m = (GRID_MAX_POINTS_X) * pixels_per_x_mesh_pnt + 1; // Column of pixels for the right box line
  1077. n = m % (HD44780_CHAR_WIDTH); // Column within relevant character cell
  1078. i = HD44780_CHAR_WIDTH - 1 - n; // Column within relevant character cell (0 on the right)
  1079. for (j = 0; j < HD44780_CHAR_HEIGHT; j++)
  1080. new_char.custom_char_bits[j] = (uint8_t)_BV(i); // Char #3 is used for the box right edge
  1081. lcd.createChar(CHAR_EDGE_R, (uint8_t*)&new_char);
  1082. i = x_plot * pixels_per_x_mesh_pnt - suppress_x_offset;
  1083. j = y_plot_inv * pixels_per_y_mesh_pnt - suppress_y_offset;
  1084. upper_left = pixel_location(i, j);
  1085. k = (x_plot + 1) * pixels_per_x_mesh_pnt - 1 - suppress_x_offset;
  1086. l = (y_plot_inv + 1) * pixels_per_y_mesh_pnt - 1 - suppress_y_offset;
  1087. lower_right = pixel_location(k, l);
  1088. bottom_right_corner = pixel_location(x_map_pixels, y_map_pixels);
  1089. /**
  1090. * First, handle the simple case where everything is within a single character cell.
  1091. * If part of the Mesh Plot is outside of this character cell, we will follow up
  1092. * and deal with that next.
  1093. */
  1094. clear_custom_char(&new_char);
  1095. const lcd_uint_t ypix = _MIN(upper_left.y_pixel_offset + pixels_per_y_mesh_pnt, HD44780_CHAR_HEIGHT);
  1096. for (j = upper_left.y_pixel_offset; j < ypix; j++) {
  1097. i = upper_left.x_pixel_mask;
  1098. for (k = 0; k < pixels_per_x_mesh_pnt; k++) {
  1099. new_char.custom_char_bits[j] |= i;
  1100. i >>= 1;
  1101. }
  1102. }
  1103. prep_and_put_map_char(new_char, upper_left, lower_right, bottom_right_corner, TOP_LEFT, CHAR_UL_UL, upper_left.column, upper_left.row);
  1104. /**
  1105. * Next, check for two side by side character cells being used to display the Mesh Point
  1106. * If found... do the right hand character cell next.
  1107. */
  1108. if (upper_left.column == lower_right.column - 1) {
  1109. l = upper_left.x_pixel_offset;
  1110. clear_custom_char(&new_char);
  1111. for (j = upper_left.y_pixel_offset; j < ypix; j++) {
  1112. i = _BV(HD44780_CHAR_WIDTH - 1); // Fill in the left side of the right character cell
  1113. for (k = 0; k < pixels_per_x_mesh_pnt - 1 - l; k++) {
  1114. new_char.custom_char_bits[j] |= i;
  1115. i >>= 1;
  1116. }
  1117. }
  1118. prep_and_put_map_char(new_char, upper_left, lower_right, bottom_right_corner, TOP_RIGHT, CHAR_LR_UL, lower_right.column, upper_left.row);
  1119. }
  1120. /**
  1121. * Next, check for two character cells stacked on top of each other being used to display the Mesh Point
  1122. */
  1123. if (upper_left.row == lower_right.row - 1) {
  1124. l = HD44780_CHAR_HEIGHT - upper_left.y_pixel_offset; // Number of pixel rows in top character cell
  1125. k = pixels_per_y_mesh_pnt - l; // Number of pixel rows in bottom character cell
  1126. clear_custom_char(&new_char);
  1127. for (j = 0; j < k; j++) {
  1128. i = upper_left.x_pixel_mask;
  1129. for (m = 0; m < pixels_per_x_mesh_pnt; m++) { // Fill in the top side of the bottom character cell
  1130. new_char.custom_char_bits[j] |= i;
  1131. if (!(i >>= 1)) break;
  1132. }
  1133. }
  1134. prep_and_put_map_char(new_char, upper_left, lower_right, bottom_right_corner, LOWER_LEFT, CHAR_UL_LR, upper_left.column, lower_right.row);
  1135. }
  1136. /**
  1137. * Next, check for four character cells being used to display the Mesh Point. If that is
  1138. * what is here, we work to fill in the character cell that is down one and to the right one
  1139. * from the upper_left character cell.
  1140. */
  1141. if (upper_left.column == lower_right.column - 1 && upper_left.row == lower_right.row - 1) {
  1142. l = HD44780_CHAR_HEIGHT - upper_left.y_pixel_offset; // Number of pixel rows in top character cell
  1143. k = pixels_per_y_mesh_pnt - l; // Number of pixel rows in bottom character cell
  1144. clear_custom_char(&new_char);
  1145. for (j = 0; j < k; j++) {
  1146. l = upper_left.x_pixel_offset;
  1147. i = _BV(HD44780_CHAR_WIDTH - 1); // Fill in the left side of the right character cell
  1148. for (m = 0; m < pixels_per_x_mesh_pnt - 1 - l; m++) { // Fill in the top side of the bottom character cell
  1149. new_char.custom_char_bits[j] |= i;
  1150. i >>= 1;
  1151. }
  1152. }
  1153. prep_and_put_map_char(new_char, upper_left, lower_right, bottom_right_corner, LOWER_RIGHT, CHAR_LR_LR, lower_right.column, lower_right.row);
  1154. }
  1155. #endif
  1156. /**
  1157. * Print plot position
  1158. */
  1159. lcd_put_wchar(_LCD_W_POS, 0, '(');
  1160. lcd_put_u8str(ui8tostr3rj(x_plot));
  1161. lcd_put_wchar(',');
  1162. lcd_put_u8str(ui8tostr3rj(y_plot));
  1163. lcd_put_wchar(')');
  1164. #if LCD_HEIGHT <= 3 // 16x2 or 20x2 display
  1165. /**
  1166. * Print Z values
  1167. */
  1168. _ZLABEL(_LCD_W_POS, 1);
  1169. if (!isnan(ubl.z_values[x_plot][y_plot]))
  1170. lcd_put_u8str(ftostr43sign(ubl.z_values[x_plot][y_plot]));
  1171. else
  1172. lcd_put_u8str_P(PSTR(" -----"));
  1173. #else // 16x4 or 20x4 display
  1174. /**
  1175. * Show all values at right of screen
  1176. */
  1177. _XLABEL(_LCD_W_POS, 1);
  1178. lcd_put_u8str(ftostr52(LOGICAL_X_POSITION(ubl.mesh_index_to_xpos(x_plot))));
  1179. _YLABEL(_LCD_W_POS, 2);
  1180. lcd_put_u8str(ftostr52(LOGICAL_Y_POSITION(ubl.mesh_index_to_ypos(y_plot))));
  1181. /**
  1182. * Show the location value
  1183. */
  1184. _ZLABEL(_LCD_W_POS, 3);
  1185. if (!isnan(ubl.z_values[x_plot][y_plot]))
  1186. lcd_put_u8str(ftostr43sign(ubl.z_values[x_plot][y_plot]));
  1187. else
  1188. lcd_put_u8str_P(PSTR(" -----"));
  1189. #endif // LCD_HEIGHT > 3
  1190. }
  1191. void add_edges_to_custom_char(custom_char &custom, const coordinate &ul, const coordinate &lr, const coordinate &brc, const uint8_t cell_location) {
  1192. uint8_t i, k;
  1193. int16_t n_rows = lr.row - ul.row + 1,
  1194. n_cols = lr.column - ul.column + 1;
  1195. /**
  1196. * Check if Top line of box needs to be filled in
  1197. */
  1198. if (ul.row == 0 && (cell_location & (TOP_LEFT|TOP_RIGHT))) { // Only fill in the top line for the top character cells
  1199. if (n_cols == 1) {
  1200. if (ul.column != brc.column)
  1201. custom.custom_char_bits[0] = 0xFF; // Single column in middle
  1202. else
  1203. for (i = brc.x_pixel_offset; i < HD44780_CHAR_WIDTH; i++) // Single column on right side
  1204. SBI(custom.custom_char_bits[0], i);
  1205. }
  1206. else if ((cell_location & TOP_LEFT) || lr.column != brc.column) // Multiple column in the middle or with right cell in middle
  1207. custom.custom_char_bits[0] = 0xFF;
  1208. else
  1209. for (i = brc.x_pixel_offset; i < HD44780_CHAR_WIDTH; i++)
  1210. SBI(custom.custom_char_bits[0], i);
  1211. }
  1212. /**
  1213. * Check if left line of box needs to be filled in
  1214. */
  1215. if (cell_location & (TOP_LEFT|LOWER_LEFT)) {
  1216. if (ul.column == 0) { // Left column of characters on LCD Display
  1217. k = ul.row == brc.row ? brc.y_pixel_offset : HD44780_CHAR_HEIGHT; // If it isn't the last row... do the full character cell
  1218. for (i = 0; i < k; i++)
  1219. SBI(custom.custom_char_bits[i], HD44780_CHAR_WIDTH - 1);
  1220. }
  1221. }
  1222. /**
  1223. * Check if bottom line of box needs to be filled in
  1224. */
  1225. // Single row of mesh plot cells
  1226. if (n_rows == 1 /* && (cell_location & (TOP_LEFT|TOP_RIGHT)) */ && ul.row == brc.row) {
  1227. if (n_cols == 1) // Single row, single column case
  1228. k = ul.column == brc.column ? brc.x_pixel_mask : 0x01;
  1229. else if (cell_location & TOP_RIGHT) // Single row, multiple column case
  1230. k = lr.column == brc.column ? brc.x_pixel_mask : 0x01;
  1231. else // Single row, left of multiple columns
  1232. k = 0x01;
  1233. while (k < _BV(HD44780_CHAR_WIDTH)) {
  1234. custom.custom_char_bits[brc.y_pixel_offset] |= k;
  1235. k <<= 1;
  1236. }
  1237. }
  1238. // Double row of characters on LCD Display
  1239. // And this is a bottom custom character
  1240. if (n_rows == 2 && (cell_location & (LOWER_LEFT|LOWER_RIGHT)) && lr.row == brc.row) {
  1241. if (n_cols == 1) // Double row, single column case
  1242. k = ul.column == brc.column ? brc.x_pixel_mask : 0x01;
  1243. else if (cell_location & LOWER_RIGHT) // Double row, multiple column case
  1244. k = lr.column == brc.column ? brc.x_pixel_mask : 0x01;
  1245. else // Double row, left of multiple columns
  1246. k = 0x01;
  1247. while (k < _BV(HD44780_CHAR_WIDTH)) {
  1248. custom.custom_char_bits[brc.y_pixel_offset] |= k;
  1249. k <<= 1;
  1250. }
  1251. }
  1252. /**
  1253. * Check if right line of box needs to be filled in
  1254. */
  1255. // Nothing to do if the lower right part of the mesh pnt isn't in the same column as the box line
  1256. if (lr.column == brc.column) {
  1257. // This mesh point is in the same character cell as the right box line
  1258. if (ul.column == brc.column || (cell_location & (TOP_RIGHT|LOWER_RIGHT))) {
  1259. // If not the last row... do the full character cell
  1260. k = ul.row == brc.row ? brc.y_pixel_offset : HD44780_CHAR_HEIGHT;
  1261. for (i = 0; i < k; i++) custom.custom_char_bits[i] |= brc.x_pixel_mask;
  1262. }
  1263. }
  1264. }
  1265. #endif // AUTO_BED_LEVELING_UBL
  1266. #endif // HAS_LCD_MENU
  1267. #endif // HAS_CHARACTER_LCD