My Marlin configs for Fabrikator Mini and CTC i3 Pro B
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

ultralcd_HD44780.cpp 47KB

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