From 5037f374114d6bed5c0b978052a47eabb064a8ff Mon Sep 17 00:00:00 2001
From: Scott Lahteine <thinkyhead@users.noreply.github.com>
Date: Mon, 18 Nov 2024 16:49:09 -0600
Subject: [PATCH] =?UTF-8?q?=E2=9C=A8=20Config=20updates?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit
---
Marlin/Configuration.h | 54 +++++++++++++++++++++-----------------
Marlin/Configuration_adv.h | 42 +++++++++++++++--------------
2 files changed, 53 insertions(+), 43 deletions(-)
diff --git a/Marlin/Configuration.h b/Marlin/Configuration.h
index 59b50e65d6f..c0778d5b800 100644
--- a/Marlin/Configuration.h
+++ b/Marlin/Configuration.h
@@ -50,7 +50,7 @@
*
* Calibration Guides: https://reprap.org/wiki/Calibration
* https://reprap.org/wiki/Triffid_Hunter%27s_Calibration_Guide
- * https://web.archive.org/web/20220907014303/https://sites.google.com/site/repraplogphase/calibration-of-your-reprap
+ * https://web.archive.org/web/20220907014303/sites.google.com/site/repraplogphase/calibration-of-your-reprap
* https://youtu.be/wAL9d7FgInk
* https://teachingtechyt.github.io/calibration.html
*
@@ -91,6 +91,8 @@
#define MOTHERBOARD BOARD_RAMPS_14_EFB
#endif
+// @section serial
+
/**
* Select the serial port on the board to use for communication with the host.
* This allows the connection of wireless adapters (for instance) to non-default port pins.
@@ -667,7 +669,7 @@
* MPCTEMP : Predictive Model temperature control. (~1.8K without auto-tune)
*/
#define PIDTEMP // See the PID Tuning Guide at https://reprap.org/wiki/PID_Tuning
-//#define MPCTEMP // ** EXPERIMENTAL ** See https://marlinfw.org/docs/features/model_predictive_control.html
+//#define MPCTEMP // See https://marlinfw.org/docs/features/model_predictive_control.html
#define PID_MAX 255 // Limit hotend current while PID is active (see PID_FUNCTIONAL_RANGE below); 255=full current
#define PID_K1 0.95 // Smoothing factor within any PID loop
@@ -819,14 +821,16 @@
// Lasko "MyHeat Personal Heater" (200w) modified with a Fotek SSR-10DA to control only the heating element
// and placed inside the small Creality printer enclosure tent.
//
- #define DEFAULT_chamberKp 37.04
- #define DEFAULT_chamberKi 1.40
+ #define DEFAULT_chamberKp 37.04
+ #define DEFAULT_chamberKi 1.40
#define DEFAULT_chamberKd 655.17
// M309 P37.04 I1.04 D655.17
// FIND YOUR OWN: "M303 E-2 C8 S50" to run autotune on the chamber at 50 degreesC for 8 cycles.
#endif // PIDTEMPCHAMBER
+// @section pid temp
+
#if ANY(PIDTEMP, PIDTEMPBED, PIDTEMPCHAMBER)
//#define PID_OPENLOOP // Puts PID in open loop. M104/M140 sets the output power from 0 to PID_MAX
//#define SLOW_PWM_HEATERS // PWM with very low frequency (roughly 0.125Hz=8s) and minimum state time of approximately 1s useful for heaters driven by a relay
@@ -882,7 +886,7 @@
//============================= Mechanical Settings =========================
//===========================================================================
-// @section machine
+// @section kinematics
// Enable one of the options below for CoreXY, CoreXZ, or CoreYZ kinematics,
// either in the usual order or reversed
@@ -1023,23 +1027,19 @@
#define DEFAULT_SEGMENTS_PER_SECOND 200
// Length of inner and outer support arms. Measure arm lengths precisely.
- #define TPARA_LINKAGE_1 120 // (mm)
- #define TPARA_LINKAGE_2 120 // (mm)
+ #define TPARA_LINKAGE_1 120 // (mm)
+ #define TPARA_LINKAGE_2 120 // (mm)
- // SCARA tower offset (position of Tower relative to bed zero position)
- // This needs to be reasonably accurate as it defines the printbed position in the SCARA space.
- #define TPARA_OFFSET_X 0 // (mm)
- #define TPARA_OFFSET_Y 0 // (mm)
- #define TPARA_OFFSET_Z 0 // (mm)
+ // TPARA tower offset (position of Tower relative to bed zero position)
+ // This needs to be reasonably accurate as it defines the printbed position in the TPARA space.
+ #define TPARA_OFFSET_X 0 // (mm)
+ #define TPARA_OFFSET_Y 0 // (mm)
+ #define TPARA_OFFSET_Z 0 // (mm)
#define SCARA_FEEDRATE_SCALING // Convert XY feedrate from mm/s to degrees/s on the fly
// Radius around the center where the arm cannot reach
#define MIDDLE_DEAD_ZONE_R 0 // (mm)
-
- // Calculated from Calibration Guide and M360 / M114. See https://www.morgan3dp.com/morgan-calibration-guide/
- #define THETA_HOMING_OFFSET 0
- #define PSI_HOMING_OFFSET 0
#endif
// @section machine
@@ -1585,8 +1585,8 @@
* probe Z Offset set with NOZZLE_TO_PROBE_OFFSET, M851, or the LCD.
* Only integer values >= 1 are valid here.
*
- * Example: `M851 Z-5` with a CLEARANCE of 4 => 9mm from bed to nozzle.
- * But: `M851 Z+1` with a CLEARANCE of 2 => 2mm from bed to nozzle.
+ * Example: 'M851 Z-5' with a CLEARANCE of 4 => 9mm from bed to nozzle.
+ * But: 'M851 Z+1' with a CLEARANCE of 2 => 2mm from bed to nozzle.
*/
#define Z_CLEARANCE_DEPLOY_PROBE 10 // (mm) Z Clearance for Deploy/Stow
#define Z_CLEARANCE_BETWEEN_PROBES 5 // (mm) Z Clearance between probe points
@@ -1632,6 +1632,8 @@
#define PROBING_BED_TEMP 50
#endif
+// @section stepper drivers
+
// For Inverting Stepper Enable Pins (Active Low) use 0, Non Inverting (Active High) use 1
// :{ 0:'Low', 1:'High' }
#define X_ENABLE_ON 0
@@ -1787,6 +1789,8 @@
#endif
/**
+ * @section filament runout sensors
+ *
* Filament Runout Sensors
* Mechanical or opto endstops are used to check for the presence of filament.
*
@@ -2065,7 +2069,7 @@
#if ENABLED(LCD_BED_TRAMMING)
#define BED_TRAMMING_INSET_LFRB { 30, 30, 30, 30 } // (mm) Left, Front, Right, Back insets
#define BED_TRAMMING_HEIGHT 0.0 // (mm) Z height of nozzle at tramming points
- #define BED_TRAMMING_Z_HOP 4.0 // (mm) Z height of nozzle between tramming points
+ #define BED_TRAMMING_Z_HOP 4.0 // (mm) Z raise between tramming points
//#define BED_TRAMMING_INCLUDE_CENTER // Move to the center after the last corner
//#define BED_TRAMMING_USE_PROBE
#if ENABLED(BED_TRAMMING_USE_PROBE)
@@ -2254,9 +2258,9 @@
#define PREHEAT_2_TEMP_CHAMBER 35
#define PREHEAT_2_FAN_SPEED 0 // Value from 0 to 255
-// @section motion
-
/**
+ * @section nozzle park
+ *
* Nozzle Park
*
* Park the nozzle at the given XYZ position on idle or G27.
@@ -2279,6 +2283,8 @@
#endif
/**
+ * @section nozzle clean
+ *
* Clean Nozzle Feature
*
* Adds the G12 command to perform a nozzle cleaning process.
@@ -2613,7 +2619,7 @@
//
// Original RADDS LCD Display+Encoder+SDCardReader
-// https://web.archive.org/web/20200719145306/http://doku.radds.org/dokumentation/lcd-display/
+// https://web.archive.org/web/20200719145306/doku.radds.org/dokumentation/lcd-display/
//
//#define RADDS_DISPLAY
@@ -2679,7 +2685,7 @@
//
// Elefu RA Board Control Panel
-// https://web.archive.org/web/20140823033947/http://www.elefu.com/index.php?route=product/product&product_id=53
+// https://web.archive.org/web/20140823033947/www.elefu.com/index.php?route=product/product&product_id=53
//
//#define RA_CONTROL_PANEL
@@ -2811,7 +2817,7 @@
//
// Cartesio UI
-// https://web.archive.org/web/20180605050442/http://mauk.cc/webshop/cartesio-shop/electronics/user-interface
+// https://web.archive.org/web/20180605050442/mauk.cc/webshop/cartesio-shop/electronics/user-interface
//
//#define CARTESIO_UI
diff --git a/Marlin/Configuration_adv.h b/Marlin/Configuration_adv.h
index 519ef50bf3b..9319ff2fbb8 100644
--- a/Marlin/Configuration_adv.h
+++ b/Marlin/Configuration_adv.h
@@ -423,7 +423,7 @@
#define PID_FAN_SCALING_LIN_FACTOR (PID_FAN_SCALING_AT_FULL_SPEED-DEFAULT_Kf)/255.0
#else
- #define PID_FAN_SCALING_LIN_FACTOR (0) // Power loss due to cooling = Kf * (fan_speed)
+ #define PID_FAN_SCALING_LIN_FACTOR (0) // Power-loss due to cooling = Kf * (fan_speed)
#define DEFAULT_Kf 10 // A constant value added to the PID-tuner
#define PID_FAN_SCALING_MIN_SPEED 10 // Minimum fan speed at which to enable PID_FAN_SCALING
#endif
@@ -621,7 +621,7 @@
/**
* Use one of the PWM fans as a redundant part-cooling fan
*/
-//#define REDUNDANT_PART_COOLING_FAN 2 // Index of the fan to sync with FAN 0.
+//#define REDUNDANT_PART_COOLING_FAN 1 // Index of the fan to sync with FAN 0.
/**
* Extruder cooling fans
@@ -959,7 +959,6 @@
*/
//#define BLTOUCH_HS_MODE true
-
#endif // BLTOUCH
// @section calibration
@@ -1086,14 +1085,14 @@
//#define INPUT_SHAPING_Y
#if EITHER(INPUT_SHAPING_X, INPUT_SHAPING_Y)
#if ENABLED(INPUT_SHAPING_X)
- #define SHAPING_FREQ_X 40 // (Hz) The default dominant resonant frequency on the X axis.
- #define SHAPING_ZETA_X 0.15f // Damping ratio of the X axis (range: 0.0 = no damping to 1.0 = critical damping).
+ #define SHAPING_FREQ_X 40.0 // (Hz) The default dominant resonant frequency on the X axis.
+ #define SHAPING_ZETA_X 0.15 // Damping ratio of the X axis (range: 0.0 = no damping to 1.0 = critical damping).
#endif
#if ENABLED(INPUT_SHAPING_Y)
- #define SHAPING_FREQ_Y 40 // (Hz) The default dominant resonant frequency on the Y axis.
- #define SHAPING_ZETA_Y 0.15f // Damping ratio of the Y axis (range: 0.0 = no damping to 1.0 = critical damping).
+ #define SHAPING_FREQ_Y 40.0 // (Hz) The default dominant resonant frequency on the Y axis.
+ #define SHAPING_ZETA_Y 0.15 // Damping ratio of the Y axis (range: 0.0 = no damping to 1.0 = critical damping).
#endif
- //#define SHAPING_MIN_FREQ 20 // By default the minimum of the shaping frequencies. Override to affect SRAM usage.
+ //#define SHAPING_MIN_FREQ 20.0 // (Hz) By default the minimum of the shaping frequencies. Override to affect SRAM usage.
//#define SHAPING_MAX_STEPRATE 10000 // By default the maximum total step rate of the shaped axes. Override to affect SRAM usage.
//#define SHAPING_MENU // Add a menu to the LCD to set shaping parameters.
#endif
@@ -1135,8 +1134,8 @@
#define DISABLE_IDLE_E // Shut down all idle extruders
// Default Minimum Feedrates for printing and travel moves
-#define DEFAULT_MINIMUMFEEDRATE 0.0 // (mm/s. °/s for rotational-only moves) Minimum feedrate. Set with M205 S.
-#define DEFAULT_MINTRAVELFEEDRATE 0.0 // (mm/s. °/s for rotational-only moves) Minimum travel feedrate. Set with M205 T.
+#define DEFAULT_MINIMUMFEEDRATE 0.0 // (mm/s) Minimum feedrate. Set with M205 S.
+#define DEFAULT_MINTRAVELFEEDRATE 0.0 // (mm/s) Minimum travel feedrate. Set with M205 T.
// Minimum time that a segment needs to take as the buffer gets emptied
#define DEFAULT_MINSEGMENTTIME 20000 // (µs) Set with M205 B.
@@ -1395,6 +1394,10 @@
#if HAS_MARLINUI_MENU
#if HAS_BED_PROBE
+
+ // Show Deploy / Stow Probe options in the Motion menu.
+ #define PROBE_DEPLOY_STOW_MENU
+
// Add calibration in the Probe Offsets menu to compensate for X-axis twist.
//#define X_AXIS_TWIST_COMPENSATION
#if ENABLED(X_AXIS_TWIST_COMPENSATION)
@@ -1409,8 +1412,6 @@
#define XATC_Z_OFFSETS { 0, 0, 0 } // Z offsets for X axis sample points
#endif
- // Show Deploy / Stow Probe options in the Motion menu.
- #define PROBE_DEPLOY_STOW_MENU
#endif
// Include a page of printer information in the LCD Main Menu
@@ -1434,7 +1435,7 @@
#if EITHER(HAS_DISPLAY, DWIN_LCD_PROUI)
// The timeout to return to the status screen from sub-menus
- //#define LCD_TIMEOUT_TO_STATUS 15000 // (ms)
+ #define LCD_TIMEOUT_TO_STATUS 60000 // (ms)
#if ENABLED(SHOW_BOOTSCREEN)
#define BOOTSCREEN_TIMEOUT 3000 // (ms) Total Duration to display the boot screen(s)
@@ -2490,7 +2491,7 @@
/**
* Set the number of proportional font spaces required to fill up a typical character space.
- * This can help to better align the output of commands like `G29 O` Mesh Output.
+ * This can help to better align the output of commands like 'G29 O' Mesh Output.
*
* For clients that use a fixed-width font (like OctoPrint), leave this set to 1.0.
* Otherwise, adjust according to your client and font.
@@ -2732,7 +2733,7 @@
#if AXIS_IS_TMC_CONFIG(X)
#define X_CURRENT 800 // (mA) RMS current. Multiply by 1.414 for peak current.
- #define X_CURRENT_HOME X_CURRENT // (mA) RMS current for sensorless homing
+ #define X_CURRENT_HOME X_CURRENT // (mA) RMS current for homing. (Typically lower than *_CURRENT.)
#define X_MICROSTEPS 16 // 0..256
#define X_RSENSE 0.11 // Multiplied x1000 for TMC26X
#define X_CHAIN_POS -1 // -1..0: Not chained. 1: MCU MOSI connected. 2: Next in chain, ...
@@ -3288,7 +3289,7 @@
//#define PHOTOGRAPH_PIN 23
// Canon Hack Development Kit
- // https://web.archive.org/web/20200920094805/https://captain-slow.dk/2014/03/09/3d-printing-timelapses/
+ // https://web.archive.org/web/20200920094805/captain-slow.dk/2014/03/09/3d-printing-timelapses/
//#define CHDK_PIN 4
// Optional second move with delay to trigger the camera shutter
@@ -3320,7 +3321,7 @@
* Add the M3, M4, and M5 commands to turn the spindle/laser on and off, and
* to set spindle speed, spindle direction, and laser power.
*
- * SuperPid is a router/spindle speed controller used in the CNC milling community.
+ * SuperPID is a router/spindle speed controller used in the CNC milling community.
* Marlin can be used to turn the spindle on and off. It can also be used to set
* the spindle speed from 5,000 to 30,000 RPM.
*
@@ -3668,7 +3669,9 @@
// @section reporting
-// Extra options for the M114 "Current Position" report
+/**
+ * Extra options for the M114 "Current Position" report
+ */
//#define M114_DETAIL // Use 'M114` for details to check planner calculations
//#define M114_REALTIME // Real current position based on forward kinematics
//#define M114_LEGACY // M114 used to synchronize on every call. Enable if needed.
@@ -4005,7 +4008,8 @@
/**
* Instant freeze / unfreeze functionality
- * Potentially useful for emergency stop that allows being resumed.
+ * Potentially useful for rapid stop that allows being resumed. Halts stepper movement.
+ * Note this does NOT pause spindles, lasers, fans, heaters or any other auxiliary device.
* @section interface
*/
//#define FREEZE_FEATURE