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.

marlinui_HD44780.cpp 48KB

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