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_impl_HD44780.h 50KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565
  1. /**
  2. * Marlin 3D Printer Firmware
  3. * Copyright (C) 2016 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
  4. *
  5. * Based on Sprinter and grbl.
  6. * Copyright (C) 2011 Camiel Gubbels / Erik van der Zalm
  7. *
  8. * This program is free software: you can redistribute it and/or modify
  9. * it under the terms of the GNU General Public License as published by
  10. * the Free Software Foundation, either version 3 of the License, or
  11. * (at your option) any later version.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU General Public License
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  20. *
  21. */
  22. #ifndef ULTRALCD_IMPL_HD44780_H
  23. #define ULTRALCD_IMPL_HD44780_H
  24. /**
  25. * Implementation of the LCD display routines for a Hitachi HD44780 display.
  26. * These are the most common LCD character displays.
  27. */
  28. #include "utility.h"
  29. #include "duration_t.h"
  30. #if ENABLED(AUTO_BED_LEVELING_UBL)
  31. #include "ubl.h"
  32. #if ENABLED(ULTIPANEL)
  33. #define ULTRA_X_PIXELS_PER_CHAR 5
  34. #define ULTRA_Y_PIXELS_PER_CHAR 8
  35. #define ULTRA_COLUMNS_FOR_MESH_MAP 7
  36. #define ULTRA_ROWS_FOR_MESH_MAP 4
  37. #define N_USER_CHARS 8
  38. #define TOP_LEFT _BV(0)
  39. #define TOP_RIGHT _BV(1)
  40. #define LOWER_LEFT _BV(2)
  41. #define LOWER_RIGHT _BV(3)
  42. #endif
  43. #endif
  44. extern volatile uint8_t buttons; //an extended version of the last checked buttons in a bit array.
  45. ////////////////////////////////////
  46. // Setup button and encode mappings for each panel (into 'buttons' variable
  47. //
  48. // This is just to map common functions (across different panels) onto the same
  49. // macro name. The mapping is independent of whether the button is directly connected or
  50. // via a shift/i2c register.
  51. #if ENABLED(ULTIPANEL)
  52. //
  53. // Setup other button mappings of each panel
  54. //
  55. #if ENABLED(LCD_I2C_VIKI)
  56. #define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
  57. // button and encoder bit positions within 'buttons'
  58. #define B_LE (BUTTON_LEFT<<B_I2C_BTN_OFFSET) // The remaining normalized buttons are all read via I2C
  59. #define B_UP (BUTTON_UP<<B_I2C_BTN_OFFSET)
  60. #define B_MI (BUTTON_SELECT<<B_I2C_BTN_OFFSET)
  61. #define B_DW (BUTTON_DOWN<<B_I2C_BTN_OFFSET)
  62. #define B_RI (BUTTON_RIGHT<<B_I2C_BTN_OFFSET)
  63. #if BUTTON_EXISTS(ENC)
  64. // the pause/stop/restart button is connected to BTN_ENC when used
  65. #define B_ST (EN_C) // Map the pause/stop/resume button into its normalized functional name
  66. #undef LCD_CLICKED
  67. #define LCD_CLICKED (buttons&(B_MI|B_RI|B_ST)) // pause/stop button also acts as click until we implement proper pause/stop.
  68. #else
  69. #undef LCD_CLICKED
  70. #define LCD_CLICKED (buttons&(B_MI|B_RI))
  71. #endif
  72. // I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
  73. #define LCD_HAS_SLOW_BUTTONS
  74. #elif ENABLED(LCD_I2C_PANELOLU2)
  75. #if !BUTTON_EXISTS(ENC) // Use I2C if not directly connected to a pin
  76. #define B_I2C_BTN_OFFSET 3 // (the first three bit positions reserved for EN_A, EN_B, EN_C)
  77. #define B_MI (PANELOLU2_ENCODER_C<<B_I2C_BTN_OFFSET) // requires LiquidTWI2 library v1.2.3 or later
  78. #undef LCD_CLICKED
  79. #define LCD_CLICKED (buttons & B_MI)
  80. // I2C buttons take too long to read inside an interrupt context and so we read them during lcd_update
  81. #define LCD_HAS_SLOW_BUTTONS
  82. #endif
  83. #elif DISABLED(NEWPANEL) // old style ULTIPANEL
  84. // Shift register bits correspond to buttons:
  85. #define BL_LE 7 // Left
  86. #define BL_UP 6 // Up
  87. #define BL_MI 5 // Middle
  88. #define BL_DW 4 // Down
  89. #define BL_RI 3 // Right
  90. #define BL_ST 2 // Red Button
  91. #define B_LE (_BV(BL_LE))
  92. #define B_UP (_BV(BL_UP))
  93. #define B_MI (_BV(BL_MI))
  94. #define B_DW (_BV(BL_DW))
  95. #define B_RI (_BV(BL_RI))
  96. #define B_ST (_BV(BL_ST))
  97. #define LCD_CLICKED ((buttons & B_MI) || (buttons & B_ST))
  98. #endif
  99. #endif // ULTIPANEL
  100. ////////////////////////////////////
  101. // Create LCD class instance and chipset-specific information
  102. #if ENABLED(LCD_I2C_TYPE_PCF8575)
  103. // note: these are register mapped pins on the PCF8575 controller not Arduino pins
  104. #define LCD_I2C_PIN_BL 3
  105. #define LCD_I2C_PIN_EN 2
  106. #define LCD_I2C_PIN_RW 1
  107. #define LCD_I2C_PIN_RS 0
  108. #define LCD_I2C_PIN_D4 4
  109. #define LCD_I2C_PIN_D5 5
  110. #define LCD_I2C_PIN_D6 6
  111. #define LCD_I2C_PIN_D7 7
  112. #include <Wire.h>
  113. #include <LCD.h>
  114. #include <LiquidCrystal_I2C.h>
  115. #define LCD_CLASS LiquidCrystal_I2C
  116. 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);
  117. #elif ENABLED(LCD_I2C_TYPE_MCP23017)
  118. //for the LED indicators (which maybe mapped to different things in lcd_implementation_update_indicators())
  119. #define LED_A 0x04 //100
  120. #define LED_B 0x02 //010
  121. #define LED_C 0x01 //001
  122. #define LCD_HAS_STATUS_INDICATORS
  123. #include <Wire.h>
  124. #include <LiquidTWI2.h>
  125. #define LCD_CLASS LiquidTWI2
  126. #if ENABLED(DETECT_DEVICE)
  127. LCD_CLASS lcd(LCD_I2C_ADDRESS, 1);
  128. #else
  129. LCD_CLASS lcd(LCD_I2C_ADDRESS);
  130. #endif
  131. #elif ENABLED(LCD_I2C_TYPE_MCP23008)
  132. #include <Wire.h>
  133. #include <LiquidTWI2.h>
  134. #define LCD_CLASS LiquidTWI2
  135. #if ENABLED(DETECT_DEVICE)
  136. LCD_CLASS lcd(LCD_I2C_ADDRESS, 1);
  137. #else
  138. LCD_CLASS lcd(LCD_I2C_ADDRESS);
  139. #endif
  140. #elif ENABLED(LCD_I2C_TYPE_PCA8574)
  141. #include <LiquidCrystal_I2C.h>
  142. #define LCD_CLASS LiquidCrystal_I2C
  143. LCD_CLASS lcd(LCD_I2C_ADDRESS, LCD_WIDTH, LCD_HEIGHT);
  144. // 2 wire Non-latching LCD SR from:
  145. // https://bitbucket.org/fmalpartida/new-liquidcrystal/wiki/schematics#!shiftregister-connection
  146. #elif ENABLED(SR_LCD_2W_NL)
  147. extern "C" void __cxa_pure_virtual() { while (1); }
  148. #include <LCD.h>
  149. #include <LiquidCrystal_SR.h>
  150. #define LCD_CLASS LiquidCrystal_SR
  151. #if PIN_EXISTS(SR_STROBE)
  152. LCD_CLASS lcd(SR_DATA_PIN, SR_CLK_PIN, SR_STROBE_PIN);
  153. #else
  154. LCD_CLASS lcd(SR_DATA_PIN, SR_CLK_PIN);
  155. #endif
  156. #elif ENABLED(LCM1602)
  157. #include <Wire.h>
  158. #include <LCD.h>
  159. #include <LiquidCrystal_I2C.h>
  160. #define LCD_CLASS LiquidCrystal_I2C
  161. LCD_CLASS lcd(0x27, 2, 1, 0, 4, 5, 6, 7, 3, POSITIVE);
  162. #else
  163. // Standard directly connected LCD implementations
  164. #include <LiquidCrystal.h>
  165. #define LCD_CLASS LiquidCrystal
  166. LCD_CLASS lcd(LCD_PINS_RS, LCD_PINS_ENABLE, LCD_PINS_D4, LCD_PINS_D5, LCD_PINS_D6, LCD_PINS_D7); //RS,Enable,D4,D5,D6,D7
  167. #endif
  168. #include "utf_mapper.h"
  169. #if ENABLED(LCD_PROGRESS_BAR)
  170. static millis_t progress_bar_ms = 0; // Start millis of the current progress bar cycle
  171. #if PROGRESS_MSG_EXPIRE > 0
  172. static millis_t expire_status_ms = 0; // millis at which to expire the status message
  173. #endif
  174. #define LCD_STR_PROGRESS "\x03\x04\x05"
  175. #endif
  176. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  177. static void lcd_implementation_update_indicators();
  178. #endif
  179. static void createChar_P(const char c, const byte * const ptr) {
  180. byte temp[8];
  181. for (uint8_t i = 0; i < 8; i++)
  182. temp[i] = pgm_read_byte(&ptr[i]);
  183. lcd.createChar(c, temp);
  184. }
  185. #define CHARSET_MENU 0
  186. #define CHARSET_INFO 1
  187. #define CHARSET_BOOT 2
  188. static void lcd_set_custom_characters(
  189. #if ENABLED(LCD_PROGRESS_BAR) || ENABLED(SHOW_BOOTSCREEN)
  190. const uint8_t screen_charset=CHARSET_INFO
  191. #endif
  192. ) {
  193. // CHARSET_BOOT
  194. #if ENABLED(SHOW_BOOTSCREEN)
  195. const static PROGMEM byte corner[4][8] = { {
  196. B00000,
  197. B00000,
  198. B00000,
  199. B00000,
  200. B00001,
  201. B00010,
  202. B00100,
  203. B00100
  204. }, {
  205. B00000,
  206. B00000,
  207. B00000,
  208. B11100,
  209. B11100,
  210. B01100,
  211. B00100,
  212. B00100
  213. }, {
  214. B00100,
  215. B00010,
  216. B00001,
  217. B00000,
  218. B00000,
  219. B00000,
  220. B00000,
  221. B00000
  222. }, {
  223. B00100,
  224. B01000,
  225. B10000,
  226. B00000,
  227. B00000,
  228. B00000,
  229. B00000,
  230. B00000
  231. } };
  232. #endif // SHOW_BOOTSCREEN
  233. // CHARSET_INFO
  234. const static PROGMEM byte bedTemp[8] = {
  235. B00000,
  236. B11111,
  237. B10101,
  238. B10001,
  239. B10101,
  240. B11111,
  241. B00000,
  242. B00000
  243. };
  244. const static PROGMEM byte degree[8] = {
  245. B01100,
  246. B10010,
  247. B10010,
  248. B01100,
  249. B00000,
  250. B00000,
  251. B00000,
  252. B00000
  253. };
  254. const static PROGMEM byte thermometer[8] = {
  255. B00100,
  256. B01010,
  257. B01010,
  258. B01010,
  259. B01010,
  260. B10001,
  261. B10001,
  262. B01110
  263. };
  264. const static PROGMEM byte uplevel[8] = {
  265. B00100,
  266. B01110,
  267. B11111,
  268. B00100,
  269. B11100,
  270. B00000,
  271. B00000,
  272. B00000
  273. };
  274. const static PROGMEM byte feedrate[8] = {
  275. B11100,
  276. B10000,
  277. B11000,
  278. B10111,
  279. B00101,
  280. B00110,
  281. B00101,
  282. B00000
  283. };
  284. const static PROGMEM byte clock[8] = {
  285. B00000,
  286. B01110,
  287. B10011,
  288. B10101,
  289. B10001,
  290. B01110,
  291. B00000,
  292. B00000
  293. };
  294. #if ENABLED(SDSUPPORT)
  295. // CHARSET_MENU
  296. const static PROGMEM byte refresh[8] = {
  297. B00000,
  298. B00110,
  299. B11001,
  300. B11000,
  301. B00011,
  302. B10011,
  303. B01100,
  304. B00000,
  305. };
  306. const static PROGMEM byte folder[8] = {
  307. B00000,
  308. B11100,
  309. B11111,
  310. B10001,
  311. B10001,
  312. B11111,
  313. B00000,
  314. B00000
  315. };
  316. #if ENABLED(LCD_PROGRESS_BAR)
  317. // CHARSET_INFO
  318. const static PROGMEM byte progress[3][8] = { {
  319. B00000,
  320. B10000,
  321. B10000,
  322. B10000,
  323. B10000,
  324. B10000,
  325. B10000,
  326. B00000
  327. }, {
  328. B00000,
  329. B10100,
  330. B10100,
  331. B10100,
  332. B10100,
  333. B10100,
  334. B10100,
  335. B00000
  336. }, {
  337. B00000,
  338. B10101,
  339. B10101,
  340. B10101,
  341. B10101,
  342. B10101,
  343. B10101,
  344. B00000
  345. } };
  346. #endif // LCD_PROGRESS_BAR
  347. #endif // SDSUPPORT
  348. #if ENABLED(SHOW_BOOTSCREEN) || ENABLED(LCD_PROGRESS_BAR)
  349. static uint8_t char_mode = CHARSET_MENU;
  350. #define CHAR_COND (screen_charset != char_mode)
  351. #else
  352. #define CHAR_COND true
  353. #endif
  354. if (CHAR_COND) {
  355. #if ENABLED(SHOW_BOOTSCREEN) || ENABLED(LCD_PROGRESS_BAR)
  356. char_mode = screen_charset;
  357. #if ENABLED(SHOW_BOOTSCREEN)
  358. // Set boot screen corner characters
  359. if (screen_charset == CHARSET_BOOT) {
  360. for (uint8_t i = 4; i--;)
  361. createChar_P(i, corner[i]);
  362. }
  363. else
  364. #endif
  365. #endif
  366. { // Info Screen uses 5 special characters
  367. createChar_P(LCD_BEDTEMP_CHAR, bedTemp);
  368. createChar_P(LCD_DEGREE_CHAR, degree);
  369. createChar_P(LCD_STR_THERMOMETER[0], thermometer);
  370. createChar_P(LCD_FEEDRATE_CHAR, feedrate);
  371. createChar_P(LCD_CLOCK_CHAR, clock);
  372. #if ENABLED(SDSUPPORT)
  373. #if ENABLED(LCD_PROGRESS_BAR)
  374. if (screen_charset == CHARSET_INFO) { // 3 Progress bar characters for info screen
  375. for (int16_t i = 3; i--;)
  376. createChar_P(LCD_STR_PROGRESS[i], progress[i]);
  377. }
  378. else
  379. #endif
  380. { // SD Card sub-menu special characters
  381. createChar_P(LCD_UPLEVEL_CHAR, uplevel);
  382. createChar_P(LCD_STR_REFRESH[0], refresh);
  383. createChar_P(LCD_STR_FOLDER[0], folder);
  384. }
  385. #else
  386. // With no SD support, only need the uplevel character
  387. createChar_P(LCD_UPLEVEL_CHAR, uplevel);
  388. #endif
  389. }
  390. }
  391. }
  392. static void lcd_implementation_init(
  393. #if ENABLED(LCD_PROGRESS_BAR)
  394. const uint8_t screen_charset=CHARSET_INFO
  395. #endif
  396. ) {
  397. #if ENABLED(LCD_I2C_TYPE_PCF8575)
  398. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  399. #ifdef LCD_I2C_PIN_BL
  400. lcd.setBacklightPin(LCD_I2C_PIN_BL, POSITIVE);
  401. lcd.setBacklight(HIGH);
  402. #endif
  403. #elif ENABLED(LCD_I2C_TYPE_MCP23017)
  404. lcd.setMCPType(LTI_TYPE_MCP23017);
  405. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  406. lcd_implementation_update_indicators();
  407. #elif ENABLED(LCD_I2C_TYPE_MCP23008)
  408. lcd.setMCPType(LTI_TYPE_MCP23008);
  409. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  410. #elif ENABLED(LCD_I2C_TYPE_PCA8574)
  411. lcd.init();
  412. lcd.backlight();
  413. #else
  414. lcd.begin(LCD_WIDTH, LCD_HEIGHT);
  415. #endif
  416. lcd_set_custom_characters(
  417. #if ENABLED(LCD_PROGRESS_BAR)
  418. screen_charset
  419. #endif
  420. );
  421. lcd.clear();
  422. }
  423. void lcd_implementation_clear() { lcd.clear(); }
  424. void lcd_print(const char c) { charset_mapper(c); }
  425. void lcd_print(const char *str) { while (*str) lcd.print(*str++); }
  426. void lcd_printPGM(const char *str) { while (const char c = pgm_read_byte(str)) lcd.print(c), ++str; }
  427. void lcd_print_utf(const char *str, uint8_t n=LCD_WIDTH) {
  428. char c;
  429. while (n && (c = *str)) n -= charset_mapper(c), ++str;
  430. }
  431. void lcd_printPGM_utf(const char *str, uint8_t n=LCD_WIDTH) {
  432. char c;
  433. while (n && (c = pgm_read_byte(str))) n -= charset_mapper(c), ++str;
  434. }
  435. #if ENABLED(SHOW_BOOTSCREEN)
  436. void lcd_erase_line(const int16_t line) {
  437. lcd.setCursor(0, line);
  438. for (uint8_t i = LCD_WIDTH + 1; --i;)
  439. lcd.write(' ');
  440. }
  441. // Scroll the PSTR 'text' in a 'len' wide field for 'time' milliseconds at position col,line
  442. void lcd_scroll(const int16_t col, const int16_t line, const char* const text, const int16_t len, const int16_t time) {
  443. char tmp[LCD_WIDTH + 1] = {0};
  444. int16_t n = max(lcd_strlen_P(text) - len, 0);
  445. for (int16_t i = 0; i <= n; i++) {
  446. strncpy_P(tmp, text + i, min(len, LCD_WIDTH));
  447. lcd.setCursor(col, line);
  448. lcd_print(tmp);
  449. delay(time / max(n, 1));
  450. }
  451. }
  452. static void logo_lines(const char* const extra) {
  453. int16_t indent = (LCD_WIDTH - 8 - lcd_strlen_P(extra)) / 2;
  454. lcd.setCursor(indent, 0); lcd.print('\x00'); lcd_printPGM(PSTR( "------" )); lcd.write('\x01');
  455. lcd.setCursor(indent, 1); lcd_printPGM(PSTR("|Marlin|")); lcd_printPGM(extra);
  456. lcd.setCursor(indent, 2); lcd.write('\x02'); lcd_printPGM(PSTR( "------" )); lcd.write('\x03');
  457. }
  458. void lcd_bootscreen() {
  459. lcd_set_custom_characters(CHARSET_BOOT);
  460. lcd.clear();
  461. #define LCD_EXTRA_SPACE (LCD_WIDTH-8)
  462. #define CENTER_OR_SCROLL(STRING,DELAY) \
  463. lcd_erase_line(3); \
  464. if (strlen(STRING) <= LCD_WIDTH) { \
  465. lcd.setCursor((LCD_WIDTH - lcd_strlen_P(PSTR(STRING))) / 2, 3); \
  466. lcd_printPGM(PSTR(STRING)); \
  467. safe_delay(DELAY); \
  468. } \
  469. else { \
  470. lcd_scroll(0, 3, PSTR(STRING), LCD_WIDTH, DELAY); \
  471. }
  472. #ifdef STRING_SPLASH_LINE1
  473. //
  474. // Show the Marlin logo with splash line 1
  475. //
  476. if (LCD_EXTRA_SPACE >= strlen(STRING_SPLASH_LINE1) + 1) {
  477. //
  478. // Show the Marlin logo, splash line1, and splash line 2
  479. //
  480. logo_lines(PSTR(" " STRING_SPLASH_LINE1));
  481. #ifdef STRING_SPLASH_LINE2
  482. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 2000);
  483. #else
  484. safe_delay(2000);
  485. #endif
  486. }
  487. else {
  488. //
  489. // Show the Marlin logo with splash line 1
  490. // After a delay show splash line 2, if it exists
  491. //
  492. #ifdef STRING_SPLASH_LINE2
  493. #define _SPLASH_WAIT_1 1500
  494. #else
  495. #define _SPLASH_WAIT_1 2000
  496. #endif
  497. logo_lines(PSTR(""));
  498. CENTER_OR_SCROLL(STRING_SPLASH_LINE1, _SPLASH_WAIT_1);
  499. #ifdef STRING_SPLASH_LINE2
  500. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 1500);
  501. #endif
  502. }
  503. #elif defined(STRING_SPLASH_LINE2)
  504. //
  505. // Show splash line 2 only, alongside the logo if possible
  506. //
  507. if (LCD_EXTRA_SPACE >= strlen(STRING_SPLASH_LINE2) + 1) {
  508. logo_lines(PSTR(" " STRING_SPLASH_LINE2));
  509. safe_delay(2000);
  510. }
  511. else {
  512. logo_lines(PSTR(""));
  513. CENTER_OR_SCROLL(STRING_SPLASH_LINE2, 2000);
  514. }
  515. #else
  516. //
  517. // Show only the Marlin logo
  518. //
  519. logo_lines(PSTR(""));
  520. safe_delay(2000);
  521. #endif
  522. lcd.clear();
  523. safe_delay(100);
  524. lcd_set_custom_characters();
  525. lcd.clear();
  526. }
  527. #endif // SHOW_BOOTSCREEN
  528. void lcd_kill_screen() {
  529. lcd.setCursor(0, 0);
  530. lcd_print_utf(lcd_status_message);
  531. #if LCD_HEIGHT < 4
  532. lcd.setCursor(0, 2);
  533. #else
  534. lcd.setCursor(0, 2);
  535. lcd_printPGM(PSTR(MSG_HALTED));
  536. lcd.setCursor(0, 3);
  537. #endif
  538. lcd_printPGM(PSTR(MSG_PLEASE_RESET));
  539. }
  540. FORCE_INLINE void _draw_axis_label(const AxisEnum axis, const char* const pstr, const bool blink) {
  541. if (blink)
  542. lcd_printPGM(pstr);
  543. else {
  544. if (!axis_homed[axis])
  545. lcd.write('?');
  546. else {
  547. #if DISABLED(HOME_AFTER_DEACTIVATE) && DISABLED(DISABLE_REDUCED_ACCURACY_WARNING)
  548. if (!axis_known_position[axis])
  549. lcd.write(' ');
  550. else
  551. #endif
  552. lcd_printPGM(pstr);
  553. }
  554. }
  555. }
  556. FORCE_INLINE void _draw_heater_status(const int8_t heater, const char prefix, const bool blink) {
  557. const bool isBed = heater < 0;
  558. const float t1 = (isBed ? thermalManager.degBed() : thermalManager.degHotend(heater)),
  559. t2 = (isBed ? thermalManager.degTargetBed() : thermalManager.degTargetHotend(heater));
  560. if (prefix >= 0) lcd.print(prefix);
  561. lcd.print(itostr3(t1 + 0.5));
  562. lcd.write('/');
  563. #if !HEATER_IDLE_HANDLER
  564. UNUSED(blink);
  565. #else
  566. const bool is_idle = (!isBed ? thermalManager.is_heater_idle(heater) :
  567. #if HAS_TEMP_BED
  568. thermalManager.is_bed_idle()
  569. #else
  570. false
  571. #endif
  572. );
  573. if (!blink && is_idle) {
  574. lcd.write(' ');
  575. if (t2 >= 10) lcd.write(' ');
  576. if (t2 >= 100) lcd.write(' ');
  577. }
  578. else
  579. #endif
  580. lcd.print(itostr3left(t2 + 0.5));
  581. if (prefix >= 0) {
  582. lcd.print((char)LCD_DEGREE_CHAR);
  583. lcd.write(' ');
  584. if (t2 < 10) lcd.write(' ');
  585. }
  586. }
  587. #if ENABLED(LCD_PROGRESS_BAR)
  588. inline void lcd_draw_progress_bar(const uint8_t percent) {
  589. const int16_t tix = (int16_t)(percent * (LCD_WIDTH) * 3) / 100,
  590. cel = tix / 3,
  591. rem = tix % 3;
  592. uint8_t i = LCD_WIDTH;
  593. char msg[LCD_WIDTH + 1], b = ' ';
  594. msg[LCD_WIDTH] = '\0';
  595. while (i--) {
  596. if (i == cel - 1)
  597. b = LCD_STR_PROGRESS[2];
  598. else if (i == cel && rem != 0)
  599. b = LCD_STR_PROGRESS[rem - 1];
  600. msg[i] = b;
  601. }
  602. lcd.print(msg);
  603. }
  604. #endif // LCD_PROGRESS_BAR
  605. /**
  606. Possible status screens:
  607. 16x2 |000/000 B000/000|
  608. |0123456789012345|
  609. 16x4 |000/000 B000/000|
  610. |SD100% Z 000.00|
  611. |F100% T--:--|
  612. |0123456789012345|
  613. 20x2 |T000/000D B000/000D |
  614. |01234567890123456789|
  615. 20x4 |T000/000D B000/000D |
  616. |X 000 Y 000 Z 000.00|
  617. |F100% SD100% T--:--|
  618. |01234567890123456789|
  619. 20x4 |T000/000D B000/000D |
  620. |T000/000D Z 000.00|
  621. |F100% SD100% T--:--|
  622. |01234567890123456789|
  623. */
  624. static void lcd_implementation_status_screen() {
  625. const bool blink = lcd_blink();
  626. //
  627. // Line 1
  628. //
  629. lcd.setCursor(0, 0);
  630. #if LCD_WIDTH < 20
  631. //
  632. // Hotend 0 Temperature
  633. //
  634. _draw_heater_status(0, -1, blink);
  635. //
  636. // Hotend 1 or Bed Temperature
  637. //
  638. #if HOTENDS > 1 || TEMP_SENSOR_BED != 0
  639. lcd.setCursor(8, 0);
  640. #if HOTENDS > 1
  641. lcd.print((char)LCD_STR_THERMOMETER[0]);
  642. _draw_heater_status(1, -1, blink);
  643. #else
  644. lcd.print((char)LCD_BEDTEMP_CHAR);
  645. _draw_heater_status(-1, -1, blink);
  646. #endif
  647. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  648. #else // LCD_WIDTH >= 20
  649. //
  650. // Hotend 0 Temperature
  651. //
  652. _draw_heater_status(0, LCD_STR_THERMOMETER[0], blink);
  653. //
  654. // Hotend 1 or Bed Temperature
  655. //
  656. #if HOTENDS > 1 || TEMP_SENSOR_BED != 0
  657. lcd.setCursor(10, 0);
  658. #if HOTENDS > 1
  659. _draw_heater_status(1, LCD_STR_THERMOMETER[0], blink);
  660. #else
  661. _draw_heater_status(-1, LCD_BEDTEMP_CHAR, blink);
  662. #endif
  663. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  664. #endif // LCD_WIDTH >= 20
  665. //
  666. // Line 2
  667. //
  668. #if LCD_HEIGHT > 2
  669. #if LCD_WIDTH < 20
  670. #if ENABLED(SDSUPPORT)
  671. lcd.setCursor(0, 2);
  672. lcd_printPGM(PSTR("SD"));
  673. if (IS_SD_PRINTING)
  674. lcd.print(itostr3(card.percentDone()));
  675. else
  676. lcd_printPGM(PSTR("---"));
  677. lcd.write('%');
  678. #endif // SDSUPPORT
  679. #else // LCD_WIDTH >= 20
  680. lcd.setCursor(0, 1);
  681. #if HOTENDS > 1 && TEMP_SENSOR_BED != 0
  682. // If we both have a 2nd extruder and a heated bed,
  683. // show the heated bed temp on the left,
  684. // since the first line is filled with extruder temps
  685. _draw_heater_status(-1, LCD_BEDTEMP_CHAR, blink);
  686. #else
  687. // Before homing the axis letters are blinking 'X' <-> '?'.
  688. // When axis is homed but axis_known_position is false the axis letters are blinking 'X' <-> ' '.
  689. // When everything is ok you see a constant 'X'.
  690. _draw_axis_label(X_AXIS, PSTR(MSG_X), blink);
  691. lcd.print(ftostr4sign(LOGICAL_X_POSITION(current_position[X_AXIS])));
  692. lcd.write(' ');
  693. _draw_axis_label(Y_AXIS, PSTR(MSG_Y), blink);
  694. lcd.print(ftostr4sign(LOGICAL_Y_POSITION(current_position[Y_AXIS])));
  695. #endif // HOTENDS > 1 || TEMP_SENSOR_BED != 0
  696. #endif // LCD_WIDTH >= 20
  697. lcd.setCursor(LCD_WIDTH - 8, 1);
  698. _draw_axis_label(Z_AXIS, PSTR(MSG_Z), blink);
  699. lcd.print(ftostr52sp(FIXFLOAT(current_position[Z_AXIS])));
  700. #if HAS_LEVELING
  701. lcd.write(planner.leveling_active || blink ? '_' : ' ');
  702. #endif
  703. #endif // LCD_HEIGHT > 2
  704. //
  705. // Line 3
  706. //
  707. #if LCD_HEIGHT > 3
  708. lcd.setCursor(0, 2);
  709. lcd.print((char)LCD_FEEDRATE_CHAR);
  710. lcd.print(itostr3(feedrate_percentage));
  711. lcd.write('%');
  712. #if LCD_WIDTH >= 20 && ENABLED(SDSUPPORT)
  713. lcd.setCursor(7, 2);
  714. lcd_printPGM(PSTR("SD"));
  715. if (IS_SD_PRINTING)
  716. lcd.print(itostr3(card.percentDone()));
  717. else
  718. lcd_printPGM(PSTR("---"));
  719. lcd.write('%');
  720. #endif // LCD_WIDTH >= 20 && SDSUPPORT
  721. char buffer[10];
  722. duration_t elapsed = print_job_timer.duration();
  723. uint8_t len = elapsed.toDigital(buffer);
  724. lcd.setCursor(LCD_WIDTH - len - 1, 2);
  725. lcd.print((char)LCD_CLOCK_CHAR);
  726. lcd_print(buffer);
  727. #endif // LCD_HEIGHT > 3
  728. //
  729. // Last Line
  730. // Status Message (which may be a Progress Bar or Filament display)
  731. //
  732. lcd.setCursor(0, LCD_HEIGHT - 1);
  733. #if ENABLED(LCD_PROGRESS_BAR)
  734. // Draw the progress bar if the message has shown long enough
  735. // or if there is no message set.
  736. #if DISABLED(LCD_SET_PROGRESS_MANUALLY)
  737. const uint8_t progress_bar_percent = card.percentDone();
  738. #endif
  739. if (progress_bar_percent > 2 && (ELAPSED(millis(), progress_bar_ms + PROGRESS_BAR_MSG_TIME) || !lcd_status_message[0]))
  740. return lcd_draw_progress_bar(progress_bar_percent);
  741. #elif ENABLED(FILAMENT_LCD_DISPLAY) && ENABLED(SDSUPPORT)
  742. // Show Filament Diameter and Volumetric Multiplier %
  743. // After allowing lcd_status_message to show for 5 seconds
  744. if (ELAPSED(millis(), previous_lcd_status_ms + 5000UL)) {
  745. lcd_printPGM(PSTR("Dia "));
  746. lcd.print(ftostr12ns(filament_width_meas));
  747. lcd_printPGM(PSTR(" V"));
  748. lcd.print(itostr3(100.0 * (
  749. parser.volumetric_enabled
  750. ? planner.volumetric_area_nominal / planner.volumetric_multiplier[FILAMENT_SENSOR_EXTRUDER_NUM]
  751. : planner.volumetric_multiplier[FILAMENT_SENSOR_EXTRUDER_NUM]
  752. )
  753. ));
  754. lcd.write('%');
  755. return;
  756. }
  757. #endif // FILAMENT_LCD_DISPLAY && SDSUPPORT
  758. #if ENABLED(STATUS_MESSAGE_SCROLLING)
  759. static bool last_blink = false;
  760. const uint8_t slen = lcd_strlen(lcd_status_message);
  761. const char *stat = lcd_status_message + status_scroll_pos;
  762. if (slen <= LCD_WIDTH)
  763. lcd_print_utf(stat); // The string isn't scrolling
  764. else {
  765. if (status_scroll_pos <= slen - LCD_WIDTH)
  766. lcd_print_utf(stat); // The string fills the screen
  767. else {
  768. uint8_t chars = LCD_WIDTH;
  769. if (status_scroll_pos < slen) { // First string still visible
  770. lcd_print_utf(stat); // The string leaves space
  771. chars -= slen - status_scroll_pos; // Amount of space left
  772. }
  773. lcd.write('.'); // Always at 1+ spaces left, draw a dot
  774. if (--chars) {
  775. if (status_scroll_pos < slen + 1) // Draw a second dot if there's space
  776. --chars, lcd.write('.');
  777. if (chars) lcd_print_utf(lcd_status_message, chars); // Print a second copy of the message
  778. }
  779. }
  780. if (last_blink != blink) {
  781. last_blink = blink;
  782. // Skip any non-printing bytes
  783. if (status_scroll_pos < slen) while (!PRINTABLE(lcd_status_message[status_scroll_pos])) status_scroll_pos++;
  784. if (++status_scroll_pos >= slen + 2) status_scroll_pos = 0;
  785. }
  786. }
  787. #else
  788. lcd_print_utf(lcd_status_message);
  789. #endif
  790. }
  791. #if ENABLED(ULTIPANEL)
  792. #if ENABLED(ADVANCED_PAUSE_FEATURE)
  793. static void lcd_implementation_hotend_status(const uint8_t row) {
  794. if (row < LCD_HEIGHT) {
  795. lcd.setCursor(LCD_WIDTH - 9, row);
  796. _draw_heater_status(active_extruder, LCD_STR_THERMOMETER[0], lcd_blink());
  797. }
  798. }
  799. #endif // ADVANCED_PAUSE_FEATURE
  800. static void lcd_implementation_drawmenu_static(const uint8_t row, const char* pstr, const bool center=true, const bool invert=false, const char *valstr=NULL) {
  801. UNUSED(invert);
  802. char c;
  803. int8_t n = LCD_WIDTH;
  804. lcd.setCursor(0, row);
  805. if (center && !valstr) {
  806. int8_t pad = (LCD_WIDTH - lcd_strlen_P(pstr)) / 2;
  807. while (--pad >= 0) { lcd.write(' '); n--; }
  808. }
  809. while (n > 0 && (c = pgm_read_byte(pstr))) {
  810. n -= charset_mapper(c);
  811. pstr++;
  812. }
  813. if (valstr) while (n > 0 && (c = *valstr)) {
  814. n -= charset_mapper(c);
  815. valstr++;
  816. }
  817. while (n-- > 0) lcd.write(' ');
  818. }
  819. static void lcd_implementation_drawmenu_generic(const bool sel, const uint8_t row, const char* pstr, const char pre_char, const char post_char) {
  820. char c;
  821. uint8_t n = LCD_WIDTH - 2;
  822. lcd.setCursor(0, row);
  823. lcd.print(sel ? pre_char : ' ');
  824. while ((c = pgm_read_byte(pstr)) && n > 0) {
  825. n -= charset_mapper(c);
  826. pstr++;
  827. }
  828. while (n--) lcd.write(' ');
  829. lcd.print(post_char);
  830. }
  831. static void lcd_implementation_drawmenu_setting_edit_generic(const bool sel, const uint8_t row, const char* pstr, const char pre_char, const char* const data) {
  832. char c;
  833. uint8_t n = LCD_WIDTH - 2 - lcd_strlen(data);
  834. lcd.setCursor(0, row);
  835. lcd.print(sel ? pre_char : ' ');
  836. while ((c = pgm_read_byte(pstr)) && n > 0) {
  837. n -= charset_mapper(c);
  838. pstr++;
  839. }
  840. lcd.write(':');
  841. while (n--) lcd.write(' ');
  842. lcd_print(data);
  843. }
  844. static void lcd_implementation_drawmenu_setting_edit_generic_P(const bool sel, const uint8_t row, const char* pstr, const char pre_char, const char* const data) {
  845. char c;
  846. uint8_t n = LCD_WIDTH - 2 - lcd_strlen_P(data);
  847. lcd.setCursor(0, row);
  848. lcd.print(sel ? pre_char : ' ');
  849. while ((c = pgm_read_byte(pstr)) && n > 0) {
  850. n -= charset_mapper(c);
  851. pstr++;
  852. }
  853. lcd.write(':');
  854. while (n--) lcd.write(' ');
  855. lcd_printPGM(data);
  856. }
  857. #define DRAWMENU_SETTING_EDIT_GENERIC(_src) lcd_implementation_drawmenu_setting_edit_generic(sel, row, pstr, '>', _src)
  858. #define DRAW_BOOL_SETTING(sel, row, pstr, data) lcd_implementation_drawmenu_setting_edit_generic_P(sel, row, pstr, '>', (*(data))?PSTR(MSG_ON):PSTR(MSG_OFF))
  859. void lcd_implementation_drawedit(const char* pstr, const char* const value=NULL) {
  860. lcd.setCursor(1, 1);
  861. lcd_printPGM(pstr);
  862. if (value != NULL) {
  863. lcd.write(':');
  864. const uint8_t valrow = (lcd_strlen_P(pstr) + 1 + lcd_strlen(value) + 1) > (LCD_WIDTH - 2) ? 2 : 1; // Value on the next row if it won't fit
  865. lcd.setCursor((LCD_WIDTH - 1) - (lcd_strlen(value) + 1), valrow); // Right-justified, padded by spaces
  866. lcd.write(' '); // overwrite char if value gets shorter
  867. lcd_print(value);
  868. }
  869. }
  870. #if ENABLED(SDSUPPORT)
  871. static void lcd_implementation_drawmenu_sd(const bool sel, const uint8_t row, const char* const pstr, const char* filename, char* const longFilename, const uint8_t concat, const char post_char) {
  872. UNUSED(pstr);
  873. lcd.setCursor(0, row);
  874. lcd.print(sel ? '>' : ' ');
  875. uint8_t n = LCD_WIDTH - concat;
  876. const char *outstr = longFilename[0] ? longFilename : filename;
  877. if (longFilename[0]) {
  878. #if ENABLED(SCROLL_LONG_FILENAMES)
  879. if (sel) {
  880. uint8_t name_hash = row;
  881. for (uint8_t l = FILENAME_LENGTH; l--;)
  882. name_hash = ((name_hash << 1) | (name_hash >> 7)) ^ filename[l]; // rotate, xor
  883. if (filename_scroll_hash != name_hash) { // If the hash changed...
  884. filename_scroll_hash = name_hash; // Save the new hash
  885. filename_scroll_max = max(0, lcd_strlen(longFilename) - n); // Update the scroll limit
  886. filename_scroll_pos = 0; // Reset scroll to the start
  887. lcd_status_update_delay = 8; // Don't scroll right away
  888. }
  889. outstr += filename_scroll_pos;
  890. }
  891. #else
  892. longFilename[n] = '\0'; // cutoff at screen edge
  893. #endif
  894. }
  895. char c;
  896. while (n && (c = *outstr)) {
  897. n -= charset_mapper(c);
  898. ++outstr;
  899. }
  900. while (n) { --n; lcd.write(' '); }
  901. lcd.print(post_char);
  902. }
  903. static void lcd_implementation_drawmenu_sdfile(const bool sel, const uint8_t row, const char* pstr, const char* filename, char* const longFilename) {
  904. lcd_implementation_drawmenu_sd(sel, row, pstr, filename, longFilename, 2, ' ');
  905. }
  906. static void lcd_implementation_drawmenu_sddirectory(const bool sel, const uint8_t row, const char* pstr, const char* filename, char* const longFilename) {
  907. lcd_implementation_drawmenu_sd(sel, row, pstr, filename, longFilename, 2, LCD_STR_FOLDER[0]);
  908. }
  909. #endif // SDSUPPORT
  910. #define lcd_implementation_drawmenu_back(sel, row, pstr, dummy) lcd_implementation_drawmenu_generic(sel, row, pstr, LCD_UPLEVEL_CHAR, LCD_UPLEVEL_CHAR)
  911. #define lcd_implementation_drawmenu_submenu(sel, row, pstr, data) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', LCD_STR_ARROW_RIGHT[0])
  912. #define lcd_implementation_drawmenu_gcode(sel, row, pstr, gcode) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', ' ')
  913. #define lcd_implementation_drawmenu_function(sel, row, pstr, data) lcd_implementation_drawmenu_generic(sel, row, pstr, '>', ' ')
  914. #if ENABLED(LCD_HAS_SLOW_BUTTONS)
  915. extern millis_t next_button_update_ms;
  916. static uint8_t lcd_implementation_read_slow_buttons() {
  917. #if ENABLED(LCD_I2C_TYPE_MCP23017)
  918. // Reading these buttons this is likely to be too slow to call inside interrupt context
  919. // so they are called during normal lcd_update
  920. uint8_t slow_bits = lcd.readButtons() << B_I2C_BTN_OFFSET;
  921. #if ENABLED(LCD_I2C_VIKI)
  922. if ((slow_bits & (B_MI | B_RI)) && PENDING(millis(), next_button_update_ms)) // LCD clicked
  923. slow_bits &= ~(B_MI | B_RI); // Disable LCD clicked buttons if screen is updated
  924. #endif // LCD_I2C_VIKI
  925. return slow_bits;
  926. #endif // LCD_I2C_TYPE_MCP23017
  927. }
  928. #endif // LCD_HAS_SLOW_BUTTONS
  929. #if ENABLED(LCD_HAS_STATUS_INDICATORS)
  930. static void lcd_implementation_update_indicators() {
  931. // Set the LEDS - referred to as backlights by the LiquidTWI2 library
  932. static uint8_t ledsprev = 0;
  933. uint8_t leds = 0;
  934. if (thermalManager.degTargetBed() > 0) leds |= LED_A;
  935. if (thermalManager.degTargetHotend(0) > 0) leds |= LED_B;
  936. #if FAN_COUNT > 0
  937. if (0
  938. #if HAS_FAN0
  939. || fanSpeeds[0]
  940. #endif
  941. #if HAS_FAN1
  942. || fanSpeeds[1]
  943. #endif
  944. #if HAS_FAN2
  945. || fanSpeeds[2]
  946. #endif
  947. ) leds |= LED_C;
  948. #endif // FAN_COUNT > 0
  949. #if HOTENDS > 1
  950. if (thermalManager.degTargetHotend(1) > 0) leds |= LED_C;
  951. #endif
  952. if (leds != ledsprev) {
  953. lcd.setBacklight(leds);
  954. ledsprev = leds;
  955. }
  956. }
  957. #endif // LCD_HAS_STATUS_INDICATORS
  958. #if ENABLED(AUTO_BED_LEVELING_UBL)
  959. /**
  960. Possible map screens:
  961. 16x2 |X000.00 Y000.00|
  962. |(00,00) Z00.000|
  963. 20x2 | X:000.00 Y:000.00 |
  964. | (00,00) Z:00.000 |
  965. 16x4 |+-------+(00,00)|
  966. || |X000.00|
  967. || |Y000.00|
  968. |+-------+Z00.000|
  969. 20x4 | +-------+ (00,00) |
  970. | | | X:000.00|
  971. | | | Y:000.00|
  972. | +-------+ Z:00.000|
  973. */
  974. typedef struct {
  975. uint8_t custom_char_bits[ULTRA_Y_PIXELS_PER_CHAR];
  976. } custom_char;
  977. typedef struct {
  978. uint8_t column, row;
  979. uint8_t y_pixel_offset, x_pixel_offset;
  980. uint8_t x_pixel_mask;
  981. } coordinate;
  982. void add_edges_to_custom_char(custom_char * const custom, coordinate * const ul, coordinate * const lr, coordinate * const brc, const uint8_t cell_location);
  983. FORCE_INLINE static void clear_custom_char(custom_char * const cc) { ZERO(cc->custom_char_bits); }
  984. /*
  985. // This debug routine should be deleted by anybody that sees it. It doesn't belong here
  986. // But I'm leaving it for now until we know the 20x4 Radar Map is working right.
  987. // We may need it again if any funny lines show up on the mesh points.
  988. void dump_custom_char(char *title, custom_char *c) {
  989. SERIAL_PROTOCOLLN(title);
  990. for (uint8_t j = 0; j < 8; j++) {
  991. for (uint8_t i = 7; i >= 0; i--)
  992. SERIAL_PROTOCOLCHAR(TEST(c->custom_char_bits[j], i) ? '1' : '0');
  993. SERIAL_EOL();
  994. }
  995. SERIAL_EOL();
  996. }
  997. //*/
  998. coordinate pixel_location(int16_t x, int16_t y) {
  999. coordinate ret_val;
  1000. int16_t xp, yp, r, c;
  1001. x++; y++; // +1 because lines on the left and top
  1002. c = x / (ULTRA_X_PIXELS_PER_CHAR);
  1003. r = y / (ULTRA_Y_PIXELS_PER_CHAR);
  1004. ret_val.column = c;
  1005. ret_val.row = r;
  1006. xp = x - c * (ULTRA_X_PIXELS_PER_CHAR); // get the pixel offsets into the character cell
  1007. xp = ULTRA_X_PIXELS_PER_CHAR - 1 - xp; // column within relevant character cell (0 on the right)
  1008. yp = y - r * (ULTRA_Y_PIXELS_PER_CHAR);
  1009. ret_val.x_pixel_mask = _BV(xp);
  1010. ret_val.x_pixel_offset = xp;
  1011. ret_val.y_pixel_offset = yp;
  1012. return ret_val;
  1013. }
  1014. inline coordinate pixel_location(const uint8_t x, const uint8_t y) { return pixel_location((int16_t)x, (int16_t)y); }
  1015. void lcd_implementation_ubl_plot(const uint8_t x, const uint8_t inverted_y) {
  1016. #if LCD_WIDTH >= 20
  1017. #define _LCD_W_POS 12
  1018. #define _PLOT_X 1
  1019. #define _MAP_X 3
  1020. #define _LABEL(C,X,Y) lcd.setCursor(X, Y); lcd.print(C)
  1021. #define _XLABEL(X,Y) _LABEL("X:",X,Y)
  1022. #define _YLABEL(X,Y) _LABEL("Y:",X,Y)
  1023. #define _ZLABEL(X,Y) _LABEL("Z:",X,Y)
  1024. #else
  1025. #define _LCD_W_POS 8
  1026. #define _PLOT_X 0
  1027. #define _MAP_X 1
  1028. #define _LABEL(X,Y,C) lcd.setCursor(X, Y); lcd.write(C)
  1029. #define _XLABEL(X,Y) _LABEL('X',X,Y)
  1030. #define _YLABEL(X,Y) _LABEL('Y',X,Y)
  1031. #define _ZLABEL(X,Y) _LABEL('Z',X,Y)
  1032. #endif
  1033. #if LCD_HEIGHT <= 3 // 16x2 or 20x2 display
  1034. /**
  1035. * Show X and Y positions
  1036. */
  1037. _XLABEL(_PLOT_X, 0);
  1038. lcd.print(ftostr32(LOGICAL_X_POSITION(pgm_read_float(&ubl._mesh_index_to_xpos[x]))));
  1039. _YLABEL(_LCD_W_POS, 0);
  1040. lcd.print(ftostr32(LOGICAL_Y_POSITION(pgm_read_float(&ubl._mesh_index_to_ypos[inverted_y]))));
  1041. lcd.setCursor(_PLOT_X, 0);
  1042. #else // 16x4 or 20x4 display
  1043. coordinate upper_left, lower_right, bottom_right_corner;
  1044. custom_char new_char;
  1045. uint8_t i, j, k, l, m, n, n_rows, n_cols, y,
  1046. bottom_line, right_edge,
  1047. x_map_pixels, y_map_pixels,
  1048. pixels_per_x_mesh_pnt, pixels_per_y_mesh_pnt,
  1049. suppress_x_offset = 0, suppress_y_offset = 0;
  1050. y = GRID_MAX_POINTS_Y - inverted_y - 1;
  1051. upper_left.column = 0;
  1052. upper_left.row = 0;
  1053. lower_right.column = 0;
  1054. lower_right.row = 0;
  1055. lcd_implementation_clear();
  1056. x_map_pixels = (ULTRA_X_PIXELS_PER_CHAR) * (ULTRA_COLUMNS_FOR_MESH_MAP) - 2; // minus 2 because we are drawing a box around the map
  1057. y_map_pixels = (ULTRA_Y_PIXELS_PER_CHAR) * (ULTRA_ROWS_FOR_MESH_MAP) - 2;
  1058. pixels_per_x_mesh_pnt = x_map_pixels / (GRID_MAX_POINTS_X);
  1059. pixels_per_y_mesh_pnt = y_map_pixels / (GRID_MAX_POINTS_Y);
  1060. if (pixels_per_x_mesh_pnt >= ULTRA_X_PIXELS_PER_CHAR) { // There are only 2 custom characters available, so the X
  1061. pixels_per_x_mesh_pnt = ULTRA_X_PIXELS_PER_CHAR; // size of the mesh point needs to fit within them independent
  1062. suppress_x_offset = 1; // of where the starting pixel is located.
  1063. }
  1064. if (pixels_per_y_mesh_pnt >= ULTRA_Y_PIXELS_PER_CHAR) { // There are only 2 custom characters available, so the Y
  1065. pixels_per_y_mesh_pnt = ULTRA_Y_PIXELS_PER_CHAR; // size of the mesh point needs to fit within them independent
  1066. suppress_y_offset = 1; // of where the starting pixel is located.
  1067. }
  1068. x_map_pixels = pixels_per_x_mesh_pnt * (GRID_MAX_POINTS_X); // now we have the right number of pixels to make both
  1069. y_map_pixels = pixels_per_y_mesh_pnt * (GRID_MAX_POINTS_Y); // directions fit nicely
  1070. right_edge = pixels_per_x_mesh_pnt * (GRID_MAX_POINTS_X) + 1; // find location of right edge within the character cell
  1071. bottom_line= pixels_per_y_mesh_pnt * (GRID_MAX_POINTS_Y) + 1; // find location of bottome line within the character cell
  1072. n_rows = bottom_line / (ULTRA_Y_PIXELS_PER_CHAR) + 1;
  1073. n_cols = right_edge / (ULTRA_X_PIXELS_PER_CHAR) + 1;
  1074. for (i = 0; i < n_cols; i++) {
  1075. lcd.setCursor(i, 0);
  1076. lcd.print((char)0x00); // top line of the box
  1077. lcd.setCursor(i, n_rows - 1);
  1078. lcd.write(0x01); // bottom line of the box
  1079. }
  1080. for (j = 0; j < n_rows; j++) {
  1081. lcd.setCursor(0, j);
  1082. lcd.write(0x02); // Left edge of the box
  1083. lcd.setCursor(n_cols - 1, j);
  1084. lcd.write(0x03); // right edge of the box
  1085. }
  1086. /**
  1087. * If the entire 4th row is not in use, do not put vertical bars all the way down to the bottom of the display
  1088. */
  1089. k = pixels_per_y_mesh_pnt * (GRID_MAX_POINTS_Y) + 2;
  1090. l = (ULTRA_Y_PIXELS_PER_CHAR) * n_rows;
  1091. if (l > k && l - k >= (ULTRA_Y_PIXELS_PER_CHAR) / 2) {
  1092. lcd.setCursor(0, n_rows - 1); // left edge of the box
  1093. lcd.write(' ');
  1094. lcd.setCursor(n_cols - 1, n_rows - 1); // right edge of the box
  1095. lcd.write(' ');
  1096. }
  1097. clear_custom_char(&new_char);
  1098. new_char.custom_char_bits[0] = 0B11111U; // char #0 is used for the top line of the box
  1099. lcd.createChar(0, (uint8_t*)&new_char);
  1100. clear_custom_char(&new_char);
  1101. k = (GRID_MAX_POINTS_Y) * pixels_per_y_mesh_pnt + 1; // row of pixels for the bottom box line
  1102. l = k % (ULTRA_Y_PIXELS_PER_CHAR); // row within relevant character cell
  1103. new_char.custom_char_bits[l] = 0B11111U; // char #1 is used for the bottom line of the box
  1104. lcd.createChar(1, (uint8_t*)&new_char);
  1105. clear_custom_char(&new_char);
  1106. for (j = 0; j < ULTRA_Y_PIXELS_PER_CHAR; j++)
  1107. new_char.custom_char_bits[j] = 0B10000U; // char #2 is used for the left edge of the box
  1108. lcd.createChar(2, (uint8_t*)&new_char);
  1109. clear_custom_char(&new_char);
  1110. m = (GRID_MAX_POINTS_X) * pixels_per_x_mesh_pnt + 1; // Column of pixels for the right box line
  1111. n = m % (ULTRA_X_PIXELS_PER_CHAR); // Column within relevant character cell
  1112. i = ULTRA_X_PIXELS_PER_CHAR - 1 - n; // Column within relevant character cell (0 on the right)
  1113. for (j = 0; j < ULTRA_Y_PIXELS_PER_CHAR; j++)
  1114. new_char.custom_char_bits[j] = (uint8_t)_BV(i); // Char #3 is used for the right edge of the box
  1115. lcd.createChar(3, (uint8_t*)&new_char);
  1116. i = x * pixels_per_x_mesh_pnt - suppress_x_offset;
  1117. j = y * pixels_per_y_mesh_pnt - suppress_y_offset;
  1118. upper_left = pixel_location(i, j);
  1119. k = (x + 1) * pixels_per_x_mesh_pnt - 1 - suppress_x_offset;
  1120. l = (y + 1) * pixels_per_y_mesh_pnt - 1 - suppress_y_offset;
  1121. lower_right = pixel_location(k, l);
  1122. bottom_right_corner = pixel_location(x_map_pixels, y_map_pixels);
  1123. /**
  1124. * First, handle the simple case where everything is within a single character cell.
  1125. * If part of the Mesh Plot is outside of this character cell, we will follow up
  1126. * and deal with that next.
  1127. */
  1128. //dump_custom_char("at entry:", &new_char);
  1129. clear_custom_char(&new_char);
  1130. const uint8_t ypix = min(upper_left.y_pixel_offset + pixels_per_y_mesh_pnt, ULTRA_Y_PIXELS_PER_CHAR);
  1131. for (j = upper_left.y_pixel_offset; j < ypix; j++) {
  1132. i = upper_left.x_pixel_mask;
  1133. for (k = 0; k < pixels_per_x_mesh_pnt; k++) {
  1134. new_char.custom_char_bits[j] |= i;
  1135. i >>= 1;
  1136. }
  1137. }
  1138. //dump_custom_char("after loops:", &new_char);
  1139. add_edges_to_custom_char(&new_char, &upper_left, &lower_right, &bottom_right_corner, TOP_LEFT);
  1140. //dump_custom_char("after add edges", &new_char);
  1141. lcd.createChar(4, (uint8_t*)&new_char);
  1142. lcd.setCursor(upper_left.column, upper_left.row);
  1143. lcd.write(0x04);
  1144. //dump_custom_char("after lcd update:", &new_char);
  1145. /**
  1146. * Next, check for two side by side character cells being used to display the Mesh Point
  1147. * If found... do the right hand character cell next.
  1148. */
  1149. if (upper_left.column == lower_right.column - 1) {
  1150. l = upper_left.x_pixel_offset;
  1151. clear_custom_char(&new_char);
  1152. for (j = upper_left.y_pixel_offset; j < ypix; j++) {
  1153. i = _BV(ULTRA_X_PIXELS_PER_CHAR - 1); // Fill in the left side of the right character cell
  1154. for (k = 0; k < pixels_per_x_mesh_pnt - 1 - l; k++) {
  1155. new_char.custom_char_bits[j] |= i;
  1156. i >>= 1;
  1157. }
  1158. }
  1159. add_edges_to_custom_char(&new_char, &upper_left, &lower_right, &bottom_right_corner, TOP_RIGHT);
  1160. lcd.createChar(5, (uint8_t *) &new_char);
  1161. lcd.setCursor(lower_right.column, upper_left.row);
  1162. lcd.write(0x05);
  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 = ULTRA_Y_PIXELS_PER_CHAR - 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. add_edges_to_custom_char(&new_char, &upper_left, &lower_right, &bottom_right_corner, LOWER_LEFT);
  1179. lcd.createChar(6, (uint8_t *) &new_char);
  1180. lcd.setCursor(upper_left.column, lower_right.row);
  1181. lcd.write(0x06);
  1182. }
  1183. /**
  1184. * Next, check for four character cells being used to display the Mesh Point. If that is
  1185. * what is here, we work to fill in the character cell that is down one and to the right one
  1186. * from the upper_left character cell.
  1187. */
  1188. if (upper_left.column == lower_right.column - 1 && upper_left.row == lower_right.row - 1) {
  1189. l = ULTRA_Y_PIXELS_PER_CHAR - upper_left.y_pixel_offset; // Number of pixel rows in top character cell
  1190. k = pixels_per_y_mesh_pnt - l; // Number of pixel rows in bottom character cell
  1191. clear_custom_char(&new_char);
  1192. for (j = 0; j < k; j++) {
  1193. l = upper_left.x_pixel_offset;
  1194. i = _BV(ULTRA_X_PIXELS_PER_CHAR - 1); // Fill in the left side of the right character cell
  1195. for (m = 0; m < pixels_per_x_mesh_pnt - 1 - l; m++) { // Fill in the top side of the bottom character cell
  1196. new_char.custom_char_bits[j] |= i;
  1197. i >>= 1;
  1198. }
  1199. }
  1200. add_edges_to_custom_char(&new_char, &upper_left, &lower_right, &bottom_right_corner, LOWER_RIGHT);
  1201. lcd.createChar(7, (uint8_t*)&new_char);
  1202. lcd.setCursor(lower_right.column, lower_right.row);
  1203. lcd.write(0x07);
  1204. }
  1205. #endif
  1206. /**
  1207. * Print plot position
  1208. */
  1209. lcd.setCursor(_LCD_W_POS, 0);
  1210. lcd.write('(');
  1211. lcd.print(x);
  1212. lcd.write(',');
  1213. lcd.print(inverted_y);
  1214. lcd.write(')');
  1215. #if LCD_HEIGHT <= 3 // 16x2 or 20x2 display
  1216. /**
  1217. * Print Z values
  1218. */
  1219. _ZLABEL(_LCD_W_POS, 1);
  1220. if (!isnan(ubl.z_values[x][inverted_y]))
  1221. lcd.print(ftostr43sign(ubl.z_values[x][inverted_y]));
  1222. else
  1223. lcd_printPGM(PSTR(" -----"));
  1224. #else // 16x4 or 20x4 display
  1225. /**
  1226. * Show all values at right of screen
  1227. */
  1228. _XLABEL(_LCD_W_POS, 1);
  1229. lcd.print(ftostr32(LOGICAL_X_POSITION(pgm_read_float(&ubl._mesh_index_to_xpos[x]))));
  1230. _YLABEL(_LCD_W_POS, 2);
  1231. lcd.print(ftostr32(LOGICAL_Y_POSITION(pgm_read_float(&ubl._mesh_index_to_ypos[inverted_y]))));
  1232. /**
  1233. * Show the location value
  1234. */
  1235. _ZLABEL(_LCD_W_POS, 3);
  1236. if (!isnan(ubl.z_values[x][inverted_y]))
  1237. lcd.print(ftostr43sign(ubl.z_values[x][inverted_y]));
  1238. else
  1239. lcd_printPGM(PSTR(" -----"));
  1240. #endif // LCD_HEIGHT > 3
  1241. }
  1242. void add_edges_to_custom_char(custom_char * const custom, coordinate * const ul, coordinate * const lr, coordinate * const brc, uint8_t cell_location) {
  1243. uint8_t i, k;
  1244. int16_t n_rows = lr->row - ul->row + 1,
  1245. n_cols = lr->column - ul->column + 1;
  1246. /**
  1247. * Check if Top line of box needs to be filled in
  1248. */
  1249. if (ul->row == 0 && ((cell_location & TOP_LEFT) || (cell_location & TOP_RIGHT))) { // Only fill in the top line for the top character cells
  1250. if (n_cols == 1) {
  1251. if (ul->column != brc->column)
  1252. custom->custom_char_bits[0] = 0xFF; // Single column in middle
  1253. else
  1254. for (i = brc->x_pixel_offset; i < ULTRA_X_PIXELS_PER_CHAR; i++) // Single column on right side
  1255. SBI(custom->custom_char_bits[0], i);
  1256. }
  1257. else if ((cell_location & TOP_LEFT) || lr->column != brc->column) // Multiple column in the middle or with right cell in middle
  1258. custom->custom_char_bits[0] = 0xFF;
  1259. else
  1260. for (i = brc->x_pixel_offset; i < ULTRA_X_PIXELS_PER_CHAR; i++)
  1261. SBI(custom->custom_char_bits[0], i);
  1262. }
  1263. /**
  1264. * Check if left line of box needs to be filled in
  1265. */
  1266. if ((cell_location & TOP_LEFT) || (cell_location & LOWER_LEFT)) {
  1267. if (ul->column == 0) { // Left column of characters on LCD Display
  1268. k = ul->row == brc->row ? brc->y_pixel_offset : ULTRA_Y_PIXELS_PER_CHAR; // If it isn't the last row... do the full character cell
  1269. for (i = 0; i < k; i++)
  1270. SBI(custom->custom_char_bits[i], ULTRA_X_PIXELS_PER_CHAR - 1);
  1271. }
  1272. }
  1273. /**
  1274. * Check if bottom line of box needs to be filled in
  1275. */
  1276. // Single row of mesh plot cells
  1277. if (n_rows == 1 /* && (cell_location == TOP_LEFT || cell_location == TOP_RIGHT) */ && ul->row == brc->row) {
  1278. if (n_cols == 1) // Single row, single column case
  1279. k = ul->column == brc->column ? brc->x_pixel_mask : 0x01;
  1280. else if (cell_location & TOP_RIGHT) // Single row, multiple column case
  1281. k = lr->column == brc->column ? brc->x_pixel_mask : 0x01;
  1282. else // Single row, left of multiple columns
  1283. k = 0x01;
  1284. while (k < _BV(ULTRA_X_PIXELS_PER_CHAR)) {
  1285. custom->custom_char_bits[brc->y_pixel_offset] |= k;
  1286. k <<= 1;
  1287. }
  1288. }
  1289. // Double row of characters on LCD Display
  1290. // And this is a bottom custom character
  1291. if (n_rows == 2 && (cell_location == LOWER_LEFT || cell_location == LOWER_RIGHT) && lr->row == brc->row) {
  1292. if (n_cols == 1) // Double row, single column case
  1293. k = ul->column == brc->column ? brc->x_pixel_mask : 0x01;
  1294. else if (cell_location & LOWER_RIGHT) // Double row, multiple column case
  1295. k = lr->column == brc->column ? brc->x_pixel_mask : 0x01;
  1296. else // Double row, left of multiple columns
  1297. k = 0x01;
  1298. while (k < _BV(ULTRA_X_PIXELS_PER_CHAR)) {
  1299. custom->custom_char_bits[brc->y_pixel_offset] |= k;
  1300. k <<= 1;
  1301. }
  1302. }
  1303. /**
  1304. * Check if right line of box needs to be filled in
  1305. */
  1306. // Nothing to do if the lower right part of the mesh pnt isn't in the same column as the box line
  1307. if (lr->column == brc->column) {
  1308. // This mesh point is in the same character cell as the right box line
  1309. if (ul->column == brc->column || (cell_location & TOP_RIGHT) || (cell_location & LOWER_RIGHT)) {
  1310. // If not the last row... do the full character cell
  1311. k = ul->row == brc->row ? brc->y_pixel_offset : ULTRA_Y_PIXELS_PER_CHAR;
  1312. for (i = 0; i < k; i++) custom->custom_char_bits[i] |= brc->x_pixel_mask;
  1313. }
  1314. }
  1315. }
  1316. #endif // AUTO_BED_LEVELING_UBL
  1317. #endif // ULTIPANEL
  1318. #endif // ULTRALCD_IMPL_HD44780_H