Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update/arrange FWRETRACT #27351

Closed
wants to merge 10 commits into from
Closed

Update/arrange FWRETRACT #27351

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
db83fc7
update fwretract
classicrocker883 Aug 13, 2024
1719316
remove typo
classicrocker883 Aug 13, 2024
36c50e6
Merge branch 'bugfix-2.1.x' into bugfix-2.1.x-August3
classicrocker883 Aug 17, 2024
37ca1fd
arrange Gcode, comments
classicrocker883 Oct 16, 2024
1c75fb6
Merge branch 'bugfix-2.1.x' of https://github.com/MarlinFirmware/Marl…
classicrocker883 Oct 16, 2024
22dad3a
update spacing
classicrocker883 Oct 16, 2024
aed8cae
Merge branch 'bugfix-2.1.x' of https://github.com/MarlinFirmware/Marl…
classicrocker883 Oct 20, 2024
160bf2c
Merge branch 'bugfix-2.1.x' of https://github.com/MarlinFirmware/Marl…
classicrocker883 Oct 21, 2024
b04e5ee
Merge https://github.com/MarlinFirmware/Marlin into bugfix-2.1.x-August3
classicrocker883 Nov 21, 2024
4dc7cb0
Merge branch 'bugfix-2.1.x' into bugfix-2.1.x-August3
classicrocker883 Mar 17, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 33 additions & 34 deletions Marlin/src/feature/fwretract.cpp
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,21 +44,21 @@ FWRetract fwretract; // Single instance - this calls the constructor
// private:

#if HAS_MULTI_EXTRUDER
Flags<EXTRUDERS> FWRetract::retracted_swap; // Which extruders are swap-retracted
Flags<EXTRUDERS> FWRetract::retracted_swap; // Which extruders are swap-retracted
#endif

// public:

fwretract_settings_t FWRetract::settings; // M207 S F Z W, M208 S F W R
fwretract_settings_t FWRetract::settings; // M207 S F Z W, M208 S F W R

#if ENABLED(FWRETRACT_AUTORETRACT)
bool FWRetract::autoretract_enabled; // M209 S - Autoretract switch
bool FWRetract::autoretract_enabled; // M209 S - Autoretract switch
#endif

Flags<EXTRUDERS> FWRetract::retracted; // Which extruders are currently retracted
Flags<EXTRUDERS> FWRetract::retracted; // Which extruders are currently retracted

float FWRetract::current_retract[EXTRUDERS], // Retract value used by planner
FWRetract::current_hop;
float FWRetract::current_retract[EXTRUDERS]; // Retract value used by planner
float FWRetract::current_hop;

