ultralcd.h

#ifndef ULTRALCD_H
#define ULTRALCD_H
 
#include "mesh_bed_calibration.h"
#include "config.h"
 
extern void menu_lcd_longpress_func(void);
extern void menu_lcd_lcdupdate_func(void);
 
// Call with a false parameter to suppress the LCD update from various places like the planner or the temp control.
void ultralcd_init();
 
#define LCD_STATUS_CRITICAL 3 //< Heater failure
#define LCD_STATUS_ALERT    2 //< Other hardware issue
#define LCD_STATUS_INFO     1 //< Message times out after a while
#define LCD_STATUS_NONE     0 //< No alert message set
 
#define LCD_STATUS_INFO_TIMEOUT 20000
#define LCD_STATUS_DELAYED_TIMEOUT 4000
 
// Reprint
void lcd_reprint_from_eeprom();
 
// Set the current status message (equivalent to LCD_STATUS_NONE)
void lcdui_print_status_line(void);
void lcd_clearstatus();
 
void lcd_getstatus(char buf[LCD_WIDTH]);
void lcd_insert_char_into_status(uint8_t position, const char message);
void lcd_setstatus(const char* message);
void lcd_setstatuspgm(const char* message);
void lcd_setstatus_serial(const char* message);
void lcd_reset_status_message_timeout();
 
void lcd_setalertstatus(const char* message, uint8_t severity = LCD_STATUS_ALERT);
void lcd_setalertstatuspgm(const char* message, uint8_t severity = LCD_STATUS_ALERT);
 
uint8_t get_message_level();
void lcd_reset_alert_level();
 
void lcd_pick_babystep();
uint8_t lcd_alright();
void show_preheat_nozzle_warning();
void lcd_wait_interact();
void lcd_loading_filament();
void lcd_change_success();
void lcd_loading_color();
void lcd_sdcard_stop();
void lcd_pause_print();
void lcd_pause_usb_print();
void lcd_send_action_start();
void lcd_resume_print();
void lcd_print_stop(); // interactive print stop
 
void print_stop(bool interactive=false, bool unconditional_stop=false);
#ifdef THERMAL_MODEL
void lcd_thermal_model_cal();
#endif //THERMAL_MODEL
void lcd_load_filament_color_check();
 
extern void lcd_belttest();
extern bool lcd_selftest();
 
void lcd_menu_statistics(); 
 
void lcd_status_screen();                         // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
void lcd_menu_extruder_info();                    // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
void lcd_menu_show_sensors_state();               // NOT static due to using inside "Marlin_main" module ("manage_inactivity()")
 
enum LCDButtonChoice : uint_fast8_t {
    LCD_LEFT_BUTTON_CHOICE = 0,
    LCD_MIDDLE_BUTTON_CHOICE = 1,
    LCD_RIGHT_BUTTON_CHOICE = 2,
    LCD_BUTTON_TIMEOUT      = 0xFF,
};
 
extern const char* lcd_display_message_fullscreen_P(const char *msg);
 
extern void lcd_return_to_status();
extern void lcd_wait_for_click();
extern bool lcd_wait_for_click_delay(uint16_t nDelay);
void lcd_show_choices_prompt_P(uint8_t selected, const char *first_choice, const char *second_choice, uint8_t second_col, const char *third_choice = nullptr);
extern void lcd_show_fullscreen_message_and_wait_P(const char *msg);
extern uint8_t lcd_show_yes_no_and_wait(bool allow_timeouting = true, uint8_t default_selection = LCD_MIDDLE_BUTTON_CHOICE);
extern uint8_t lcd_show_fullscreen_message_yes_no_and_wait_P(const char *msg, bool allow_timeouting = true, uint8_t default_selection = LCD_MIDDLE_BUTTON_CHOICE);
extern uint8_t lcd_show_multiscreen_message_with_choices_and_wait_P(
    const char * const msg, bool allow_timeouting, uint8_t default_selection,
    const char * const first_choice, const char * const second_choice, const char * const third_choice = nullptr,
    uint8_t second_col = 7);
extern uint8_t lcd_show_multiscreen_message_yes_no_and_wait_P(const char *msg, bool allow_timeouting = true, uint8_t default_selection = LCD_MIDDLE_BUTTON_CHOICE);
// Ask the user to move the Z axis up to the end stoppers and let
// the user confirm that it has been done.
 
#ifndef TMC2130
extern bool lcd_calibrate_z_end_stop_manual(bool only_z);
extern void lcd_diag_show_end_stops();
#endif
 
