diff --git a/Marlin/Configuration.h b/Marlin/Configuration.h index 603627fc0..0bd552262 100644 --- a/Marlin/Configuration.h +++ b/Marlin/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -476,12 +461,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -530,77 +519,90 @@ #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// + /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * You must activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -636,69 +638,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -720,6 +659,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -738,7 +680,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/Configuration_adv.h b/Marlin/Configuration_adv.h index afad3eaa8..8ec840985 100755 --- a/Marlin/Configuration_adv.h +++ b/Marlin/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/Cartesio/Configuration.h b/Marlin/example_configurations/Cartesio/Configuration.h index 54bc667cc..15d9db90f 100644 --- a/Marlin/example_configurations/Cartesio/Configuration.h +++ b/Marlin/example_configurations/Cartesio/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -146,9 +134,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 3 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -475,12 +460,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -528,78 +517,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -635,70 +636,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -720,6 +657,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 1 @@ -738,7 +678,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/Cartesio/Configuration_adv.h b/Marlin/example_configurations/Cartesio/Configuration_adv.h index 86826d36e..0980413c6 100644 --- a/Marlin/example_configurations/Cartesio/Configuration_adv.h +++ b/Marlin/example_configurations/Cartesio/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/Felix/Configuration.h b/Marlin/example_configurations/Felix/Configuration.h index e9eb6c884..d65dfb078 100644 --- a/Marlin/example_configurations/Felix/Configuration.h +++ b/Marlin/example_configurations/Felix/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -459,12 +444,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -512,78 +501,90 @@ #define DEFAULT_ZJERK 0.3 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -619,70 +620,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -704,6 +641,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -722,7 +662,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/Felix/Configuration_adv.h b/Marlin/example_configurations/Felix/Configuration_adv.h index c7b37ce91..8ddb5dde1 100644 --- a/Marlin/example_configurations/Felix/Configuration_adv.h +++ b/Marlin/example_configurations/Felix/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/Felix/DUAL/Configuration.h b/Marlin/example_configurations/Felix/DUAL/Configuration.h index b64969d5f..a0721fe19 100644 --- a/Marlin/example_configurations/Felix/DUAL/Configuration.h +++ b/Marlin/example_configurations/Felix/DUAL/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 2 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -459,12 +444,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -512,78 +501,90 @@ #define DEFAULT_ZJERK 0.3 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -619,70 +620,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -704,6 +641,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -722,7 +662,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/FolgerTech-i3-2020/Configuration.h b/Marlin/example_configurations/FolgerTech-i3-2020/Configuration.h index fcca1e01b..7eb0f214c 100644 --- a/Marlin/example_configurations/FolgerTech-i3-2020/Configuration.h +++ b/Marlin/example_configurations/FolgerTech-i3-2020/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -482,12 +467,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -536,78 +525,90 @@ #define DEFAULT_EJERK 4.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ #define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. #define Z_SERVO_ANGLES {40,85} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -642,69 +643,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - -// Enable Z Probe Repeatability test to see how accurate your probe is -#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -722,11 +660,12 @@ #define Z_CLEARANCE_DEPLOY_PROBE 3 // Z Clearance for Deploy/Stow #define Z_CLEARANCE_BETWEEN_PROBES 3 // Z Clearance between probe points - -// For M851 give a range for adjusting the Z probe offset -#define Z_PROBE_OFFSET_RANGE_MIN -20 +// For M851 give a range for adjusting the Z probe offset#define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -745,7 +684,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/FolgerTech-i3-2020/Configuration_adv.h b/Marlin/example_configurations/FolgerTech-i3-2020/Configuration_adv.h index 2225b761a..7f803b2bd 100644 --- a/Marlin/example_configurations/FolgerTech-i3-2020/Configuration_adv.h +++ b/Marlin/example_configurations/FolgerTech-i3-2020/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/Hephestos/Configuration.h b/Marlin/example_configurations/Hephestos/Configuration.h index 43b66aa16..3f503db69 100644 --- a/Marlin/example_configurations/Hephestos/Configuration.h +++ b/Marlin/example_configurations/Hephestos/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -148,9 +136,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -467,12 +452,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -520,78 +509,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +//#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -627,70 +628,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -#define Z_MIN_PROBE_ENDSTOP -//#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -712,6 +649,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -730,7 +670,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/Hephestos/Configuration_adv.h b/Marlin/example_configurations/Hephestos/Configuration_adv.h index 45206ef5f..13af7304a 100644 --- a/Marlin/example_configurations/Hephestos/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/Hephestos_2/Configuration.h b/Marlin/example_configurations/Hephestos_2/Configuration.h index 76db2d1dc..4ac164b0c 100644 --- a/Marlin/example_configurations/Hephestos_2/Configuration.h +++ b/Marlin/example_configurations/Hephestos_2/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -470,12 +455,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -523,78 +512,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 1.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ #define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -630,70 +631,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -715,6 +652,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -2 #define Z_PROBE_OFFSET_RANGE_MAX 0 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -733,7 +673,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/Hephestos_2/Configuration_adv.h b/Marlin/example_configurations/Hephestos_2/Configuration_adv.h index 19ef14cb5..c123e4526 100644 --- a/Marlin/example_configurations/Hephestos_2/Configuration_adv.h +++ b/Marlin/example_configurations/Hephestos_2/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/K8200/Configuration.h b/Marlin/example_configurations/K8200/Configuration.h index e52e7509c..8bc6e04da 100644 --- a/Marlin/example_configurations/K8200/Configuration.h +++ b/Marlin/example_configurations/K8200/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 /** @@ -165,9 +153,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -506,12 +491,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -558,78 +547,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -665,70 +666,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -750,6 +687,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -768,7 +708,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/K8200/Configuration_adv.h b/Marlin/example_configurations/K8200/Configuration_adv.h index d87896b02..ad96b02b9 100644 --- a/Marlin/example_configurations/K8200/Configuration_adv.h +++ b/Marlin/example_configurations/K8200/Configuration_adv.h @@ -41,18 +41,6 @@ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/K8400/Configuration.h b/Marlin/example_configurations/K8400/Configuration.h index c015a797d..0b07f8d27 100644 --- a/Marlin/example_configurations/K8400/Configuration.h +++ b/Marlin/example_configurations/K8400/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -476,12 +461,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -529,78 +518,90 @@ #define DEFAULT_ZJERK 0.5 #define DEFAULT_EJERK 20.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -636,70 +637,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -721,6 +658,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -739,7 +679,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/K8400/Configuration_adv.h b/Marlin/example_configurations/K8400/Configuration_adv.h index 509ee750d..a435d0663 100644 --- a/Marlin/example_configurations/K8400/Configuration_adv.h +++ b/Marlin/example_configurations/K8400/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/K8400/Dual-head/Configuration.h b/Marlin/example_configurations/K8400/Dual-head/Configuration.h index b8333c67b..4d8df13fa 100644 --- a/Marlin/example_configurations/K8400/Dual-head/Configuration.h +++ b/Marlin/example_configurations/K8400/Dual-head/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 2 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -476,12 +461,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -529,78 +518,90 @@ #define DEFAULT_ZJERK 0.5 #define DEFAULT_EJERK 20.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -636,70 +637,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -721,6 +658,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -739,7 +679,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h b/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h index 54371f08f..783508ec5 100644 --- a/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h +++ b/Marlin/example_configurations/RepRapWorld/Megatronics/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -476,12 +461,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -529,78 +518,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -636,70 +637,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -721,6 +658,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -739,7 +679,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/RigidBot/Configuration.h b/Marlin/example_configurations/RigidBot/Configuration.h index 06bd76904..f4b73b1c8 100644 --- a/Marlin/example_configurations/RigidBot/Configuration.h +++ b/Marlin/example_configurations/RigidBot/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -148,9 +136,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 // Single extruder. Set to 2 for dual extruders -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -473,12 +458,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -528,78 +517,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -635,70 +636,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -720,6 +657,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -738,7 +678,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/RigidBot/Configuration_adv.h b/Marlin/example_configurations/RigidBot/Configuration_adv.h index 05d5c3750..97aafb9dd 100644 --- a/Marlin/example_configurations/RigidBot/Configuration_adv.h +++ b/Marlin/example_configurations/RigidBot/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/SCARA/Configuration.h b/Marlin/example_configurations/SCARA/Configuration.h index feababc9c..79c2670ec 100644 --- a/Marlin/example_configurations/SCARA/Configuration.h +++ b/Marlin/example_configurations/SCARA/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -177,9 +165,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -491,12 +476,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -544,78 +533,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 3.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -651,70 +652,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -736,6 +673,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -754,7 +694,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/SCARA/Configuration_adv.h b/Marlin/example_configurations/SCARA/Configuration_adv.h index 220f0d79e..0ea0b21f8 100644 --- a/Marlin/example_configurations/SCARA/Configuration_adv.h +++ b/Marlin/example_configurations/SCARA/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/TAZ4/Configuration.h b/Marlin/example_configurations/TAZ4/Configuration.h index 297a6e456..ea4d534fb 100644 --- a/Marlin/example_configurations/TAZ4/Configuration.h +++ b/Marlin/example_configurations/TAZ4/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -496,12 +481,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -549,78 +538,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 10.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ #define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -656,70 +657,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -741,6 +678,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -759,7 +699,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/TAZ4/Configuration_adv.h b/Marlin/example_configurations/TAZ4/Configuration_adv.h index 5134ff6b4..ce40edba6 100644 --- a/Marlin/example_configurations/TAZ4/Configuration_adv.h +++ b/Marlin/example_configurations/TAZ4/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/TinyBoy2/Configuration.h b/Marlin/example_configurations/TinyBoy2/Configuration.h index ebc597474..57e038c03 100644 --- a/Marlin/example_configurations/TinyBoy2/Configuration.h +++ b/Marlin/example_configurations/TinyBoy2/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 /** @@ -167,9 +155,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -527,12 +512,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -580,78 +569,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -687,70 +688,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -772,6 +709,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -790,7 +730,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/TinyBoy2/Configuration_adv.h b/Marlin/example_configurations/TinyBoy2/Configuration_adv.h index 9ed994361..54f76d3b5 100644 --- a/Marlin/example_configurations/TinyBoy2/Configuration_adv.h +++ b/Marlin/example_configurations/TinyBoy2/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/WITBOX/Configuration.h b/Marlin/example_configurations/WITBOX/Configuration.h index 1ffa26723..1ebd9ecbc 100644 --- a/Marlin/example_configurations/WITBOX/Configuration.h +++ b/Marlin/example_configurations/WITBOX/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -148,9 +136,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -467,12 +452,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -520,78 +509,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -627,70 +628,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -712,6 +649,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -730,7 +670,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/WITBOX/Configuration_adv.h b/Marlin/example_configurations/WITBOX/Configuration_adv.h index 45206ef5f..13af7304a 100644 --- a/Marlin/example_configurations/WITBOX/Configuration_adv.h +++ b/Marlin/example_configurations/WITBOX/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/adafruit/ST7565/Configuration.h b/Marlin/example_configurations/adafruit/ST7565/Configuration.h index faa4f367b..2188ffe85 100644 --- a/Marlin/example_configurations/adafruit/ST7565/Configuration.h +++ b/Marlin/example_configurations/adafruit/ST7565/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -476,12 +461,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -529,78 +518,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -636,70 +637,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -721,6 +658,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -739,7 +679,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration.h b/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration.h index 5e1f3facc..43a608597 100644 --- a/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration.h +++ b/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -550,12 +535,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -603,78 +592,90 @@ #define DEFAULT_ZJERK DEFAULT_YJERK // Must be same as XY for delta #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP // A3K leave disabled! +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ #define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -760,67 +761,6 @@ #endif // Z_PROBE_ALLEN_KEY -/** - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP // A3K leave disabled! -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -842,6 +782,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -860,7 +803,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration_adv.h b/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration_adv.h index 220bfa471..7a83ecc03 100644 --- a/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration_adv.h +++ b/Marlin/example_configurations/delta/FLSUN/auto_calibrate/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration.h b/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration.h index 1c468198d..afa16fb85 100644 --- a/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration.h +++ b/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -551,12 +536,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -604,78 +593,90 @@ #define DEFAULT_ZJERK DEFAULT_YJERK // Must be same as XY for delta #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP // A3K leave disabled! +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ #define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -761,67 +762,6 @@ #endif // Z_PROBE_ALLEN_KEY -/** - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP // A3K leave disabled! -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - -// Enable Z Probe Repeatability test to see how accurate your probe is -#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -843,6 +783,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -861,7 +804,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration_adv.h b/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration_adv.h index eed1171b9..70cf63ac9 100644 --- a/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration_adv.h +++ b/Marlin/example_configurations/delta/FLSUN/kossel_mini/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/delta/generic/Configuration.h b/Marlin/example_configurations/delta/generic/Configuration.h index 3cdda9002..25efc6fa1 100644 --- a/Marlin/example_configurations/delta/generic/Configuration.h +++ b/Marlin/example_configurations/delta/generic/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -540,12 +525,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -593,78 +582,90 @@ #define DEFAULT_ZJERK 20.0 // Must be same as XY for delta #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +//#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -747,68 +748,6 @@ #endif // Z_PROBE_ALLEN_KEY -/** - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -#define Z_MIN_PROBE_ENDSTOP -//#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -830,6 +769,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -848,7 +790,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/generic/Configuration_adv.h b/Marlin/example_configurations/delta/generic/Configuration_adv.h index 7de00f080..1d72030bd 100644 --- a/Marlin/example_configurations/delta/generic/Configuration_adv.h +++ b/Marlin/example_configurations/delta/generic/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/delta/kossel_mini/Configuration.h b/Marlin/example_configurations/delta/kossel_mini/Configuration.h index c5f5c5c07..75f6d21e1 100644 --- a/Marlin/example_configurations/delta/kossel_mini/Configuration.h +++ b/Marlin/example_configurations/delta/kossel_mini/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -540,12 +525,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -593,71 +582,85 @@ #define DEFAULT_ZJERK 20.0 // Must be same as XY for delta #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -743,68 +746,6 @@ #endif // Z_PROBE_ALLEN_KEY -/** - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -826,6 +767,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -844,7 +788,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h index 7de00f080..1d72030bd 100644 --- a/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_mini/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/delta/kossel_pro/Configuration.h b/Marlin/example_configurations/delta/kossel_pro/Configuration.h index 256f3a9dd..91f876eaf 100644 --- a/Marlin/example_configurations/delta/kossel_pro/Configuration.h +++ b/Marlin/example_configurations/delta/kossel_pro/Configuration.h @@ -41,18 +41,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -149,9 +137,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -534,12 +519,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -587,78 +576,90 @@ #define DEFAULT_ZJERK 20.0 // Must be same as XY for delta #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -750,68 +751,6 @@ #endif // Z_PROBE_ALLEN_KEY -/** - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -834,6 +773,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -15 #define Z_PROBE_OFFSET_RANGE_MAX 5 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -852,7 +794,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h index 40e7259ed..ca691bcf6 100644 --- a/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_pro/Configuration_adv.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/delta/kossel_xl/Configuration.h b/Marlin/example_configurations/delta/kossel_xl/Configuration.h index fd09b2209..27f4d3b61 100644 --- a/Marlin/example_configurations/delta/kossel_xl/Configuration.h +++ b/Marlin/example_configurations/delta/kossel_xl/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -553,12 +538,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -606,78 +595,90 @@ #define DEFAULT_ZJERK 20.0 #define DEFAULT_EJERK 20.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +//#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ #define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -814,13 +815,6 @@ * ignored by Marlin */ -#define Z_MIN_PROBE_ENDSTOP -//#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -842,6 +836,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -860,7 +857,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h b/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h index 8268e4293..c19e6dfb2 100644 --- a/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h +++ b/Marlin/example_configurations/delta/kossel_xl/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/gCreate_gMax1.5+/Configuration.h b/Marlin/example_configurations/gCreate_gMax1.5+/Configuration.h index ca1a4f7a7..bb97cdaad 100644 --- a/Marlin/example_configurations/gCreate_gMax1.5+/Configuration.h +++ b/Marlin/example_configurations/gCreate_gMax1.5+/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -150,9 +138,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -490,12 +475,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -561,60 +550,42 @@ */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ #define BLTOUCH #define BLTOUCH_DELAY 500 // (ms) Enable and increase if needed #define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ - // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -650,69 +621,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - -// Enable Z Probe Repeatability test to see how accurate your probe is -#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -734,6 +642,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -752,7 +663,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/gCreate_gMax1.5+/Configuration_adv.h b/Marlin/example_configurations/gCreate_gMax1.5+/Configuration_adv.h index e1677111a..1f157fa3e 100644 --- a/Marlin/example_configurations/gCreate_gMax1.5+/Configuration_adv.h +++ b/Marlin/example_configurations/gCreate_gMax1.5+/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/makibox/Configuration.h b/Marlin/example_configurations/makibox/Configuration.h index fae782350..8d023dacb 100644 --- a/Marlin/example_configurations/makibox/Configuration.h +++ b/Marlin/example_configurations/makibox/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -479,12 +464,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -532,78 +521,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -639,70 +640,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -724,6 +661,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -742,7 +682,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/makibox/Configuration_adv.h b/Marlin/example_configurations/makibox/Configuration_adv.h index 7f752213d..b84cb8a69 100644 --- a/Marlin/example_configurations/makibox/Configuration_adv.h +++ b/Marlin/example_configurations/makibox/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/tvrrug/Round2/Configuration.h b/Marlin/example_configurations/tvrrug/Round2/Configuration.h index 093cb37ff..ad1aadaf2 100644 --- a/Marlin/example_configurations/tvrrug/Round2/Configuration.h +++ b/Marlin/example_configurations/tvrrug/Round2/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -466,12 +451,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -525,78 +514,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -632,70 +633,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -717,6 +654,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 1 @@ -735,7 +675,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h index cfb3fc2b4..4ca3375ae 100644 --- a/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h +++ b/Marlin/example_configurations/tvrrug/Round2/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature diff --git a/Marlin/example_configurations/wt150/Configuration.h b/Marlin/example_configurations/wt150/Configuration.h index 324f3678e..bfb749719 100644 --- a/Marlin/example_configurations/wt150/Configuration.h +++ b/Marlin/example_configurations/wt150/Configuration.h @@ -37,18 +37,6 @@ */ #ifndef CONFIGURATION_H #define CONFIGURATION_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_H_VERSION 010100 //=========================================================================== @@ -145,9 +133,6 @@ // :[1, 2, 3, 4, 5] #define EXTRUDERS 1 -// Enable if your E steppers or extruder gear ratios are not identical -//#define DISTINCT_E_FACTORS - // For Cyclops or any "multi-extruder" that shares a single nozzle. //#define SINGLENOZZLE @@ -481,12 +466,16 @@ * * These settings can be reset by M502 * - * You can set distinct factors for each E stepper, if needed. - * If fewer factors are given, the last will apply to the rest. - * * Note that if EEPROM is enabled, saved values will override these. */ +/** + * With this option each E stepper can have its own factors for the + * following movement settings. If fewer factors are given than the + * total number of extruders, the last value applies to the rest. + */ +//#define DISTINCT_E_FACTORS + /** * Default Axis Steps Per Unit (steps/mm) * Override with M92 @@ -534,78 +523,90 @@ #define DEFAULT_ZJERK 0.4 #define DEFAULT_EJERK 5.0 +//=========================================================================== +//============================= Z Probe Options ============================= +//=========================================================================== +// @section probes + +// +// See http://marlinfw.org/configuration/probes.html +// /** - * =========================================================================== - * ============================= Z Probe Options ============================= - * =========================================================================== - * @section probes + * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN * + * Enable this option for a probe connected to the Z Min endstop pin. + */ +#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN + +/** + * Z_MIN_PROBE_ENDSTOP * - * Probe Type - * Probes are sensors/switches that are activated / deactivated before/after use. + * Enable this option for a probe connected to any pin except Z-Min. + * (By default Marlin assumes the Z-Max endstop pin.) + * To use a custom Z Probe pin, set Z_MIN_PROBE_PIN below. * - * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. - * You must activate one of these to use Auto Bed Leveling below. + * - The simplest option is to use a free endstop connector. + * - Use 5V for powered (usually inductive) sensors. * - * Use M851 to set the Z probe vertical offset from the nozzle. Store with M500. + * - RAMPS 1.3/1.4 boards may use the 5V, GND, and Aux4->D32 pin: + * - For simple switches connect... + * - normally-closed switches to GND and D32. + * - normally-open switches to 5V and D32. + * + * WARNING: Setting the wrong pin may have unexpected and potentially + * disastrous consequences. Use with caution and do your homework. + * + */ +//#define Z_MIN_PROBE_ENDSTOP +//#define Z_MIN_PROBE_PIN Z_MAX_PIN + +/** + * Probe Type + * + * Allen Key Probes, Servo Probes, Z-Sled Probes, FIX_MOUNTED_PROBE, etc. + * Activate one of these to use Auto Bed Leveling below. */ /** - * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. - * Use G29 repeatedly, adjusting the Z height at each point with movement commands - * or (with LCD_BED_LEVELING) the LCD controller. + * The "Manual Probe" provides a means to do "Auto" Bed Leveling without a probe. + * Use G29 repeatedly, adjusting the Z height at each point with movement commands + * or (with LCD_BED_LEVELING) the LCD controller. */ //#define PROBE_MANUALLY /** - * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. - * For example an inductive probe, or a setup that uses the nozzle to probe. - * An inductive probe must be deactivated to go below - * its trigger-point if hardware endstops are active. + * A Fix-Mounted Probe either doesn't deploy or needs manual deployment. + * (e.g., an inductive probe or a nozzle-based probe-switch.) */ //#define FIX_MOUNTED_PROBE /** - * Z Servo Probe, such as an endstop switch on a rotating arm. - * NUM_SERVOS also needs to be set. This is found later in this file. Set it to - * 1 + the number of other servos in your system. + * Z Servo Probe, such as an endstop switch on a rotating arm. */ //#define Z_ENDSTOP_SERVO_NR 0 // Defaults to SERVO 0 connector. //#define Z_SERVO_ANGLES {70,0} // Z Servo Deploy and Stow angles - /** - * The BLTouch probe emulates a servo probe. - * If using a BLTouch then NUM_SERVOS, Z_ENDSTOP_SERVO_NR and Z_SERVO_ANGLES - * are setup for you in the background and you shouldn't need to set/modify/enable them - * with the possible exception of Z_ENDSTOP_SERVO_NR. +/** + * The BLTouch probe is a Hall effect sensor that emulates a servo. */ //#define BLTOUCH -//#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed -//#define BLTOUCH_HEATERS_OFF // if defined the printer's heaters are turned off during probe event - -/** - * BLTouch WARNING - ONLY APPLIES TO VERSIONS OF MARLIN BEFORE 15 FEB 2017 - * Unless using interrupt endstops, there is a MINIMUM feedrate for Marlin to reliably - * sense the BLTouch. If the feedrate is too slow then G28 & G29 can sometimes result - * in the print head being driven into the bed until manual intervention. - * The minimum feedrate calculation is: - * - * feedrate minimum = 24000 / DEFAULT_AXIS_STEPS_PER_UNIT - * where feedrate is in "mm/minute" or "inches/minute" depending on the units used - * in DEFAULT_AXIS_STEPS_PER_UNIT - * - * This applies to the HOMING_FEEDRATE_Z and Z_PROBE_SPEED_FAST. If PROBE_DOUBLE_TOUCH - * is enabled then it also applies to Z_PROBE_SPEED_SLOW. - */ +#if ENABLED(BLTOUCH) + //#define BLTOUCH_DELAY 375 // (ms) Enable and increase if needed + //#define BLTOUCH_HEATERS_OFF // Enable if the probe seems unreliable. Heaters will be disabled for each probe. +#endif // A probe that is deployed and stowed with a solenoid pin (SOL1_PIN) //#define SOLENOID_PROBE -// Enable if you have a Z probe mounted on a sled like those designed by Charles Bell. +// A sled-mounted probe like those designed by Charles Bell. //#define Z_PROBE_SLED //#define SLED_DOCKING_OFFSET 5 // The extra distance the X axis must travel to pickup the sled. 0 should be fine but you can push it further if you'd like. +// +// For Z_PROBE_ALLEN_KEY see the Delta example configurations. +// + /** * Z Probe to nozzle (X,Y) offset, relative to (0, 0). * X and Y offsets must be integers. @@ -641,70 +642,6 @@ // Use double touch for probing //#define PROBE_DOUBLE_TOUCH -/** - * Allen Key Probe is defined in the Delta example configurations. - * - * - * *** PLEASE READ ALL INSTRUCTIONS BELOW FOR SAFETY! *** - * - * - RAMPS 1.3/1.4 boards may be able to use the 5V, GND, and Aux4->D32 pin. - * - Use 5V for powered (usu. inductive) sensors. - * - Otherwise connect: - * - normally-closed switches to GND and D32. - * - normally-open switches to 5V and D32. - * - * Normally-closed switches are advised and are the default. - * - * - * PIN OPTIONS\SETUP FOR Z PROBES - * - * - * WARNING: - * Setting the wrong pin may have unexpected and potentially disastrous consequences. - * Use with caution and do your homework. - * - * - * All Z PROBE pin options are configured by defining (or not defining) - * the following five items: - * Z_MIN_PROBE_ENDSTOP – defined below - * Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN – defined below - * Z_MIN_PIN - defined in the pins_YOUR_BOARD.h file - * Z_MIN_PROBE_PIN - defined in the pins_YOUR_BOARD.h file - * - * If you're using a probe then you need to tell Marlin which pin to use as - * the Z MIN ENDSTOP. Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN determines if the - * Z_MIN_PIN or if the Z_MIN_PROBE_PIN is used. - * - * The pin selected for the probe is ONLY checked during probing operations. - * If you want to use the Z_MIN_PIN as an endstop AND you want to have a Z PROBE - * then you’ll need to use the Z_MIN_PROBE_PIN option. - * - * Z_MIN_PROBE_ENDSTOP also needs to be enabled if you want to use Z_MIN_PROBE_PIN. - * - * The settings needed to use the Z_MIN_PROBE_PIN are: - * 1. select the type of probe you're using - * 2. define Z_MIN_PROBE_PIN in your pins_YOUR_BOARD.h file - * 3. disable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. enable Z_MIN_PROBE_ENDSTOP - * NOTE – if Z_MIN_PIN is defined then it’ll be checked during all moves in the - * negative Z direction. - * - * The settings needed to use the Z_MIN_PIN are: - * 1. select the type of probe you're using - * 2. enable Z_MIN _PIN in your pins_YOUR_BOARD.h file - * 3. enable Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - * 4. disable Z_MIN_PROBE_ENDSTOP - * NOTES – if Z_MIN_PROBE_PIN is defined in the pins_YOUR_BOARD.h file then it’ll be - * ignored by Marlin - */ - -//#define Z_MIN_PROBE_ENDSTOP -#define Z_MIN_PROBE_USES_Z_MIN_ENDSTOP_PIN - - -// Enable Z Probe Repeatability test to see how accurate your probe is -//#define Z_MIN_PROBE_REPEATABILITY_TEST - /** * Z probes require clearance when deploying, stowing, and moving between * probe points to avoid hitting the bed and other hardware. @@ -726,6 +663,9 @@ #define Z_PROBE_OFFSET_RANGE_MIN -20 #define Z_PROBE_OFFSET_RANGE_MAX 20 +// Enable the M48 repeatability test to test probe accuracy +//#define Z_MIN_PROBE_REPEATABILITY_TEST + // For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1 // :{ 0:'Low', 1:'High' } #define X_ENABLE_ON 0 @@ -744,7 +684,7 @@ // @section extruder #define DISABLE_E false // For all extruders -#define DISABLE_INACTIVE_EXTRUDER true //disable only inactive extruders and keep active extruder enabled +#define DISABLE_INACTIVE_EXTRUDER true // Keep only the active extruder enabled. // @section machine diff --git a/Marlin/example_configurations/wt150/Configuration_adv.h b/Marlin/example_configurations/wt150/Configuration_adv.h index 73c43f17f..af1059304 100644 --- a/Marlin/example_configurations/wt150/Configuration_adv.h +++ b/Marlin/example_configurations/wt150/Configuration_adv.h @@ -32,18 +32,6 @@ */ #ifndef CONFIGURATION_ADV_H #define CONFIGURATION_ADV_H - -/** - * - * *********************************** - * ** ATTENTION TO ALL DEVELOPERS ** - * *********************************** - * - * You must increment this version number for every significant change such as, - * but not limited to: ADD, DELETE RENAME OR REPURPOSE any directive/option. - * - * Note: Update also Version.h ! - */ #define CONFIGURATION_ADV_H_VERSION 010100 // @section temperature