123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599 |
- /**
- * Marlin 3D Printer Firmware
- * Copyright (c) 2019 MarlinFirmware [https://github.com/MarlinFirmware/Marlin]
- *
- * Based on Sprinter and grbl.
- * Copyright (c) 2011 Camiel Gubbels / Erik van der Zalm
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU General Public License as published by
- * the Free Software Foundation, either version 3 of the License, or
- * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU General Public License for more details.
- *
- * You should have received a copy of the GNU General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
-
- #include "../inc/MarlinConfigPre.h"
-
- #ifdef LED_BACKLIGHT_TIMEOUT
- #include "../feature/leds/leds.h"
- #endif
-
- #if ENABLED(HOST_ACTION_COMMANDS)
- #include "../feature/host_actions.h"
- #endif
-
- // All displays share the MarlinUI class
- #include "ultralcd.h"
- MarlinUI ui;
-
- #if HAS_DISPLAY
- #include "../module/printcounter.h"
- #include "../MarlinCore.h"
- #include "../gcode/queue.h"
- #include "fontutils.h"
- #include "../sd/cardreader.h"
- #if ENABLED(EXTENSIBLE_UI)
- #define START_OF_UTF8_CHAR(C) (((C) & 0xC0u) != 0x80u)
- #endif
- #endif
-
- #if HAS_SPI_LCD
- #if ENABLED(STATUS_MESSAGE_SCROLLING)
- uint8_t MarlinUI::status_scroll_offset; // = 0
- constexpr uint8_t MAX_MESSAGE_LENGTH = _MAX(LONG_FILENAME_LENGTH, MAX_LANG_CHARSIZE * 2 * (LCD_WIDTH));
- #else
- constexpr uint8_t MAX_MESSAGE_LENGTH = MAX_LANG_CHARSIZE * (LCD_WIDTH);
- #endif
- #elif ENABLED(EXTENSIBLE_UI)
- constexpr uint8_t MAX_MESSAGE_LENGTH = 63;
- #endif
-
- #if HAS_SPI_LCD || ENABLED(EXTENSIBLE_UI)
- uint8_t MarlinUI::alert_level; // = 0
- char MarlinUI::status_message[MAX_MESSAGE_LENGTH + 1];
- #endif
-
- #if ENABLED(LCD_SET_PROGRESS_MANUALLY)
- MarlinUI::progress_t MarlinUI::progress_override; // = 0
- #if BOTH(LCD_SET_PROGRESS_MANUALLY, USE_M73_REMAINING_TIME)
- uint32_t MarlinUI::remaining_time;
- #endif
- #endif
-
- #if ENABLED(PCA9632_BUZZER) || USE_BEEPER
- #include "../libs/buzzer.h" // for BUZZ() macro
- #if ENABLED(PCA9632_BUZZER)
- #include "../feature/leds/pca9632.h"
- #endif
- void MarlinUI::buzz(const long duration, const uint16_t freq) {
- #if ENABLED(PCA9632_BUZZER)
- pca9632_buzz(duration, freq);
- #elif USE_BEEPER
- buzzer.tone(duration, freq);
- #endif
- }
- #endif
-
- #if HAS_SPI_LCD
-
- #if HAS_GRAPHICAL_LCD
- #include "dogm/ultralcd_DOGM.h"
- #endif
-
- #include "lcdprint.h"
-
- #include "../sd/cardreader.h"
- #include "../module/temperature.h"
- #include "../module/planner.h"
- #include "../module/motion.h"
-
- #if ENABLED(AUTO_BED_LEVELING_UBL)
- #include "../feature/bedlevel/bedlevel.h"
- #endif
-
- #if HAS_TRINAMIC
- #include "../feature/tmc_util.h"
- #endif
-
- #if HAS_ADC_BUTTONS
- #include "../module/thermistor/thermistors.h"
- #endif
-
- #if HAS_ENCODER_ACTION
- volatile uint8_t MarlinUI::buttons;
- #if HAS_SLOW_BUTTONS
- volatile uint8_t MarlinUI::slow_buttons;
- #endif
- #if ENABLED(TOUCH_BUTTONS)
- #include "../feature/touch/xpt2046.h"
- #endif
- #endif
-
- #if ENABLED(INIT_SDCARD_ON_BOOT)
- uint8_t lcd_sd_status;
- #endif
-
- #if HAS_LCD_MENU && LCD_TIMEOUT_TO_STATUS
- bool MarlinUI::defer_return_to_status;
- #endif
-
- uint8_t MarlinUI::lcd_status_update_delay = 1; // First update one loop delayed
-
- #if BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
- millis_t MarlinUI::next_filament_display; // = 0
- #endif
-
- millis_t MarlinUI::next_button_update_ms; // = 0
-
- #if HAS_GRAPHICAL_LCD
- bool MarlinUI::drawing_screen, MarlinUI::first_page; // = false
- #endif
-
- // Encoder Handling
- #if HAS_ENCODER_ACTION
- uint32_t MarlinUI::encoderPosition;
- volatile int8_t encoderDiff; // Updated in update_buttons, added to encoderPosition every LCD update
- #endif
-
- #if HAS_LCD_MENU
- #include "menu/menu.h"
- #include "../sd/cardreader.h"
-
- #if ENABLED(SDSUPPORT)
-
- #if ENABLED(SCROLL_LONG_FILENAMES)
- uint8_t MarlinUI::filename_scroll_pos, MarlinUI::filename_scroll_max;
- #endif
-
- const char * MarlinUI::scrolled_filename(CardReader &theCard, const uint8_t maxlen, uint8_t hash, const bool doScroll) {
- const char *outstr = theCard.longest_filename();
- if (theCard.longFilename[0]) {
- #if ENABLED(SCROLL_LONG_FILENAMES)
- if (doScroll) {
- for (uint8_t l = FILENAME_LENGTH; l--;)
- hash = ((hash << 1) | (hash >> 7)) ^ theCard.filename[l]; // rotate, xor
- static uint8_t filename_scroll_hash;
- if (filename_scroll_hash != hash) { // If the hash changed...
- filename_scroll_hash = hash; // Save the new hash
- filename_scroll_max = _MAX(0, utf8_strlen(theCard.longFilename) - maxlen); // Update the scroll limit
- filename_scroll_pos = 0; // Reset scroll to the start
- lcd_status_update_delay = 8; // Don't scroll right away
- }
- outstr += filename_scroll_pos;
- }
- #else
- theCard.longFilename[maxlen] = '\0'; // cutoff at screen edge
- #endif
- }
- return outstr;
- }
-
- #endif
-
- screenFunc_t MarlinUI::currentScreen; // Initialized in CTOR
- bool MarlinUI::screen_changed;
-
- #if ENABLED(ENCODER_RATE_MULTIPLIER)
- bool MarlinUI::encoderRateMultiplierEnabled;
- millis_t MarlinUI::lastEncoderMovementMillis = 0;
- void MarlinUI::enable_encoder_multiplier(const bool onoff) {
- encoderRateMultiplierEnabled = onoff;
- lastEncoderMovementMillis = 0;
- }
- #endif
-
- #if EITHER(REVERSE_MENU_DIRECTION, REVERSE_SELECT_DIRECTION)
- int8_t MarlinUI::encoderDirection = ENCODERBASE;
- #endif
-
- #if ENABLED(TOUCH_BUTTONS)
- uint8_t MarlinUI::touch_buttons;
- uint8_t MarlinUI::repeat_delay;
- #endif
-
- bool MarlinUI::lcd_clicked;
- float move_menu_scale;
-
- bool MarlinUI::use_click() {
- const bool click = lcd_clicked;
- lcd_clicked = false;
- return click;
- }
-
- #if EITHER(AUTO_BED_LEVELING_UBL, G26_MESH_VALIDATION)
-
- bool MarlinUI::external_control; // = false
-
- void MarlinUI::wait_for_release() {
- while (button_pressed()) safe_delay(50);
- safe_delay(50);
- }
-
- #endif
-
- void _wrap_string(uint8_t &col, uint8_t &row, const char * const string, read_byte_cb_t cb_read_byte, bool wordwrap/*=false*/) {
- SETCURSOR(col, row);
- if (!string) return;
-
- auto _newline = [&col, &row]() {
- col = 0; row++; // Move col to string len (plus space)
- SETCURSOR(0, row); // Simulate carriage return
- };
-
- uint8_t *p = (uint8_t*)string;
- wchar_t ch;
- if (wordwrap) {
- uint8_t *wrd = nullptr, c = 0;
- // find the end of the part
- for (;;) {
- if (!wrd) wrd = p; // Get word start /before/ advancing
- p = get_utf8_value_cb(p, cb_read_byte, &ch);
- const bool eol = !ch; // zero ends the string
- // End or a break between phrases?
- if (eol || ch == ' ' || ch == '-' || ch == '+' || ch == '.') {
- if (!c && ch == ' ') { if (wrd) wrd++; continue; } // collapse extra spaces
- // Past the right and the word is not too long?
- if (col + c > LCD_WIDTH && col >= (LCD_WIDTH) / 4) _newline(); // should it wrap?
- c += !eol; // +1 so the space will be printed
- col += c; // advance col to new position
- while (c) { // character countdown
- --c; // count down to zero
- wrd = get_utf8_value_cb(wrd, cb_read_byte, &ch); // get characters again
- lcd_put_wchar(ch); // character to the LCD
- }
- if (eol) break; // all done!
- wrd = nullptr; // set up for next word
- }
- else c++; // count word characters
- }
- }
- else {
- for (;;) {
- p = get_utf8_value_cb(p, cb_read_byte, &ch);
- if (!ch) break;
- lcd_put_wchar(ch);
- col++;
- if (col >= LCD_WIDTH) _newline();
- }
- }
- }
-
- void MarlinUI::draw_select_screen_prompt(PGM_P const pref, const char * const string/*=nullptr*/, PGM_P const suff/*=nullptr*/) {
- const uint8_t plen = utf8_strlen_P(pref), slen = suff ? utf8_strlen_P(suff) : 0;
- uint8_t col = 0, row = 0;
- if (!string && plen + slen <= LCD_WIDTH) {
- col = (LCD_WIDTH - plen - slen) / 2;
- row = LCD_HEIGHT > 3 ? 1 : 0;
- }
- wrap_string_P(col, row, pref, true);
- if (string) {
- if (col) { col = 0; row++; } // Move to the start of the next line
- wrap_string(col, row, string);
- }
- if (suff) wrap_string_P(col, row, suff);
- }
-
- #endif // HAS_LCD_MENU
-
- void MarlinUI::init() {
-
- init_lcd();
-
- #if HAS_DIGITAL_BUTTONS
-
- #if BUTTON_EXISTS(EN1)
- SET_INPUT_PULLUP(BTN_EN1);
- #endif
- #if BUTTON_EXISTS(EN2)
- SET_INPUT_PULLUP(BTN_EN2);
- #endif
- #if BUTTON_EXISTS(ENC)
- SET_INPUT_PULLUP(BTN_ENC);
- #endif
-
- #if BUTTON_EXISTS(BACK)
- SET_INPUT_PULLUP(BTN_BACK);
- #endif
-
- #if BUTTON_EXISTS(UP)
- SET_INPUT(BTN_UP);
- #endif
- #if BUTTON_EXISTS(DWN)
- SET_INPUT(BTN_DWN);
- #endif
- #if BUTTON_EXISTS(LFT)
- SET_INPUT(BTN_LFT);
- #endif
- #if BUTTON_EXISTS(RT)
- SET_INPUT(BTN_RT);
- #endif
-
- #endif // !HAS_DIGITAL_BUTTONS
-
- #if HAS_SHIFT_ENCODER
-
- #if ENABLED(SR_LCD_2W_NL) // Non latching 2 wire shift register
-
- SET_OUTPUT(SR_DATA_PIN);
- SET_OUTPUT(SR_CLK_PIN);
-
- #elif defined(SHIFT_CLK)
-
- SET_OUTPUT(SHIFT_CLK);
- OUT_WRITE(SHIFT_LD, HIGH);
- #if defined(SHIFT_EN) && SHIFT_EN >= 0
- OUT_WRITE(SHIFT_EN, LOW);
- #endif
- SET_INPUT_PULLUP(SHIFT_OUT);
-
- #endif
-
- #endif // HAS_SHIFT_ENCODER
-
- #if ENABLED(SDSUPPORT)
- #if PIN_EXISTS(SD_DETECT)
- SET_INPUT_PULLUP(SD_DETECT_PIN);
- #endif
- #if ENABLED(INIT_SDCARD_ON_BOOT)
- lcd_sd_status = 2; // UNKNOWN
- #endif
- #endif
-
- #if HAS_ENCODER_ACTION
- #if HAS_SLOW_BUTTONS
- slow_buttons = 0;
- #endif
- #endif
-
- update_buttons();
-
- #if HAS_ENCODER_ACTION
- encoderDiff = 0;
- #endif
- }
-
- bool MarlinUI::get_blink() {
- static uint8_t blink = 0;
- static millis_t next_blink_ms = 0;
- millis_t ms = millis();
- if (ELAPSED(ms, next_blink_ms)) {
- blink ^= 0xFF;
- next_blink_ms = ms + 1000 - (LCD_UPDATE_INTERVAL) / 2;
- }
- return blink != 0;
- }
-
- ////////////////////////////////////////////
- ///////////// Keypad Handling //////////////
- ////////////////////////////////////////////
-
- #if ENABLED(REPRAPWORLD_KEYPAD) && HAS_ENCODER_ACTION
-
- volatile uint8_t MarlinUI::keypad_buttons;
-
- #if HAS_LCD_MENU && !HAS_ADC_BUTTONS
-
- void lcd_move_x();
- void lcd_move_y();
- void lcd_move_z();
-
- void _reprapworld_keypad_move(const AxisEnum axis, const int16_t dir) {
- move_menu_scale = REPRAPWORLD_KEYPAD_MOVE_STEP;
- encoderPosition = dir;
- switch (axis) {
- case X_AXIS: lcd_move_x(); break;
- case Y_AXIS: lcd_move_y(); break;
- case Z_AXIS: lcd_move_z();
- default: break;
- }
- }
-
- #endif
-
- bool MarlinUI::handle_keypad() {
-
- #if HAS_ADC_BUTTONS
-
- #define ADC_MIN_KEY_DELAY 100
- if (keypad_buttons) {
- #if HAS_ENCODER_ACTION
- refresh(LCDVIEW_REDRAW_NOW);
- #if HAS_LCD_MENU
- if (encoderDirection == -(ENCODERBASE)) { // ADC_KEYPAD forces REVERSE_MENU_DIRECTION, so this indicates menu navigation
- if (RRK(EN_KEYPAD_UP)) encoderPosition += ENCODER_STEPS_PER_MENU_ITEM;
- else if (RRK(EN_KEYPAD_DOWN)) encoderPosition -= ENCODER_STEPS_PER_MENU_ITEM;
- else if (RRK(EN_KEYPAD_LEFT)) { MenuItem_back::action(); quick_feedback(); }
- else if (RRK(EN_KEYPAD_RIGHT)) { return_to_status(); quick_feedback(); }
- }
- else
- #endif
- {
- #if HAS_LCD_MENU
- if (RRK(EN_KEYPAD_UP)) encoderPosition -= ENCODER_PULSES_PER_STEP;
- else if (RRK(EN_KEYPAD_DOWN)) encoderPosition += ENCODER_PULSES_PER_STEP;
- else if (RRK(EN_KEYPAD_LEFT)) { MenuItem_back::action(); quick_feedback(); }
- else if (RRK(EN_KEYPAD_RIGHT)) encoderPosition = 0;
- #else
- if (RRK(EN_KEYPAD_UP) || RRK(EN_KEYPAD_LEFT)) encoderPosition -= ENCODER_PULSES_PER_STEP;
- else if (RRK(EN_KEYPAD_DOWN) || RRK(EN_KEYPAD_RIGHT)) encoderPosition += ENCODER_PULSES_PER_STEP;
- #endif
- }
- #endif
- next_button_update_ms = millis() + ADC_MIN_KEY_DELAY;
- return true;
- }
-
- #else // !HAS_ADC_BUTTONS
-
- static uint8_t keypad_debounce = 0;
-
- if (!RRK( EN_KEYPAD_F1 | EN_KEYPAD_F2
- | EN_KEYPAD_F3 | EN_KEYPAD_DOWN
- | EN_KEYPAD_RIGHT | EN_KEYPAD_MIDDLE
- | EN_KEYPAD_UP | EN_KEYPAD_LEFT )
- ) {
- if (keypad_debounce > 0) keypad_debounce--;
- }
- else if (!keypad_debounce) {
- keypad_debounce = 2;
-
- const bool homed = all_axes_homed();
-
- #if HAS_LCD_MENU
-
- if (RRK(EN_KEYPAD_MIDDLE)) goto_screen(menu_move);
-
- #if DISABLED(DELTA) && Z_HOME_DIR < 0
- if (RRK(EN_KEYPAD_F2)) _reprapworld_keypad_move(Z_AXIS, 1);
- #endif
-
- if (homed) {
- #if ENABLED(DELTA) || Z_HOME_DIR != -1
- if (RRK(EN_KEYPAD_F2)) _reprapworld_keypad_move(Z_AXIS, 1);
- #endif
- if (RRK(EN_KEYPAD_F3)) _reprapworld_keypad_move(Z_AXIS, -1);
- if (RRK(EN_KEYPAD_LEFT)) _reprapworld_keypad_move(X_AXIS, -1);
- if (RRK(EN_KEYPAD_RIGHT)) _reprapworld_keypad_move(X_AXIS, 1);
- if (RRK(EN_KEYPAD_DOWN)) _reprapworld_keypad_move(Y_AXIS, 1);
- if (RRK(EN_KEYPAD_UP)) _reprapworld_keypad_move(Y_AXIS, -1);
- }
-
- #endif // HAS_LCD_MENU
-
- if (!homed && RRK(EN_KEYPAD_F1)) queue.inject_P(G28_STR);
- return true;
- }
-
- #endif // !ADC_KEYPAD
-
- return false;
- }
-
- #endif // REPRAPWORLD_KEYPAD
-
- /**
- * Status Screen
- *
- * This is very display-dependent, so the lcd implementation draws this.
- */
-
- #if ENABLED(LCD_PROGRESS_BAR)
- millis_t MarlinUI::progress_bar_ms; // = 0
- #if PROGRESS_MSG_EXPIRE > 0
- millis_t MarlinUI::expire_status_ms; // = 0
- #endif
- #endif
-
- void MarlinUI::status_screen() {
-
- #if HAS_LCD_MENU
- ENCODER_RATE_MULTIPLY(false);
- #endif
-
- #if ENABLED(LCD_PROGRESS_BAR)
-
- //
- // HD44780 implements the following message blinking and
- // message expiration because Status Line and Progress Bar
- // share the same line on the display.
- //
-
- #if DISABLED(PROGRESS_MSG_ONCE) || (PROGRESS_MSG_EXPIRE > 0)
- #define GOT_MS
- const millis_t ms = millis();
- #endif
-
- // If the message will blink rather than expire...
- #if DISABLED(PROGRESS_MSG_ONCE)
- if (ELAPSED(ms, progress_bar_ms + PROGRESS_BAR_MSG_TIME + PROGRESS_BAR_BAR_TIME))
- progress_bar_ms = ms;
- #endif
-
- #if PROGRESS_MSG_EXPIRE > 0
-
- // Handle message expire
- if (expire_status_ms > 0) {
-
- // Expire the message if a job is active and the bar has ticks
- if (get_progress_percent() > 2 && !print_job_timer.isPaused()) {
- if (ELAPSED(ms, expire_status_ms)) {
- status_message[0] = '\0';
- expire_status_ms = 0;
- }
- }
- else {
- // Defer message expiration before bar appears
- // and during any pause (not just SD)
- expire_status_ms += LCD_UPDATE_INTERVAL;
- }
- }
-
- #endif // PROGRESS_MSG_EXPIRE
-
- #endif // LCD_PROGRESS_BAR
-
- #if HAS_LCD_MENU
-
- if (use_click()) {
- #if BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
- next_filament_display = millis() + 5000UL; // Show status message for 5s
- #endif
- goto_screen(menu_main);
- #if DISABLED(NO_LCD_REINIT)
- init_lcd(); // May revive the LCD if static electricity killed it
- #endif
- return;
- }
-
- #endif
-
- #if ENABLED(ULTIPANEL_FEEDMULTIPLY)
-
- const int16_t old_frm = feedrate_percentage;
- int16_t new_frm = old_frm + int16_t(encoderPosition);
-
- // Dead zone at 100% feedrate
- if (old_frm == 100) {
- if (int16_t(encoderPosition) > ENCODER_FEEDRATE_DEADZONE)
- new_frm -= ENCODER_FEEDRATE_DEADZONE;
- else if (int16_t(encoderPosition) < -(ENCODER_FEEDRATE_DEADZONE))
- new_frm += ENCODER_FEEDRATE_DEADZONE;
- else
- new_frm = old_frm;
- }
- else if ((old_frm < 100 && new_frm > 100) || (old_frm > 100 && new_frm < 100))
- new_frm = 100;
-
- LIMIT(new_frm, 10, 999);
-
- if (old_frm != new_frm) {
- feedrate_percentage = new_frm;
- encoderPosition = 0;
- #if HAS_BUZZER && ENABLED(BEEP_ON_FEEDRATE_CHANGE)
- static millis_t next_beep;
- #ifndef GOT_MS
- const millis_t ms = millis();
- #endif
- if (ELAPSED(ms, next_beep)) {
- buzz(FEEDRATE_CHANGE_BEEP_DURATION, FEEDRATE_CHANGE_BEEP_FREQUENCY);
- next_beep = ms + 500UL;
- }
- #endif
- }
-
- #endif // ULTIPANEL_FEEDMULTIPLY
-
- draw_status_screen();
- }
-
- void MarlinUI::kill_screen(PGM_P lcd_error, PGM_P lcd_component) {
- init();
- status_printf_P(1, PSTR(S_FMT ": " S_FMT), lcd_error, lcd_component);
- #if HAS_LCD_MENU
- return_to_status();
- #endif
-
- // RED ALERT. RED ALERT.
- #ifdef LED_BACKLIGHT_TIMEOUT
- leds.set_color(LEDColorRed());
- #ifdef NEOPIXEL_BKGD_LED_INDEX
- neo.set_pixel_color(NEOPIXEL_BKGD_LED_INDEX, 255, 0, 0, 0);
- neo.show();
- #endif
- #endif
-
- draw_kill_screen();
- }
-
- void MarlinUI::quick_feedback(const bool clear_buttons/*=true*/) {
-
- #if HAS_LCD_MENU
- refresh();
- #endif
-
- #if HAS_ENCODER_ACTION
- if (clear_buttons) buttons = 0;
- next_button_update_ms = millis() + 500;
- #else
- UNUSED(clear_buttons);
- #endif
-
- #if HAS_BUZZER
- // Buzz and wait. Is the delay needed for buttons to settle?
- buzz(LCD_FEEDBACK_FREQUENCY_DURATION_MS, LCD_FEEDBACK_FREQUENCY_HZ);
- #if HAS_LCD_MENU
- #if USE_BEEPER
- for (int8_t i = 5; i--;) { buzzer.tick(); delay(2); }
- #else
- delay(10);
- #endif
- #endif
- #endif
- }
-
- ////////////////////////////////////////////
- /////////////// Manual Move ////////////////
- ////////////////////////////////////////////
-
- #if HAS_LCD_MENU
-
- extern bool no_reentry; // Flag to prevent recursion into menu handlers
-
- int8_t manual_move_axis = (int8_t)NO_AXIS;
- millis_t manual_move_start_time = 0;
-
- #if IS_KINEMATIC
- bool MarlinUI::processing_manual_move = false;
- float manual_move_offset = 0;
- #endif
-
- #if E_MANUAL > 1
- int8_t MarlinUI::manual_move_e_index = 0;
- #endif
-
- /**
- * If the most recent manual move hasn't been fed to the planner yet,
- * and the planner can accept one, send a move immediately.
- */
- void MarlinUI::manage_manual_move() {
-
- if (processing_manual_move) return;
-
- if (manual_move_axis != (int8_t)NO_AXIS && ELAPSED(millis(), manual_move_start_time) && !planner.is_full()) {
-
- const feedRate_t fr_mm_s = MMM_TO_MMS(manual_feedrate_mm_m[manual_move_axis]);
- #if IS_KINEMATIC
-
- #if EXTRUDERS > 1
- const int8_t old_extruder = active_extruder;
- if (manual_move_axis == E_AXIS) active_extruder = manual_move_e_index;
- #endif
-
- // Set movement on a single axis
- destination = current_position;
- destination[manual_move_axis] += manual_move_offset;
-
- // Reset for the next move
- manual_move_offset = 0;
- manual_move_axis = (int8_t)NO_AXIS;
-
- // DELTA and SCARA machines use segmented moves, which could fill the planner during the call to
- // move_to_destination. This will cause idle() to be called, which can then call this function while the
- // previous invocation is being blocked. Modifications to manual_move_offset shouldn't be made while
- // processing_manual_move is true or the planner will get out of sync.
- processing_manual_move = true;
- prepare_internal_move_to_destination(fr_mm_s); // will set current_position from destination
- processing_manual_move = false;
-
- #if EXTRUDERS > 1
- active_extruder = old_extruder;
- #endif
-
- #else
-
- planner.buffer_line(current_position, fr_mm_s, manual_move_axis == E_AXIS ? manual_move_e_index : active_extruder);
- manual_move_axis = (int8_t)NO_AXIS;
-
- #endif
- }
- }
-
- #endif // HAS_LCD_MENU
-
- /**
- * Update the LCD, read encoder buttons, etc.
- * - Read button states
- * - Check the SD Card slot state
- * - Act on RepRap World keypad input
- * - Update the encoder position
- * - Apply acceleration to the encoder position
- * - Do refresh(LCDVIEW_CALL_REDRAW_NOW) on controller events
- * - Reset the Info Screen timeout if there's any input
- * - Update status indicators, if any
- *
- * Run the current LCD menu handler callback function:
- * - Call the handler only if lcdDrawUpdate != LCDVIEW_NONE
- * - Before calling the handler, LCDVIEW_CALL_NO_REDRAW => LCDVIEW_NONE
- * - Call the menu handler. Menu handlers should do the following:
- * - If a value changes, set lcdDrawUpdate to LCDVIEW_REDRAW_NOW and draw the value
- * (Encoder events automatically set lcdDrawUpdate for you.)
- * - if (should_draw()) { redraw }
- * - Before exiting the handler set lcdDrawUpdate to:
- * - LCDVIEW_CLEAR_CALL_REDRAW to clear screen and set LCDVIEW_CALL_REDRAW_NEXT.
- * - LCDVIEW_REDRAW_NOW to draw now (including remaining stripes).
- * - LCDVIEW_CALL_REDRAW_NEXT to draw now and get LCDVIEW_REDRAW_NOW on the next loop.
- * - LCDVIEW_CALL_NO_REDRAW to draw now and get LCDVIEW_NONE on the next loop.
- * - NOTE: For graphical displays menu handlers may be called 2 or more times per loop,
- * so don't change lcdDrawUpdate without considering this.
- *
- * After the menu handler callback runs (or not):
- * - Clear the LCD if lcdDrawUpdate == LCDVIEW_CLEAR_CALL_REDRAW
- * - Update lcdDrawUpdate for the next loop (i.e., move one state down, usually)
- *
- * This function is only called from the main thread.
- */
-
- LCDViewAction MarlinUI::lcdDrawUpdate = LCDVIEW_CLEAR_CALL_REDRAW;
-
- void MarlinUI::update() {
-
- static uint16_t max_display_update_time = 0;
- static millis_t next_lcd_update_ms;
- millis_t ms = millis();
-
- #if HAS_LCD_MENU && LCD_TIMEOUT_TO_STATUS
- static millis_t return_to_status_ms = 0;
- #define RESET_STATUS_TIMEOUT() (return_to_status_ms = ms + LCD_TIMEOUT_TO_STATUS)
- #else
- #define RESET_STATUS_TIMEOUT() NOOP
- #endif
-
- #ifdef LED_BACKLIGHT_TIMEOUT
- leds.update_timeout(powersupply_on);
- #endif
-
- #if HAS_LCD_MENU
-
- // Handle any queued Move Axis motion
- manage_manual_move();
-
- // Update button states for button_pressed(), etc.
- // If the state changes the next update may be delayed 300-500ms.
- update_buttons();
-
- // If the action button is pressed...
- static bool wait_for_unclick; // = false
-
- #if ENABLED(TOUCH_BUTTONS)
-
- if (touch_buttons) {
- RESET_STATUS_TIMEOUT();
- if (buttons & (EN_A | EN_B)) { // Menu arrows, in priority
- if (ELAPSED(ms, next_button_update_ms)) {
- encoderDiff = (ENCODER_STEPS_PER_MENU_ITEM) * (ENCODER_PULSES_PER_STEP) * encoderDirection;
- if (buttons & EN_A) encoderDiff *= -1;
- #if ENABLED(AUTO_BED_LEVELING_UBL)
- if (external_control) ubl.encoder_diff = encoderDiff;
- #endif
- next_button_update_ms = ms + repeat_delay; // Assume the repeat delay
- if (!wait_for_unclick) {
- next_button_update_ms += 250; // Longer delay on first press
- wait_for_unclick = true; // Avoid Back/Select click while repeating
- #if HAS_BUZZER
- buzz(LCD_FEEDBACK_FREQUENCY_DURATION_MS, LCD_FEEDBACK_FREQUENCY_HZ);
- #endif
- }
- }
- }
- else if (!wait_for_unclick && (buttons & EN_C)) { // OK button, if not waiting for a debounce release:
- wait_for_unclick = true; // - Set debounce flag to ignore continous clicks
- lcd_clicked = !wait_for_user && !no_reentry; // - Keep the click if not waiting for a user-click
- wait_for_user = false; // - Any click clears wait for user
- quick_feedback(); // - Always make a click sound
- }
- }
- else // keep wait_for_unclick value
-
- #endif // TOUCH_BUTTONS
-
- {
- // Integrated LCD click handling via button_pressed
- if (!external_control && button_pressed()) {
- if (!wait_for_unclick) { // If not waiting for a debounce release:
- wait_for_unclick = true; // - Set debounce flag to ignore continous clicks
- lcd_clicked = !wait_for_user && !no_reentry; // - Keep the click if not waiting for a user-click
- wait_for_user = false; // - Any click clears wait for user
- quick_feedback(); // - Always make a click sound
- }
- }
- else
- wait_for_unclick = false;
- }
-
- if (LCD_BACK_CLICKED()) {
- quick_feedback();
- goto_previous_screen();
- }
-
- #endif // HAS_LCD_MENU
-
- #if ENABLED(INIT_SDCARD_ON_BOOT)
- //
- // SPI SD Card detection (and first card init when the LCD is present)
- //
- const uint8_t sd_status = (uint8_t)IS_SD_INSERTED();
- if (sd_status != lcd_sd_status && detected()) {
-
- uint8_t old_sd_status = lcd_sd_status; // prevent re-entry to this block!
- lcd_sd_status = sd_status;
-
- if (sd_status) {
- safe_delay(500); // Some boards need a delay to get settled
- card.mount();
- if (old_sd_status == 2)
- card.beginautostart(); // Initial boot
- else
- set_status_P(GET_TEXT(MSG_MEDIA_INSERTED));
- }
- #if PIN_EXISTS(SD_DETECT)
- else {
- card.release();
- if (old_sd_status != 2) {
- set_status_P(GET_TEXT(MSG_MEDIA_REMOVED));
- #if HAS_LCD_MENU
- return_to_status();
- #endif
- }
- }
-
- #if DISABLED(NO_LCD_REINIT)
- init_lcd(); // May revive the LCD if static electricity killed it
- #endif
-
- #endif
-
- refresh();
-
- ms = millis();
- next_lcd_update_ms = ms + LCD_UPDATE_INTERVAL; // delay LCD update until after SD activity completes
-
- #ifdef LED_BACKLIGHT_TIMEOUT
- leds.reset_timeout(ms);
- #endif
- }
-
- #endif // INIT_SDCARD_ON_BOOT
-
- if (ELAPSED(ms, next_lcd_update_ms)
- #if HAS_GRAPHICAL_LCD
- || drawing_screen
- #endif
- ) {
-
- next_lcd_update_ms = ms + LCD_UPDATE_INTERVAL;
-
- #if ENABLED(TOUCH_BUTTONS)
-
- if (on_status_screen()) next_lcd_update_ms += (LCD_UPDATE_INTERVAL) * 2;
-
- #if HAS_ENCODER_ACTION
- touch_buttons = touch.read_buttons();
- #endif
-
- #endif
-
- #if ENABLED(LCD_HAS_STATUS_INDICATORS)
- update_indicators();
- #endif
-
- #if HAS_ENCODER_ACTION
-
- #if HAS_SLOW_BUTTONS
- slow_buttons = read_slow_buttons(); // Buttons that take too long to read in interrupt context
- #endif
-
- #if ENABLED(REPRAPWORLD_KEYPAD)
- if (handle_keypad()) RESET_STATUS_TIMEOUT();
- #endif
-
- const float abs_diff = ABS(encoderDiff);
- const bool encoderPastThreshold = (abs_diff >= (ENCODER_PULSES_PER_STEP));
- if (encoderPastThreshold || lcd_clicked) {
- if (encoderPastThreshold) {
-
- #if HAS_LCD_MENU && ENABLED(ENCODER_RATE_MULTIPLIER)
-
- int32_t encoderMultiplier = 1;
-
- if (encoderRateMultiplierEnabled) {
- const float encoderMovementSteps = abs_diff / (ENCODER_PULSES_PER_STEP);
-
- if (lastEncoderMovementMillis) {
- // Note that the rate is always calculated between two passes through the
- // loop and that the abs of the encoderDiff value is tracked.
- const float encoderStepRate = encoderMovementSteps / float(ms - lastEncoderMovementMillis) * 1000;
-
- if (encoderStepRate >= ENCODER_100X_STEPS_PER_SEC) encoderMultiplier = 100;
- else if (encoderStepRate >= ENCODER_10X_STEPS_PER_SEC) encoderMultiplier = 10;
-
- #if ENABLED(ENCODER_RATE_MULTIPLIER_DEBUG)
- SERIAL_ECHO_START();
- SERIAL_ECHOPAIR("Enc Step Rate: ", encoderStepRate);
- SERIAL_ECHOPAIR(" Multiplier: ", encoderMultiplier);
- SERIAL_ECHOPAIR(" ENCODER_10X_STEPS_PER_SEC: ", ENCODER_10X_STEPS_PER_SEC);
- SERIAL_ECHOPAIR(" ENCODER_100X_STEPS_PER_SEC: ", ENCODER_100X_STEPS_PER_SEC);
- SERIAL_EOL();
- #endif
- }
-
- lastEncoderMovementMillis = ms;
- } // encoderRateMultiplierEnabled
-
- #else
-
- constexpr int32_t encoderMultiplier = 1;
-
- #endif // ENCODER_RATE_MULTIPLIER
-
- encoderPosition += (encoderDiff * encoderMultiplier) / (ENCODER_PULSES_PER_STEP);
- encoderDiff = 0;
- }
-
- RESET_STATUS_TIMEOUT();
-
- refresh(LCDVIEW_REDRAW_NOW);
-
- #ifdef LED_BACKLIGHT_TIMEOUT
- leds.reset_timeout(ms);
- #endif
- }
-
- #endif
-
- // This runs every ~100ms when idling often enough.
- // Instead of tracking changes just redraw the Status Screen once per second.
- if (on_status_screen() && !lcd_status_update_delay--) {
- lcd_status_update_delay = 9
- #if HAS_GRAPHICAL_LCD
- + 3
- #endif
- ;
- max_display_update_time--;
- refresh(LCDVIEW_REDRAW_NOW);
- }
-
- #if HAS_LCD_MENU && ENABLED(SCROLL_LONG_FILENAMES)
- // If scrolling of long file names is enabled and we are in the sd card menu,
- // cause a refresh to occur until all the text has scrolled into view.
- if (currentScreen == menu_media && !lcd_status_update_delay--) {
- lcd_status_update_delay = 4;
- if (++filename_scroll_pos > filename_scroll_max) {
- filename_scroll_pos = 0;
- lcd_status_update_delay = 12;
- }
- refresh(LCDVIEW_REDRAW_NOW);
- RESET_STATUS_TIMEOUT();
- }
- #endif
-
- // then we want to use 1/2 of the time only.
- uint16_t bbr2 = planner.block_buffer_runtime() >> 1;
-
- if ((should_draw() || drawing_screen) && (!bbr2 || bbr2 > max_display_update_time)) {
-
- // Change state of drawing flag between screen updates
- if (!drawing_screen) switch (lcdDrawUpdate) {
- case LCDVIEW_CALL_NO_REDRAW:
- refresh(LCDVIEW_NONE);
- break;
- case LCDVIEW_CLEAR_CALL_REDRAW:
- case LCDVIEW_CALL_REDRAW_NEXT:
- refresh(LCDVIEW_REDRAW_NOW);
- case LCDVIEW_REDRAW_NOW: // set above, or by a handler through LCDVIEW_CALL_REDRAW_NEXT
- case LCDVIEW_NONE:
- break;
- } // switch
-
- #if HAS_ADC_BUTTONS
- keypad_buttons = 0;
- #endif
-
- #if HAS_GRAPHICAL_LCD
-
- #if ENABLED(LIGHTWEIGHT_UI)
- const bool in_status = on_status_screen(),
- do_u8g_loop = !in_status;
- lcd_in_status(in_status);
- if (in_status) status_screen();
- #else
- constexpr bool do_u8g_loop = true;
- #endif
-
- if (do_u8g_loop) {
- if (!drawing_screen) { // If not already drawing pages
- u8g.firstPage(); // Start the first page
- drawing_screen = first_page = true; // Flag as drawing pages
- }
- set_font(FONT_MENU); // Setup font for every page draw
- u8g.setColorIndex(1); // And reset the color
- run_current_screen(); // Draw and process the current screen
- first_page = false;
-
- // The screen handler can clear drawing_screen for an action that changes the screen.
- // If still drawing and there's another page, update max-time and return now.
- // The nextPage will already be set up on the next call.
- if (drawing_screen && (drawing_screen = u8g.nextPage())) {
- if (on_status_screen())
- NOLESS(max_display_update_time, millis() - ms);
- return;
- }
- }
-
- #else
-
- run_current_screen();
-
- #endif
-
- #if HAS_LCD_MENU
- lcd_clicked = false;
- #endif
-
- // Keeping track of the longest time for an individual LCD update.
- // Used to do screen throttling when the planner starts to fill up.
- if (on_status_screen())
- NOLESS(max_display_update_time, millis() - ms);
- }
-
- #if HAS_LCD_MENU && LCD_TIMEOUT_TO_STATUS
- // Return to Status Screen after a timeout
- if (on_status_screen() || defer_return_to_status)
- RESET_STATUS_TIMEOUT();
- else if (ELAPSED(ms, return_to_status_ms))
- return_to_status();
- #endif
-
- // Change state of drawing flag between screen updates
- if (!drawing_screen) switch (lcdDrawUpdate) {
- case LCDVIEW_CLEAR_CALL_REDRAW:
- clear_lcd(); break;
- case LCDVIEW_REDRAW_NOW:
- refresh(LCDVIEW_NONE);
- case LCDVIEW_NONE:
- case LCDVIEW_CALL_REDRAW_NEXT:
- case LCDVIEW_CALL_NO_REDRAW:
- default: break;
- } // switch
-
- } // ELAPSED(ms, next_lcd_update_ms)
- }
-
- #if HAS_ADC_BUTTONS
-
- typedef struct {
- uint16_t ADCKeyValueMin, ADCKeyValueMax;
- uint8_t ADCKeyNo;
- } _stADCKeypadTable_;
-
- #ifndef ADC_BUTTONS_VALUE_SCALE
- #define ADC_BUTTONS_VALUE_SCALE 1.0 // for the power voltage equal to the reference voltage
- #endif
- #ifndef ADC_BUTTONS_R_PULLUP
- #define ADC_BUTTONS_R_PULLUP 4.7 // common pull-up resistor in the voltage divider
- #endif
- #ifndef ADC_BUTTONS_LEFT_R_PULLDOWN
- #define ADC_BUTTONS_LEFT_R_PULLDOWN 0.47 // pull-down resistor for LEFT button voltage divider
- #endif
- #ifndef ADC_BUTTONS_RIGHT_R_PULLDOWN
- #define ADC_BUTTONS_RIGHT_R_PULLDOWN 4.7 // pull-down resistor for RIGHT button voltage divider
- #endif
- #ifndef ADC_BUTTONS_UP_R_PULLDOWN
- #define ADC_BUTTONS_UP_R_PULLDOWN 1.0 // pull-down resistor for UP button voltage divider
- #endif
- #ifndef ADC_BUTTONS_DOWN_R_PULLDOWN
- #define ADC_BUTTONS_DOWN_R_PULLDOWN 10.0 // pull-down resistor for DOWN button voltage divider
- #endif
- #ifndef ADC_BUTTONS_MIDDLE_R_PULLDOWN
- #define ADC_BUTTONS_MIDDLE_R_PULLDOWN 2.2 // pull-down resistor for MIDDLE button voltage divider
- #endif
-
- // Calculate the ADC value for the voltage divider with specified pull-down resistor value
- #define ADC_BUTTON_VALUE(r) int(HAL_ADC_RANGE * (ADC_BUTTONS_VALUE_SCALE) * r / (r + ADC_BUTTONS_R_PULLUP))
-
- static constexpr uint16_t adc_button_tolerance = HAL_ADC_RANGE * 25 / 1024,
- adc_other_button = HAL_ADC_RANGE * 1000 / 1024;
- static const _stADCKeypadTable_ stADCKeyTable[] PROGMEM = {
- // VALUE_MIN, VALUE_MAX, KEY
- { adc_other_button, HAL_ADC_RANGE, 1 + BLEN_KEYPAD_F1 }, // F1
- { adc_other_button, HAL_ADC_RANGE, 1 + BLEN_KEYPAD_F2 }, // F2
- { adc_other_button, HAL_ADC_RANGE, 1 + BLEN_KEYPAD_F3 }, // F3
- { ADC_BUTTON_VALUE(ADC_BUTTONS_LEFT_R_PULLDOWN) - adc_button_tolerance,
- ADC_BUTTON_VALUE(ADC_BUTTONS_LEFT_R_PULLDOWN) + adc_button_tolerance, 1 + BLEN_KEYPAD_LEFT }, // LEFT ( 272 ... 472)
- { ADC_BUTTON_VALUE(ADC_BUTTONS_RIGHT_R_PULLDOWN) - adc_button_tolerance,
- ADC_BUTTON_VALUE(ADC_BUTTONS_RIGHT_R_PULLDOWN) + adc_button_tolerance, 1 + BLEN_KEYPAD_RIGHT }, // RIGHT (1948 ... 2148)
- { ADC_BUTTON_VALUE(ADC_BUTTONS_UP_R_PULLDOWN) - adc_button_tolerance,
- ADC_BUTTON_VALUE(ADC_BUTTONS_UP_R_PULLDOWN) + adc_button_tolerance, 1 + BLEN_KEYPAD_UP }, // UP ( 618 ... 818)
- { ADC_BUTTON_VALUE(ADC_BUTTONS_DOWN_R_PULLDOWN) - adc_button_tolerance,
- ADC_BUTTON_VALUE(ADC_BUTTONS_DOWN_R_PULLDOWN) + adc_button_tolerance, 1 + BLEN_KEYPAD_DOWN }, // DOWN (2686 ... 2886)
- { ADC_BUTTON_VALUE(ADC_BUTTONS_MIDDLE_R_PULLDOWN) - adc_button_tolerance,
- ADC_BUTTON_VALUE(ADC_BUTTONS_MIDDLE_R_PULLDOWN) + adc_button_tolerance, 1 + BLEN_KEYPAD_MIDDLE }, // ENTER (1205 ... 1405)
- };
-
- uint8_t get_ADC_keyValue() {
- if (thermalManager.ADCKey_count >= 16) {
- const uint16_t currentkpADCValue = thermalManager.current_ADCKey_raw;
- thermalManager.current_ADCKey_raw = HAL_ADC_RANGE;
- thermalManager.ADCKey_count = 0;
- if (currentkpADCValue < adc_other_button)
- for (uint8_t i = 0; i < ADC_KEY_NUM; i++) {
- const uint16_t lo = pgm_read_word(&stADCKeyTable[i].ADCKeyValueMin),
- hi = pgm_read_word(&stADCKeyTable[i].ADCKeyValueMax);
- if (WITHIN(currentkpADCValue, lo, hi)) return pgm_read_byte(&stADCKeyTable[i].ADCKeyNo);
- }
- }
- return 0;
- }
-
- #endif // HAS_ADC_BUTTONS
-
- #if HAS_ENCODER_ACTION
-
- #if DISABLED(ADC_KEYPAD) && (ENABLED(REPRAPWORLD_KEYPAD) || !HAS_DIGITAL_BUTTONS)
-
- /**
- * Setup Rotary Encoder Bit Values (for two pin encoders to indicate movement)
- * These values are independent of which pins are used for EN_A and EN_B indications
- * The rotary encoder part is also independent to the chipset used for the LCD
- */
- #define GET_SHIFT_BUTTON_STATES(DST) \
- uint8_t new_##DST = 0; \
- WRITE(SHIFT_LD, LOW); \
- WRITE(SHIFT_LD, HIGH); \
- for (int8_t i = 0; i < 8; i++) { \
- new_##DST >>= 1; \
- if (READ(SHIFT_OUT)) SBI(new_##DST, 7); \
- WRITE(SHIFT_CLK, HIGH); \
- WRITE(SHIFT_CLK, LOW); \
- } \
- DST = ~new_##DST; //invert it, because a pressed switch produces a logical 0
-
- #endif
-
- /**
- * Read encoder buttons from the hardware registers
- * Warning: This function is called from interrupt context!
- */
- void MarlinUI::update_buttons() {
- const millis_t now = millis();
- if (ELAPSED(now, next_button_update_ms)) {
-
- #if HAS_DIGITAL_BUTTONS
-
- #if ANY_BUTTON(EN1, EN2, ENC, BACK)
-
- uint8_t newbutton = 0;
-
- #if BUTTON_EXISTS(EN1)
- if (BUTTON_PRESSED(EN1)) newbutton |= EN_A;
- #endif
- #if BUTTON_EXISTS(EN2)
- if (BUTTON_PRESSED(EN2)) newbutton |= EN_B;
- #endif
- #if BUTTON_EXISTS(ENC)
- if (BUTTON_PRESSED(ENC)) newbutton |= EN_C;
- #endif
- #if BUTTON_EXISTS(BACK)
- if (BUTTON_PRESSED(BACK)) newbutton |= EN_D;
- #endif
-
- #else
-
- constexpr uint8_t newbutton = 0;
-
- #endif
-
- //
- // Directional buttons
- //
- #if ANY_BUTTON(UP, DWN, LFT, RT)
-
- const int8_t pulses = (ENCODER_PULSES_PER_STEP) * encoderDirection;
-
- if (false) {
- // for the else-ifs below
- }
- #if BUTTON_EXISTS(UP)
- else if (BUTTON_PRESSED(UP)) {
- encoderDiff = (ENCODER_STEPS_PER_MENU_ITEM) * pulses;
- next_button_update_ms = now + 300;
- }
- #endif
- #if BUTTON_EXISTS(DWN)
- else if (BUTTON_PRESSED(DWN)) {
- encoderDiff = -(ENCODER_STEPS_PER_MENU_ITEM) * pulses;
- next_button_update_ms = now + 300;
- }
- #endif
- #if BUTTON_EXISTS(LFT)
- else if (BUTTON_PRESSED(LFT)) {
- encoderDiff = -pulses;
- next_button_update_ms = now + 300;
- }
- #endif
- #if BUTTON_EXISTS(RT)
- else if (BUTTON_PRESSED(RT)) {
- encoderDiff = pulses;
- next_button_update_ms = now + 300;
- }
- #endif
-
- #endif // UP || DWN || LFT || RT
-
- buttons = (newbutton
- #if HAS_SLOW_BUTTONS
- | slow_buttons
- #endif
- #if ENABLED(TOUCH_BUTTONS) && HAS_ENCODER_ACTION
- | touch_buttons
- #endif
- );
-
- #elif HAS_ADC_BUTTONS
-
- buttons = 0;
-
- #endif
-
- #if HAS_ADC_BUTTONS
- if (keypad_buttons == 0) {
- const uint8_t b = get_ADC_keyValue();
- if (WITHIN(b, 1, 8)) keypad_buttons = _BV(b - 1);
- }
- #endif
-
- #if HAS_SHIFT_ENCODER
-
- GET_SHIFT_BUTTON_STATES((
- #if ENABLED(REPRAPWORLD_KEYPAD)
- keypad_buttons
- #else
- buttons
- #endif
- ));
-
- #endif
-
- } // next_button_update_ms
-
- #if HAS_ENCODER_WHEEL && DISABLED(TOUCH_BUTTONS)
- static uint8_t lastEncoderBits;
-
- #define encrot0 0
- #define encrot1 2
- #define encrot2 3
- #define encrot3 1
-
- // Manage encoder rotation
- #define ENCODER_SPIN(_E1, _E2) switch (lastEncoderBits) { case _E1: encoderDiff += encoderDirection; break; case _E2: encoderDiff -= encoderDirection; }
-
- uint8_t enc = 0;
- if (buttons & EN_A) enc |= B01;
- if (buttons & EN_B) enc |= B10;
- if (enc != lastEncoderBits) {
- switch (enc) {
- case encrot0: ENCODER_SPIN(encrot3, encrot1); break;
- case encrot1: ENCODER_SPIN(encrot0, encrot2); break;
- case encrot2: ENCODER_SPIN(encrot1, encrot3); break;
- case encrot3: ENCODER_SPIN(encrot2, encrot0); break;
- }
- if (external_control) {
- #if ENABLED(AUTO_BED_LEVELING_UBL)
- ubl.encoder_diff = encoderDiff; // Make encoder rotation available to UBL G29 mesh editing.
- #endif
- encoderDiff = 0; // Hide the encoder event from the current screen handler.
- }
- lastEncoderBits = enc;
- }
-
- #endif // HAS_ENCODER_WHEEL
- }
-
- #endif // HAS_ENCODER_ACTION
-
- #endif // HAS_SPI_LCD
-
- #if HAS_DISPLAY
-
- #if ENABLED(EXTENSIBLE_UI)
- #include "extensible_ui/ui_api.h"
- #endif
-
- ////////////////////////////////////////////
- /////////////// Status Line ////////////////
- ////////////////////////////////////////////
-
- #if ENABLED(STATUS_MESSAGE_SCROLLING)
- void MarlinUI::advance_status_scroll() {
- // Advance by one UTF8 code-word
- if (status_scroll_offset < utf8_strlen(status_message))
- while (!START_OF_UTF8_CHAR(status_message[++status_scroll_offset]));
- else
- status_scroll_offset = 0;
- }
- char* MarlinUI::status_and_len(uint8_t &len) {
- char *out = status_message + status_scroll_offset;
- len = utf8_strlen(out);
- return out;
- }
- #endif
-
- void MarlinUI::finish_status(const bool persist) {
-
- #if !(ENABLED(LCD_PROGRESS_BAR) && (PROGRESS_MSG_EXPIRE > 0))
- UNUSED(persist);
- #endif
-
- #if ENABLED(LCD_PROGRESS_BAR)
- progress_bar_ms = millis();
- #if PROGRESS_MSG_EXPIRE > 0
- expire_status_ms = persist ? 0 : progress_bar_ms + PROGRESS_MSG_EXPIRE;
- #endif
- #endif
-
- #if BOTH(FILAMENT_LCD_DISPLAY, SDSUPPORT)
- next_filament_display = millis() + 5000UL; // Show status message for 5s
- #endif
-
- #if HAS_SPI_LCD && ENABLED(STATUS_MESSAGE_SCROLLING)
- status_scroll_offset = 0;
- #endif
-
- #if ENABLED(EXTENSIBLE_UI)
- ExtUI::onStatusChanged(status_message);
- #endif
- }
-
- bool MarlinUI::has_status() { return (status_message[0] != '\0'); }
-
- void MarlinUI::set_status(const char * const message, const bool persist) {
- if (alert_level) return;
-
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_action_notify(message);
- #endif
-
- // Here we have a problem. The message is encoded in UTF8, so
- // arbitrarily cutting it will be a problem. We MUST be sure
- // that there is no cutting in the middle of a multibyte character!
-
- // Get a pointer to the null terminator
- const char* pend = message + strlen(message);
-
- // If length of supplied UTF8 string is greater than
- // our buffer size, start cutting whole UTF8 chars
- while ((pend - message) > MAX_MESSAGE_LENGTH) {
- --pend;
- while (!START_OF_UTF8_CHAR(*pend)) --pend;
- };
-
- // At this point, we have the proper cut point. Use it
- uint8_t maxLen = pend - message;
- strncpy(status_message, message, maxLen);
- status_message[maxLen] = '\0';
-
- finish_status(persist);
- }
-
- #include <stdarg.h>
-
- void MarlinUI::status_printf_P(const uint8_t level, PGM_P const fmt, ...) {
- if (level < alert_level) return;
- alert_level = level;
- va_list args;
- va_start(args, fmt);
- vsnprintf_P(status_message, MAX_MESSAGE_LENGTH, fmt, args);
- va_end(args);
- finish_status(level > 0);
- }
-
- void MarlinUI::set_status_P(PGM_P const message, int8_t level) {
- if (level < 0) level = alert_level = 0;
- if (level < alert_level) return;
- alert_level = level;
-
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_action_notify(message);
- #endif
-
- // Since the message is encoded in UTF8 it must
- // only be cut on a character boundary.
-
- // Get a pointer to the null terminator
- PGM_P pend = message + strlen_P(message);
-
- // If length of supplied UTF8 string is greater than
- // the buffer size, start cutting whole UTF8 chars
- while ((pend - message) > MAX_MESSAGE_LENGTH) {
- --pend;
- while (!START_OF_UTF8_CHAR(pgm_read_byte(pend))) --pend;
- };
-
- // At this point, we have the proper cut point. Use it
- uint8_t maxLen = pend - message;
- strncpy_P(status_message, message, maxLen);
- status_message[maxLen] = '\0';
-
- finish_status(level > 0);
- }
-
- void MarlinUI::set_alert_status_P(PGM_P const message) {
- set_status_P(message, 1);
- #if HAS_LCD_MENU
- return_to_status();
- #endif
- }
-
- PGM_P print_paused = GET_TEXT(MSG_PRINT_PAUSED);
-
- /**
- * Reset the status message
- */
- void MarlinUI::reset_status() {
- PGM_P printing = GET_TEXT(MSG_PRINTING);
- PGM_P welcome = GET_TEXT(WELCOME_MSG);
- #if SERVICE_INTERVAL_1 > 0
- static const char service1[] PROGMEM = { "> " SERVICE_NAME_1 "!" };
- #endif
- #if SERVICE_INTERVAL_2 > 0
- static const char service2[] PROGMEM = { "> " SERVICE_NAME_2 "!" };
- #endif
- #if SERVICE_INTERVAL_3 > 0
- static const char service3[] PROGMEM = { "> " SERVICE_NAME_3 "!" };
- #endif
- PGM_P msg;
- if (printingIsPaused())
- msg = print_paused;
- #if ENABLED(SDSUPPORT)
- else if (IS_SD_PRINTING())
- return set_status(card.longest_filename(), true);
- #endif
- else if (print_job_timer.isRunning())
- msg = printing;
-
- #if SERVICE_INTERVAL_1 > 0
- else if (print_job_timer.needsService(1)) msg = service1;
- #endif
- #if SERVICE_INTERVAL_2 > 0
- else if (print_job_timer.needsService(2)) msg = service2;
- #endif
- #if SERVICE_INTERVAL_3 > 0
- else if (print_job_timer.needsService(3)) msg = service3;
- #endif
-
- else
- msg = welcome;
-
- set_status_P(msg, -1);
- }
-
- #if ENABLED(SDSUPPORT)
- extern bool wait_for_user, wait_for_heatup;
- #endif
-
- void MarlinUI::abort_print() {
- #if ENABLED(SDSUPPORT)
- wait_for_heatup = wait_for_user = false;
- card.flag.abort_sd_printing = true;
- #endif
- #ifdef ACTION_ON_CANCEL
- host_action_cancel();
- #endif
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_prompt_open(PROMPT_INFO, PSTR("UI Aborted"), PSTR("Dismiss"));
- #endif
- print_job_timer.stop();
- set_status_P(GET_TEXT(MSG_PRINT_ABORTED));
- #if HAS_LCD_MENU
- return_to_status();
- #endif
- }
-
- #if ANY(PARK_HEAD_ON_PAUSE, SDSUPPORT)
- #include "../gcode/queue.h"
- #endif
-
- void MarlinUI::pause_print() {
- #if HAS_LCD_MENU
- synchronize(GET_TEXT(MSG_PAUSE_PRINT));
- #endif
-
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_prompt_open(PROMPT_PAUSE_RESUME, PSTR("UI Pause"), PSTR("Resume"));
- #endif
-
- set_status_P(print_paused);
-
- #if ENABLED(PARK_HEAD_ON_PAUSE)
- #if HAS_SPI_LCD
- lcd_pause_show_message(PAUSE_MESSAGE_PAUSING, PAUSE_MODE_PAUSE_PRINT); // Show message immediately to let user know about pause in progress
- #endif
- queue.inject_P(PSTR("M25 P\nM24"));
- #elif ENABLED(SDSUPPORT)
- queue.inject_P(PSTR("M25"));
- #elif defined(ACTION_ON_PAUSE)
- host_action_pause();
- #endif
- }
-
- void MarlinUI::resume_print() {
- reset_status();
- #if ENABLED(PARK_HEAD_ON_PAUSE)
- wait_for_heatup = wait_for_user = false;
- #endif
- if (IS_SD_PAUSED()) queue.inject_P(M24_STR);
- #ifdef ACTION_ON_RESUME
- host_action_resume();
- #endif
- print_job_timer.start(); // Also called by M24
- }
-
- #if HAS_PRINT_PROGRESS
-
- MarlinUI::progress_t MarlinUI::_get_progress() {
- #if ENABLED(LCD_SET_PROGRESS_MANUALLY)
- const progress_t p = progress_override & PROGRESS_MASK;
- #else
- constexpr progress_t p = 0;
- #endif
- return (p
- #if ENABLED(SDSUPPORT)
- #if HAS_PRINT_PROGRESS_PERMYRIAD
- ?: card.permyriadDone()
- #else
- ?: card.percentDone()
- #endif
- #endif
- );
- }
-
- #endif
-
- #else // !HAS_DISPLAY
-
- //
- // Send the status line as a host notification
- //
-
- void MarlinUI::set_status(const char * const message, const bool) {
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_action_notify(message);
- #else
- UNUSED(message);
- #endif
- }
-
- void MarlinUI::set_status_P(PGM_P message, const int8_t) {
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_action_notify(message);
- #else
- UNUSED(message);
- #endif
- }
-
- void MarlinUI::status_printf_P(const uint8_t, PGM_P const message, ...) {
- #if ENABLED(HOST_PROMPT_SUPPORT)
- host_action_notify(message);
- #else
- UNUSED(message);
- #endif
- }
-
- #endif // !HAS_DISPLAY
|