/** * 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 . * */ /** * SanityCheck.h * * Test configuration values for errors at compile-time. */ #ifndef SANITYCHECK_H #define SANITYCHECK_H /** * Dual Stepper Drivers */ #if ENABLED(Z_DUAL_STEPPER_DRIVERS) && ENABLED(Y_DUAL_STEPPER_DRIVERS) #error You cannot have dual stepper drivers for both Y and Z. #endif /** * Progress Bar */ #if ENABLED(LCD_PROGRESS_BAR) #if DISABLED(SDSUPPORT) #error LCD_PROGRESS_BAR requires SDSUPPORT. #endif #if ENABLED(DOGLCD) #error LCD_PROGRESS_BAR does not apply to graphical displays. #endif #if ENABLED(FILAMENT_LCD_DISPLAY) #error LCD_PROGRESS_BAR and FILAMENT_LCD_DISPLAY are not fully compatible. Comment out this line to use both. #endif #endif /** * Babystepping */ #if ENABLED(BABYSTEPPING) #if DISABLED(ULTRA_LCD) #error BABYSTEPPING requires an LCD controller. #endif #if ENABLED(SCARA) #error BABYSTEPPING is not implemented for SCARA yet. #endif #if ENABLED(DELTA) && ENABLED(BABYSTEP_XY) #error BABYSTEPPING only implemented for Z axis on deltabots. #endif #endif /** * Filament Change with Extruder Runout Prevention */ #if ENABLED(FILAMENTCHANGEENABLE) && ENABLED(EXTRUDER_RUNOUT_PREVENT) #error EXTRUDER_RUNOUT_PREVENT currently incompatible with FILAMENTCHANGE. #endif /** * Options only for EXTRUDERS > 1 */ #if EXTRUDERS > 1 #if EXTRUDERS > 4 #error The maximum number of EXTRUDERS in Marlin is 4. #endif #if ENABLED(TEMP_SENSOR_1_AS_REDUNDANT) #error EXTRUDERS must be 1 with TEMP_SENSOR_1_AS_REDUNDANT. #endif #if ENABLED(HEATERS_PARALLEL) #error EXTRUDERS must be 1 with HEATERS_PARALLEL. #endif #if ENABLED(Y_DUAL_STEPPER_DRIVERS) #error EXTRUDERS must be 1 with Y_DUAL_STEPPER_DRIVERS. #endif #if ENABLED(Z_DUAL_STEPPER_DRIVERS) #error EXTRUDERS must be 1 with Z_DUAL_STEPPER_DRIVERS. #endif #endif // EXTRUDERS > 1 /** * Limited number of servos */ #if NUM_SERVOS > 4 #error The maximum number of SERVOS in Marlin is 4. #endif #if defined(NUM_SERVOS) && NUM_SERVOS > 0 #if X_ENDSTOP_SERVO_NR >= 0 || Y_ENDSTOP_SERVO_NR >= 0 || Z_ENDSTOP_SERVO_NR >= 0 #if X_ENDSTOP_SERVO_NR >= NUM_SERVOS #error X_ENDSTOP_SERVO_NR must be smaller than NUM_SERVOS. #elif Y_ENDSTOP_SERVO_NR >= NUM_SERVOS #error Y_ENDSTOP_SERVO_NR must be smaller than NUM_SERVOS. #elif Z_ENDSTOP_SERVO_NR >= NUM_SERVOS #error Z_ENDSTOP_SERVO_NR must be smaller than NUM_SERVOS. #endif #endif #endif /** * Servo deactivation depends on servo endstops */ #if ENABLED(DEACTIVATE_SERVOS_AFTER_MOVE) && !HAS_SERVO_ENDSTOPS #error At least one of the ?_ENDSTOP_SERVO_NR is required for DEACTIVATE_SERVOS_AFTER_MOVE. #endif /** * Required LCD language */ #if DISABLED(DOGLCD) && ENABLED(ULTRA_LCD) && DISABLED(DISPLAY_CHARSET_HD44780_JAPAN) && DISABLED(DISPLAY_CHARSET_HD44780_WESTERN) && DISABLED(DISPLAY_CHARSET_HD44780_CYRILLIC) #error You must enable either DISPLAY_CHARSET_HD44780_JAPAN or DISPLAY_CHARSET_HD44780_WESTERN or DISPLAY_CHARSET_HD44780_CYRILLIC for your LCD controller. #endif /** * Mesh Bed Leveling */ #if ENABLED(MESH_BED_LEVELING) #if ENABLED(DELTA) #error MESH_BED_LEVELING does not yet support DELTA printers. #endif #if ENABLED(AUTO_BED_LEVELING_FEATURE) #error Select AUTO_BED_LEVELING_FEATURE or MESH_BED_LEVELING, not both. #endif #if MESH_NUM_X_POINTS > 7 || MESH_NUM_Y_POINTS > 7 #error MESH_NUM_X_POINTS and MESH_NUM_Y_POINTS need to be less than 8. #endif #elif ENABLED(MANUAL_BED_LEVELING) #error MESH_BED_LEVELING is required for MANUAL_BED_LEVELING. #endif /** * Probes */ /** * A probe needs a pin */ #if (!((HAS_Z_MIN && ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)) || HAS_Z_PROBE )) && ( ENABLED(FIX_MOUNTED_PROBE) || defined(Z_ENDSTOP_SERVO_NR) || ENABLED(Z_PROBE_ALLEN_KEY) || ENABLED(Z_PROBE_SLED)) #error A probe needs a pin! [Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN || HAS_Z_PROBE] #endif #if ((HAS_Z_MIN && ENABLED(Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN)) && HAS_Z_PROBE) && ( ENABLED(FIX_MOUNTED_PROBE) || defined(Z_ENDSTOP_SERVO_NR) || ENABLED(Z_PROBE_ALLEN_KEY) || ENABLED(Z_PROBE_SLED)) #error A probe should not be connected to more then one pin! [Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN || HAS_Z_PROBE] #endif /** * Require one kind of probe */ #if ENABLED(AUTO_BED_LEVELING_FEATURE) && !( ENABLED(FIX_MOUNTED_PROBE) || defined(Z_ENDSTOP_SERVO_NR) || ENABLED(Z_PROBE_ALLEN_KEY) || ENABLED(Z_PROBE_SLED)) #error For AUTO_BED_LEVELING_FEATURE define one kind of probe! {Servo | Z_PROBE_ALLEN_KEY | Z_PROBE_SLED | FIX_MOUNTED_PROBE] #endif #if ENABLED(Z_SAFE_HOMING)&& !( ENABLED(FIX_MOUNTED_PROBE) || defined(Z_ENDSTOP_SERVO_NR) || ENABLED(Z_PROBE_ALLEN_KEY) || ENABLED(Z_PROBE_SLED)) #error For Z_SAFE_HOMING define one kind of probe! {Servo | Z_PROBE_ALLEN_KEY | Z_PROBE_SLED | FIX_MOUNTED_PROBE] #endif // To do: Fail with more then one probe defined /** * Auto Bed Leveling */ #if ENABLED(AUTO_BED_LEVELING_FEATURE) /** * Require a Z min pin */ #if !PIN_EXISTS(Z_MIN) #if !PIN_EXISTS(Z_MIN_PROBE) || (DISABLED(Z_MIN_PROBE_ENDSTOP) || ENABLED(DISABLE_Z_MIN_PROBE_ENDSTOP)) // It's possible for someone to set a pin for the Z probe, but not enable it. #if ENABLED(Z_MIN_PROBE_REPEATABILITY_TEST) #error You must have a Z_MIN or Z_PROBE endstop to enable Z_MIN_PROBE_REPEATABILITY_TEST. #else #error AUTO_BED_LEVELING_FEATURE requires a Z_MIN or Z_PROBE endstop. Z_MIN_PIN or Z_MIN_PROBE_PIN must point to a valid hardware pin. #endif #endif #endif /** * Require a Z probe pin if Z_MIN_PROBE_ENDSTOP is enabled. */ #if ENABLED(Z_MIN_PROBE_ENDSTOP) #if !PIN_EXISTS(Z_MIN_PROBE) #error You must have a Z_MIN_PROBE_PIN defined in your pins_XXXX.h file if you enable Z_MIN_PROBE_ENDSTOP. #endif // Forcing Servo definitions can break some hall effect sensor setups. Leaving these here for further comment. //#ifndef NUM_SERVOS // #error You must have NUM_SERVOS defined and there must be at least 1 configured to use Z_MIN_PROBE_ENDSTOP. //#endif //#if defined(NUM_SERVOS) && NUM_SERVOS < 1 // #error You must have at least 1 servo defined for NUM_SERVOS to use Z_MIN_PROBE_ENDSTOP. //#endif //#if Z_ENDSTOP_SERVO_NR < 0 // #error You must have Z_ENDSTOP_SERVO_NR set to at least 0 or above to use Z_MIN_PROBE_ENDSTOP. //#endif //#ifndef SERVO_ENDSTOP_ANGLES // #error You must have SERVO_ENDSTOP_ANGLES defined for Z Extend and Retract to use Z_MIN_PROBE_ENDSTOP. //#endif #endif /** * Check if Probe_Offset * Grid Points is greater than Probing Range */ #if ENABLED(AUTO_BED_LEVELING_GRID) #ifndef DELTA_PROBEABLE_RADIUS // Be sure points are in the right order #if LEFT_PROBE_BED_POSITION > RIGHT_PROBE_BED_POSITION #error LEFT_PROBE_BED_POSITION must be less than RIGHT_PROBE_BED_POSITION. #elif FRONT_PROBE_BED_POSITION > BACK_PROBE_BED_POSITION #error FRONT_PROBE_BED_POSITION must be less than BACK_PROBE_BED_POSITION. #endif // Make sure probing points are reachable #if LEFT_PROBE_BED_POSITION < MIN_PROBE_X #error "The given LEFT_PROBE_BED_POSITION can't be reached by the Z probe." #elif RIGHT_PROBE_BED_POSITION > MAX_PROBE_X #error "The given RIGHT_PROBE_BED_POSITION can't be reached by the Z probe." #elif FRONT_PROBE_BED_POSITION < MIN_PROBE_Y #error "The given FRONT_PROBE_BED_POSITION can't be reached by the Z probe." #elif BACK_PROBE_BED_POSITION > MAX_PROBE_Y #error "The given BACK_PROBE_BED_POSITION can't be reached by the Z probe." #endif #endif #else // !AUTO_BED_LEVELING_GRID // Check the triangulation points #if ABL_PROBE_PT_1_X < MIN_PROBE_X || ABL_PROBE_PT_1_X > MAX_PROBE_X #error "The given ABL_PROBE_PT_1_X can't be reached by the Z probe." #elif ABL_PROBE_PT_2_X < MIN_PROBE_X || ABL_PROBE_PT_2_X > MAX_PROBE_X #error "The given ABL_PROBE_PT_2_X can't be reached by the Z probe." #elif ABL_PROBE_PT_3_X < MIN_PROBE_X || ABL_PROBE_PT_3_X > MAX_PROBE_X #error "The given ABL_PROBE_PT_3_X can't be reached by the Z probe." #elif ABL_PROBE_PT_1_Y < MIN_PROBE_Y || ABL_PROBE_PT_1_Y > MAX_PROBE_Y #error "The given ABL_PROBE_PT_1_Y can't be reached by the Z probe." #elif ABL_PROBE_PT_2_Y < MIN_PROBE_Y || ABL_PROBE_PT_2_Y > MAX_PROBE_Y #error "The given ABL_PROBE_PT_2_Y can't be reached by the Z probe." #elif ABL_PROBE_PT_3_Y < MIN_PROBE_Y || ABL_PROBE_PT_3_Y > MAX_PROBE_Y #error "The given ABL_PROBE_PT_3_Y can't be reached by the Z probe." #endif #endif // !AUTO_BED_LEVELING_GRID #endif // AUTO_BED_LEVELING_FEATURE /** * ULTIPANEL encoder */ #if ENABLED(ULTIPANEL) && DISABLED(NEWPANEL) && DISABLED(SR_LCD_2W_NL) && !defined(SHIFT_CLK) #error ULTIPANEL requires some kind of encoder. #endif /** * Delta has limited bed leveling options */ #if ENABLED(DELTA) #if ENABLED(AUTO_BED_LEVELING_FEATURE) #if DISABLED(AUTO_BED_LEVELING_GRID) #error Only AUTO_BED_LEVELING_GRID is supported with DELTA. #endif #if ENABLED(Z_PROBE_SLED) #error You cannot use Z_PROBE_SLED with DELTA. #endif #endif #endif /** * Allen Key Z probe requires Auto Bed Leveling grid and Delta */ #if ENABLED(Z_PROBE_ALLEN_KEY) && !(ENABLED(AUTO_BED_LEVELING_GRID) && ENABLED(DELTA)) #error Invalid use of Z_PROBE_ALLEN_KEY. #endif /** * Dual X Carriage requirements */ #if ENABLED(DUAL_X_CARRIAGE) #if EXTRUDERS == 1 || ENABLED(COREXY) \ || !HAS_X2_ENABLE || !HAS_X2_STEP || !HAS_X2_DIR \ || !defined(X2_HOME_POS) || !defined(X2_MIN_POS) || !defined(X2_MAX_POS) \ || !HAS_X_MAX #error Missing or invalid definitions for DUAL_X_CARRIAGE mode. #endif #if X_HOME_DIR != -1 || X2_HOME_DIR != 1 #error Please use canonical x-carriage assignment. #endif #endif // DUAL_X_CARRIAGE /** * Make sure auto fan pins don't conflict with the fan pin */ #if HAS_AUTO_FAN #if HAS_FAN0 #if EXTRUDER_0_AUTO_FAN_PIN == FAN_PIN #error You cannot set EXTRUDER_0_AUTO_FAN_PIN equal to FAN_PIN. #elif EXTRUDER_1_AUTO_FAN_PIN == FAN_PIN #error You cannot set EXTRUDER_1_AUTO_FAN_PIN equal to FAN_PIN. #elif EXTRUDER_2_AUTO_FAN_PIN == FAN_PIN #error You cannot set EXTRUDER_2_AUTO_FAN_PIN equal to FAN_PIN. #elif EXTRUDER_3_AUTO_FAN_PIN == FAN_PIN #error You cannot set EXTRUDER_3_AUTO_FAN_PIN equal to FAN_PIN. #endif #endif #endif #if HAS_FAN0 && CONTROLLERFAN_PIN == FAN_PIN #error You cannot set CONTROLLERFAN_PIN equal to FAN_PIN. #endif #if HAS_CONTROLLERFAN #if EXTRUDER_0_AUTO_FAN_PIN == CONTROLLERFAN_PIN #error You cannot set EXTRUDER_0_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN. #elif EXTRUDER_1_AUTO_FAN_PIN == CONTROLLERFAN_PIN #error You cannot set EXTRUDER_1_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN. #elif EXTRUDER_2_AUTO_FAN_PIN == CONTROLLERFAN_PIN #error You cannot set EXTRUDER_2_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN. #elif EXTRUDER_3_AUTO_FAN_PIN == CONTROLLERFAN_PIN #error You cannot set EXTRUDER_3_AUTO_FAN_PIN equal to CONTROLLERFAN_PIN. #endif #endif /** * Test Heater, Temp Sensor, and Extruder Pins; Sensor Type must also be set. */ #if EXTRUDERS > 3 #if !HAS_HEATER_3 #error HEATER_3_PIN not defined for this board. #elif !PIN_EXISTS(TEMP_3) #error TEMP_3_PIN not defined for this board. #elif !PIN_EXISTS(E3_STEP) || !PIN_EXISTS(E3_DIR) || !PIN_EXISTS(E3_ENABLE) #error E3_STEP_PIN, E3_DIR_PIN, or E3_ENABLE_PIN not defined for this board. #elif TEMP_SENSOR_3 == 0 #error TEMP_SENSOR_3 is required with 4 EXTRUDERS. #endif #elif EXTRUDERS > 2 #if !HAS_HEATER_2 #error HEATER_2_PIN not defined for this board. #elif !PIN_EXISTS(TEMP_2) #error TEMP_2_PIN not defined for this board. #elif !PIN_EXISTS(E2_STEP) || !PIN_EXISTS(E2_DIR) || !PIN_EXISTS(E2_ENABLE) #error E2_STEP_PIN, E2_DIR_PIN, or E2_ENABLE_PIN not defined for this board. #elif TEMP_SENSOR_2 == 0 #error TEMP_SENSOR_2 is required with 3 or more EXTRUDERS. #endif #elif EXTRUDERS > 1 #if !PIN_EXISTS(TEMP_1) #error TEMP_1_PIN not defined for this board. #elif !PIN_EXISTS(E1_STEP) || !PIN_EXISTS(E1_DIR) || !PIN_EXISTS(E1_ENABLE) #error E1_STEP_PIN, E1_DIR_PIN, or E1_ENABLE_PIN not defined for this board. #endif #endif #if EXTRUDERS > 1 || ENABLED(HEATERS_PARALLEL) #if !HAS_HEATER_1 #error HEATER_1_PIN not defined for this board. #endif #endif #if TEMP_SENSOR_1 == 0 #if EXTRUDERS > 1 #error TEMP_SENSOR_1 is required with 2 or more EXTRUDERS. #elif ENABLED(TEMP_SENSOR_1_AS_REDUNDANT) #error TEMP_SENSOR_1 is required with TEMP_SENSOR_1_AS_REDUNDANT. #endif #endif #if !HAS_HEATER_0 #error HEATER_0_PIN not defined for this board. #elif !PIN_EXISTS(TEMP_0) #error TEMP_0_PIN not defined for this board. #elif !PIN_EXISTS(E0_STEP) || !PIN_EXISTS(E0_DIR) || !PIN_EXISTS(E0_ENABLE) #error E0_STEP_PIN, E0_DIR_PIN, or E0_ENABLE_PIN not defined for this board. #elif TEMP_SENSOR_0 == 0 #error TEMP_SENSOR_0 is required. #endif /** * Warnings for old configurations */ #if WATCH_TEMP_PERIOD > 500 #error WATCH_TEMP_PERIOD now uses seconds instead of milliseconds. #elif DISABLED(THERMAL_PROTECTION_HOTENDS) && (defined(WATCH_TEMP_PERIOD) || defined(THERMAL_PROTECTION_PERIOD)) #error Thermal Runaway Protection for hotends is now enabled with THERMAL_PROTECTION_HOTENDS. #elif DISABLED(THERMAL_PROTECTION_BED) && defined(THERMAL_PROTECTION_BED_PERIOD) #error Thermal Runaway Protection for the bed is now enabled with THERMAL_PROTECTION_BED. #elif ENABLED(COREXZ) && ENABLED(Z_LATE_ENABLE) #error "Z_LATE_ENABLE can't be used with COREXZ." #elif defined(X_HOME_RETRACT_MM) #error [XYZ]_HOME_RETRACT_MM settings have been renamed [XYZ]_HOME_BUMP_MM. #elif defined(PROBE_SERVO_DEACTIVATION_DELAY) #error PROBE_SERVO_DEACTIVATION_DELAY has been replaced with DEACTIVATE_SERVOS_AFTER_MOVE and SERVO_DEACTIVATION_DELAY. #elif defined(BEEPER) #error BEEPER is now BEEPER_PIN. Please update your pins definitions. #elif defined(SDCARDDETECT) #error SDCARDDETECT is now SD_DETECT_PIN. Please update your pins definitions. #elif defined(SDCARDDETECTINVERTED) #error SDCARDDETECTINVERTED is now SD_DETECT_INVERTED. Please update your configuration. #elif defined(BTENABLED) #error BTENABLED is now BLUETOOTH. Please update your configuration. #elif defined(CUSTOM_MENDEL_NAME) #error CUSTOM_MENDEL_NAME is now CUSTOM_MACHINE_NAME. Please update your configuration. #elif defined(HAS_AUTOMATIC_VERSIONING) #error HAS_AUTOMATIC_VERSIONING deprecated - use USE_AUTOMATIC_VERSIONING instead #elif defined(ENABLE_AUTO_BED_LEVELING) #error ENABLE_AUTO_BED_LEVELING deprecated - use AUTO_BED_LEVELING_FEATURE instead #elif defined(SDSLOW) #error SDSLOW deprecated - set SPI_SPEED to SPI_HALF_SPEED instead #elif defined(SDEXTRASLOW) #error SDEXTRASLOW deprecated - set SPI_SPEED to SPI_QUARTER_SPEED instead #elif defined(Z_RAISE_BEFORE_HOMING) #error Z_RAISE_BEFORE_HOMING is deprecated. Use MIN_Z_HEIGHT_FOR_HOMING instead. #endif #endif //SANITYCHECK_H