void FWRetract::reset() {
TERN_(FWRETRACT_AUTORETRACT, autoretract_enabled = false);
Expand Down Expand Up @@ -87,7 +87,7 @@ void FWRetract::reset() {
*
* To simplify the logic, doubled retract/recover moves are ignored.
*
* Note: Auto-retract will apply the set Z hop in addition to any Z hop
* NOTE: Auto-retract will apply the set Z hop in addition to any Z hop
* included in the G-code. Use M207 Z0 to to prevent double hop.
*/
void FWRetract::retract(const bool retracting E_OPTARG(bool swapping/*=false*/)) {
Expand Down Expand Up @@ -136,29 +136,27 @@ void FWRetract::retract(const bool retracting E_OPTARG(bool swapping/*=false*/))
if (retracting) {
// Retract by moving from a faux E position back to the current E position
current_retract[active_extruder] = base_retract;
prepare_internal_move_to_destination( // set current from destination
prepare_internal_move_to_destination( // Set current from destination
MUL_TERN(RETRACT_SYNC_MIXING, settings.retract_feedrate_mm_s, MIXING_STEPPERS)
);

// Is a Z hop set, and has the hop not yet been done?
if (!current_hop && settings.retract_zraise > 0.01f) { // Apply hop only once
current_hop += settings.retract_zraise; // Add to the hop total (again, only once)
// Raise up, set_current_to_destination. Maximum Z feedrate
prepare_internal_move_to_destination(fr_max_z);
if (!current_hop && settings.retract_zraise > 0.01f) { // Apply hop only once
current_hop += settings.retract_zraise; // Add to the hop total (again, only once)
prepare_internal_move_to_destination(fr_max_z); // Raise up, set_current_to_destination. Maximum Z feedrate
}
}
else {
// If a hop was done and Z hasn't changed, undo the Z hop
if (current_hop) {
current_hop = 0;
// Lower Z, set_current_to_destination. Maximum Z feedrate
prepare_internal_move_to_destination(fr_max_z);
prepare_internal_move_to_destination(fr_max_z); // Lower Z, set_current_to_destination. Maximum Z feedrate
}

const float extra_recover = swapping ? settings.swap_retract_recover_extra : settings.retract_recover_extra;
if (extra_recover) {
current_position.e -= extra_recover; // Adjust the current E position by the extra amount to recover
sync_plan_position_e(); // Sync the planner position so the extra amount is recovered
current_position.e -= extra_recover; // Adjust the current E position by the extra amount to recover
sync_plan_position_e(); // Sync the planner position so the extra amount is recovered
}

current_retract[active_extruder] = 0;
Expand All @@ -169,9 +167,9 @@ void FWRetract::retract(const bool retracting E_OPTARG(bool swapping/*=false*/))
);
}

TERN_(RETRACT_SYNC_MIXING, mixer.T(old_mixing_tool)); // Restore original mixing tool
TERN_(RETRACT_SYNC_MIXING, mixer.T(old_mixing_tool)); // Restore original mixing tool

retracted.set(active_extruder, retracting); // Active extruder now retracted / recovered
retracted.set(active_extruder, retracting); // Active extruder now retracted / recovered

// If swap retract/recover update the retracted_swap flag too
#if HAS_MULTI_EXTRUDER
Expand All @@ -198,52 +196,53 @@ void FWRetract::retract(const bool retracting E_OPTARG(bool swapping/*=false*/))
* M207: Set firmware retraction values
*
* S[+units] retract_length
* W[+units] swap_retract_length (multi-extruder)
* F[units/min] retract_feedrate_mm_s
* W[+units] swap_retract_length (multi-extruder)
* Z[units] retract_zraise
*/
void FWRetract::M207() {
if (!parser.seen("FSWZ")) return M207_report();
if (!parser.seen("SFWZ")) return M207_report();
if (parser.seenval('S')) settings.retract_length = parser.value_axis_units(E_AXIS);
if (parser.seenval('F')) settings.retract_feedrate_mm_s = MMM_TO_MMS(parser.value_axis_units(E_AXIS));
if (parser.seenval('Z')) settings.retract_zraise = parser.value_linear_units();
if (parser.seenval('W')) settings.swap_retract_length = parser.value_axis_units(E_AXIS);
if (parser.seenval('Z')) settings.retract_zraise = parser.value_linear_units();
}

void FWRetract::M207_report() {
TERN_(MARLIN_SMALL_BUILD, return);

SERIAL_ECHOLNPGM_P(
PSTR(" M207 S"), LINEAR_UNIT(settings.retract_length)
, PSTR(" W"), LINEAR_UNIT(settings.swap_retract_length)
, PSTR(" F"), LINEAR_UNIT(MMS_TO_MMM(settings.retract_feedrate_mm_s))
, SP_Z_STR, LINEAR_UNIT(settings.retract_zraise)
PSTR(" M207 S"), LINEAR_UNIT(settings.retract_length),
PSTR(" F"), LINEAR_UNIT(MMS_TO_MMM(settings.retract_feedrate_mm_s)),
PSTR(" W"), LINEAR_UNIT(settings.swap_retract_length),
SP_Z_STR, LINEAR_UNIT(settings.retract_zraise)
);
}

/**
* M208: Set firmware un-retraction values
*
* S[+units] retract_recover_extra (in addition to M207 S*)
* W[+units] swap_retract_recover_extra (multi-extruder)
* F[units/min] retract_recover_feedrate_mm_s
* W[+units] swap_retract_recover_extra (multi-extruder)
* R[units/min] swap_retract_recover_feedrate_mm_s
*/
void FWRetract::M208() {
if (!parser.seen("FSRW")) return M208_report();
if (parser.seen('S')) settings.retract_recover_extra = parser.value_axis_units(E_AXIS);
if (parser.seen('F')) settings.retract_recover_feedrate_mm_s = MMM_TO_MMS(parser.value_axis_units(E_AXIS));
if (parser.seen('R')) settings.swap_retract_recover_feedrate_mm_s = MMM_TO_MMS(parser.value_axis_units(E_AXIS));
if (parser.seen('W')) settings.swap_retract_recover_extra = parser.value_axis_units(E_AXIS);
if (!parser.seen("SFRW")) return M208_report();
if (parser.seenval('S')) settings.retract_recover_extra = parser.value_axis_units(E_AXIS);
if (parser.seenval('F')) settings.retract_recover_feedrate_mm_s = MMM_TO_MMS(parser.value_axis_units(E_AXIS));
if (parser.seenval('W')) settings.swap_retract_recover_extra = parser.value_axis_units(E_AXIS);
if (parser.seenval('R')) settings.swap_retract_recover_feedrate_mm_s = MMM_TO_MMS(parser.value_axis_units(E_AXIS));
}

void FWRetract::M208_report() {
TERN_(MARLIN_SMALL_BUILD, return);

SERIAL_ECHOLNPGM(
" M208 S", LINEAR_UNIT(settings.retract_recover_extra)
, " W", LINEAR_UNIT(settings.swap_retract_recover_extra)
, " F", LINEAR_UNIT(MMS_TO_MMM(settings.retract_recover_feedrate_mm_s))
" M208 S", LINEAR_UNIT(settings.retract_recover_extra),
" F", LINEAR_UNIT(MMS_TO_MMM(settings.retract_recover_feedrate_mm_s)),
" W", LINEAR_UNIT(settings.swap_retract_recover_extra),
" R", LINEAR_UNIT(MMS_TO_MMM(settings.swap_retract_recover_feedrate_mm_s))
);
}

Expand Down
26 changes: 13 additions & 13 deletions Marlin/src/feature/fwretract.h
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,36 +28,36 @@
#include "../inc/MarlinConfigPre.h"

typedef struct {
float retract_length; // M207 S - G10 Retract length
feedRate_t retract_feedrate_mm_s; // M207 F - G10 Retract feedrate
float retract_zraise, // M207 Z - G10 Retract hop size
retract_recover_extra; // M208 S - G11 Recover length
feedRate_t retract_recover_feedrate_mm_s; // M208 F - G11 Recover feedrate
float swap_retract_length, // M207 W - G10 Swap Retract length
swap_retract_recover_extra; // M208 W - G11 Swap Recover length
feedRate_t swap_retract_recover_feedrate_mm_s; // M208 R - G11 Swap Recover feedrate
float retract_length; // M207 S - G10 Retract length
feedRate_t retract_feedrate_mm_s; // M207 F - G10 Retract feedrate
float swap_retract_length, // M207 W - G10 Swap Retract length
retract_zraise, // M207 Z - G10 Retract hop size
retract_recover_extra; // M208 S - G11 Recover length
feedRate_t retract_recover_feedrate_mm_s; // M208 F - G11 Recover feedrate
float swap_retract_recover_extra; // M208 W - G11 Swap Recover length
feedRate_t swap_retract_recover_feedrate_mm_s; // M208 R - G11 Swap Recover feedrate
} fwretract_settings_t;

#if ENABLED(FWRETRACT)

class FWRetract {
private:
#if HAS_MULTI_EXTRUDER
static Flags<EXTRUDERS> retracted_swap; // Which extruders are swap-retracted
static Flags<EXTRUDERS> retracted_swap; // Which extruders are swap-retracted
#endif

public:
static fwretract_settings_t settings;

#if ENABLED(FWRETRACT_AUTORETRACT)
static bool autoretract_enabled; // M209 S - Autoretract switch
static bool autoretract_enabled; // M209 S - Autoretract switch
#else
static constexpr bool autoretract_enabled = false;
#endif

static Flags<EXTRUDERS> retracted; // Which extruders are currently retracted
static float current_retract[EXTRUDERS], // Retract value used by planner
current_hop; // Hop value used by planner
static Flags<EXTRUDERS> retracted; // Which extruders are currently retracted
static float current_retract[EXTRUDERS]; // Retract value used by planner
static float current_hop; // Hop value used by planner

FWRetract() { reset(); }

Expand Down
Loading