123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165 |
- /**
- * Marlin 3D Printer Firmware
- * Copyright (C) 2016 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/>.
- *
- */
-
- #ifndef ULTRALCD_H
- #define ULTRALCD_H
-
- #include "Marlin.h"
-
- #if ENABLED(ULTRA_LCD)
-
- #define BUTTON_EXISTS(BN) (defined(BTN_## BN) && BTN_## BN >= 0)
- #define BUTTON_PRESSED(BN) !READ(BTN_## BN)
-
- extern int lcd_preheat_hotend_temp[2], lcd_preheat_bed_temp[2], lcd_preheat_fan_speed[2];
-
- int lcd_strlen(const char* s);
- int lcd_strlen_P(const char* s);
- void lcd_update();
- void lcd_init();
- bool lcd_hasstatus();
- void lcd_setstatus(const char* message, const bool persist=false);
- void lcd_setstatuspgm(const char* message, const uint8_t level=0);
- void lcd_setalertstatuspgm(const char* message);
- void lcd_reset_alert_level();
- void lcd_kill_screen();
- void kill_screen(const char* lcd_msg);
- bool lcd_detected(void);
-
- #if HAS_BUZZER
- void lcd_buzz(long duration, uint16_t freq);
- #endif
-
- #if ENABLED(LCD_PROGRESS_BAR) && PROGRESS_MSG_EXPIRE > 0
- void dontExpireStatus();
- #endif
-
- #if ENABLED(DOGLCD)
- extern int lcd_contrast;
- void set_lcd_contrast(int value);
- #elif ENABLED(SHOW_BOOTSCREEN)
- void bootscreen();
- #endif
-
- #define LCD_MESSAGEPGM(x) lcd_setstatuspgm(PSTR(x))
- #define LCD_ALERTMESSAGEPGM(x) lcd_setalertstatuspgm(PSTR(x))
-
- #define LCD_UPDATE_INTERVAL 100
- #define LCD_TIMEOUT_TO_STATUS 15000
-
- #if ENABLED(ULTIPANEL)
-
- #define BLEN_A 0
- #define BLEN_B 1
- // Encoder click is directly connected
- #if BUTTON_EXISTS(ENC)
- #define BLEN_C 2
- #endif
- #define EN_A (_BV(BLEN_A))
- #define EN_B (_BV(BLEN_B))
- #define EN_C (_BV(BLEN_C))
-
- extern volatile uint8_t buttons; //the last checked buttons in a bit array.
- void lcd_buttons_update();
- void lcd_quick_feedback(); // Audible feedback for a button click - could also be visual
-
- #if ENABLED(FILAMENT_CHANGE_FEATURE)
- void lcd_filament_change_show_message(const FilamentChangeMessage message);
- #endif // FILAMENT_CHANGE_FEATURE
-
- #else
-
- inline void lcd_buttons_update() {}
-
- #endif
-
- #if ENABLED(FILAMENT_LCD_DISPLAY)
- extern millis_t previous_lcd_status_ms;
- #endif
-
- bool lcd_blink();
-
- #if ENABLED(REPRAPWORLD_KEYPAD) // is also ULTIPANEL and NEWPANEL
-
- #define REPRAPWORLD_BTN_OFFSET 0 // bit offset into buttons for shift register values
-
- #define BLEN_REPRAPWORLD_KEYPAD_F3 0
- #define BLEN_REPRAPWORLD_KEYPAD_F2 1
- #define BLEN_REPRAPWORLD_KEYPAD_F1 2
- #define BLEN_REPRAPWORLD_KEYPAD_DOWN 3
- #define BLEN_REPRAPWORLD_KEYPAD_RIGHT 4
- #define BLEN_REPRAPWORLD_KEYPAD_MIDDLE 5
- #define BLEN_REPRAPWORLD_KEYPAD_UP 6
- #define BLEN_REPRAPWORLD_KEYPAD_LEFT 7
-
- #define EN_REPRAPWORLD_KEYPAD_F3 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F3))
- #define EN_REPRAPWORLD_KEYPAD_F2 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F2))
- #define EN_REPRAPWORLD_KEYPAD_F1 (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_F1))
- #define EN_REPRAPWORLD_KEYPAD_DOWN (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_DOWN))
- #define EN_REPRAPWORLD_KEYPAD_RIGHT (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_RIGHT))
- #define EN_REPRAPWORLD_KEYPAD_MIDDLE (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_MIDDLE))
- #define EN_REPRAPWORLD_KEYPAD_UP (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_UP))
- #define EN_REPRAPWORLD_KEYPAD_LEFT (_BV(REPRAPWORLD_BTN_OFFSET + BLEN_REPRAPWORLD_KEYPAD_LEFT))
-
- #define REPRAPWORLD_KEYPAD_MOVE_Z_DOWN (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_F3)
- #define REPRAPWORLD_KEYPAD_MOVE_Z_UP (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_F2)
- #define REPRAPWORLD_KEYPAD_MOVE_MENU (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_F1)
- #define REPRAPWORLD_KEYPAD_MOVE_Y_DOWN (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_DOWN)
- #define REPRAPWORLD_KEYPAD_MOVE_X_RIGHT (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_RIGHT)
- #define REPRAPWORLD_KEYPAD_MOVE_HOME (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_MIDDLE)
- #define REPRAPWORLD_KEYPAD_MOVE_Y_UP (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_UP)
- #define REPRAPWORLD_KEYPAD_MOVE_X_LEFT (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_LEFT)
-
- #define REPRAPWORLD_KEYPAD_PRESSED (buttons_reprapworld_keypad & ( \
- EN_REPRAPWORLD_KEYPAD_F3 | \
- EN_REPRAPWORLD_KEYPAD_F2 | \
- EN_REPRAPWORLD_KEYPAD_F1 | \
- EN_REPRAPWORLD_KEYPAD_DOWN | \
- EN_REPRAPWORLD_KEYPAD_RIGHT | \
- EN_REPRAPWORLD_KEYPAD_MIDDLE | \
- EN_REPRAPWORLD_KEYPAD_UP | \
- EN_REPRAPWORLD_KEYPAD_LEFT) \
- )
-
- #define LCD_CLICKED ((buttons & EN_C) || (buttons_reprapworld_keypad & EN_REPRAPWORLD_KEYPAD_F1))
- #elif ENABLED(NEWPANEL)
- #define LCD_CLICKED (buttons & EN_C)
- #else
- #define LCD_CLICKED false
- #endif
-
- #else //no LCD
- inline void lcd_update() {}
- inline void lcd_init() {}
- inline bool lcd_hasstatus() { return false; }
- inline void lcd_setstatus(const char* const message, const bool persist=false) { UNUSED(message); UNUSED(persist); }
- inline void lcd_setstatuspgm(const char* const message, const uint8_t level=0) { UNUSED(message); UNUSED(level); }
- inline void lcd_buttons_update() {}
- inline void lcd_reset_alert_level() {}
- inline bool lcd_detected() { return true; }
-
- #define LCD_MESSAGEPGM(x) NOOP
- #define LCD_ALERTMESSAGEPGM(x) NOOP
-
- #endif // ULTRA_LCD
-
- #endif // ULTRALCD_H
|