// Show the result of the calibration process on the LCD screen.
extern void lcd_bed_calibration_show_result(BedSkewOffsetDetectionResultType result, uint8_t point_too_far_mask);
 
 
#define LCD_MESSAGEPGM(x) lcd_setstatuspgm(PSTR(x))
#define LCD_ALERTMESSAGEPGM(x) lcd_setalertstatuspgm(PSTR(x))
#define LCD_MESSAGERPGM(x) lcd_setstatuspgm((x))
#define LCD_ALERTMESSAGERPGM(x) lcd_setalertstatuspgm((x))
 
 
// To be used in lcd_commands_type.
enum class LcdCommands : uint_least8_t
{
    Idle,
    StopPrint,
    LongPause,
    PidExtruder,
    Layer1Cal,
#ifdef THERMAL_MODEL
    ThermalModel,
#endif //THERMAL_MODEL
    NozzleCNG,
};
 
extern LcdCommands lcd_commands_type;
 
enum class CustomMsg : uint_least8_t
{
    Status,          
    MeshBedLeveling, 
    FilamentLoading, 
    PidCal,          
    TempCal,         
    TempCompPreheat, 
    M0Wait,          
    M117,            
    Resuming,        
    MMUProgress,     
};
 
extern CustomMsg custom_message_type;
extern uint8_t custom_message_state;
 
extern bool UserECoolEnabled();
extern bool FarmOrUserECool();
 
#ifdef TMC2130
#define SILENT_MODE_NORMAL 0
#define SILENT_MODE_STEALTH 1
#define SILENT_MODE_OFF SILENT_MODE_NORMAL
#else
#define SILENT_MODE_POWER 0
#define SILENT_MODE_SILENT 1
#define SILENT_MODE_AUTO 2
#define SILENT_MODE_OFF SILENT_MODE_POWER
#endif
 
#if defined(FILAMENT_SENSOR) && (FILAMENT_SENSOR_TYPE == FSENSOR_IR_ANALOG)
void printf_IRSensorAnalogBoardChange();
#endif //defined(FILAMENT_SENSOR) && (FILAMENT_SENSOR_TYPE == FSENSOR_IR_ANALOG)
 
extern int8_t SilentModeMenu;
 
extern uint8_t scrollstuff;
 
 
void lcd_commands();
 
 
extern bool bSettings;                            // flag (i.e. 'fake parameter') for 'lcd_hw_setup_menu()' function
void lcd_hw_setup_menu(void);                     // NOT static due to using inside "util" module ("nozzle_diameter_check()")
 
enum class FilamentAction : uint_least8_t
{
    None, // no filament action is taking place
    Load,
    AutoLoad, // triggered by insertion, cancellable until it transitions to Load
    UnLoad,
    MmuLoad,
    MmuUnLoad,
    MmuEject,
    MmuCut,
    MmuLoadingTest,
    Preheat, // triggered by preheat (cancellable)
    Lay1Cal, // triggered by 1st layer calibration (cancellable)
};
 
extern FilamentAction eFilamentAction;
void mFilamentItem(uint16_t nTemp,uint16_t nTempBed);
void lcd_generic_preheat_menu();
void unload_filament(float unloadLength);
void lcd_AutoLoadFilament();
 
 
void lcd_wait_for_heater();
void lcd_wait_for_cool_down();
void lcd_move_e(); // NOT static due to usage in Marlin_main
 
void lcd_temp_cal_show_result(bool result);
#ifdef PINDA_THERMISTOR
bool lcd_wait_for_pinda(float temp);
#endif //PINDA_THERMISTOR
 
 
char reset_menu();
uint8_t choose_menu_P(const char *header, const char *item, const char *last_item = nullptr);
 
void lcd_calibrate_pinda();
void lcd_temp_calibration_set();
 
#if (LANG_MODE != 0)
void lcd_language();
#endif
 
void lcd_wizard();
 
enum class WizState : uint8_t
{
    Run,            
    Restore,        
    Selftest,       
    Xyz,            
    Z,              
#ifdef THERMAL_MODEL
    ThermalModel,   
#endif //THERMAL_MODEL
    IsFil,          
    Preheat,        
    LoadFilCold,    
    LoadFilHot,     
    Lay1CalCold,    
    Lay1CalHot,     
    RepeatLay1Cal,  
    Finish,         
    Failed,         
};
 
void lcd_wizard(WizState state);
 
extern void lcd_experimental_menu();
 
uint8_t lcdui_print_extruder(void);
 
#ifdef PINDA_TEMP_COMP
extern void lcd_pinda_temp_compensation_toggle();
#endif //PINDA_TEMP_COMP
 
extern void lcd_heat_bed_on_load_toggle();
 
#ifdef COMMUNITY_PREVENT_OOZE
extern void retract_for_ooze_prevention();
#endif //COMMUNITY_PREVENT_OOZE
 
#endif //ULTRALCD_H