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

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