Coolstep for TMC2130, 2209, 5130, 5160

[Fabi0San]

Requirements

• Filling out this template is required. Pull Requests without a clear description may be closed at the maintainers' discretion.

Description

This change implements configuration and initialization for the CoolStep feature of TMC2209 drivers.
I followed the config style of other per driver Trinamic features.
The configs are passed in to the init methods via parameters as are other configs but I wonder whether that is preferable to directly using the defines with a switch(axis) given that these are not intended to be adjusted with M commands.

Benefits

This will allow 2209 (and possibly 2130) drivers to use the CoolStep feature which dramatically decrease heat and power use.
Though 2130s only have CoolStep and StallGuard for the SpreadCycle chopper, the 2209 brings those to StealthChop which makes them much more useful for 3D printers and relevant for Marlin.
That said we can implement CoolStep on 2130(and others?) if we feel that is at all useful.

Related Issues

I haven't created one, please let me know if that is a better starting point before creating the PR.

[Fabi0San]

Not sure if this is the right place to ask this but is there an automated way to get the new config values to be added to all example config values?

[sjasonsmith]

I posted a few thoughts, but didn't provide any feedback on the actual coolstep implementation. I'm not familiar with that feature or how to use it properly.

[thinkyhead]

is there an automated way to get the new config values to be added to all example config values?

No. It requires Human intervention to apply changes to the configs in an attentive way, but some of the process is scripted so it's pretty quick.

[thinkyhead]

Ok, so I was able to add support for coolStep in the TMC2130. And I did have to alter the initializers because without the change the CoolStep defines were required to exist if any TMC driver was present. The TMCStepper library's fallback TMC class definition includes CoolStep methods, so TMCStepper requires no changes.

[Fabi0San]

Ok, so I was able to add support for coolStep in the TMC2130.

Thanks driving this tentative PR forward Scott!

[Fabi0San]

Marlin/src/module/stepper/trinamic.cpp:803:14: error: 'X_COOLSTEP_SPEED_THRESHOLD' was not declared in this scope

Is there a way to macro a default value when things are not defined?
Something like COALESCE(X_COOLSTEP_SPEED_THRESHOLD, 0)

[thinkyhead]

Is there a way to macro a default value when things are not defined?

The error you received will be replaced by a sanity check telling the user to add the necessary defines.

[Fabi0San]

The error you received will be replaced by a sanity check telling the user to add the necessary defines.

Some tests do use the 2209 and are not defining these, should I change those configs and sanity check?

[thinkyhead]

The Configurations repo is updated with the new settings, so any failures now will be due to something other than missing settings.

[Fabi0San]

Configurations repo?
[Test megaatmega2560] RAMPS | SCARA | Mixed TMC | EEPROM... is still unhappy.

[thisiskeithb]

Not that they need it thanks to external mosfets, but can this be extended to TMC5160s as well? CoolStep is built-in.

[thinkyhead]

Configurations repo?

https://github.com/MarlinFirmware/Configurations

[Test megaatmega2560] RAMPS | SCARA | Mixed TMC | EEPROM... is still unhappy.

GitHub told me while I was taking a break to stretch my legs.

[thinkyhead]

Not that they need it thanks to external mosfets, but can this be extended to TMC5160s as well? CoolStep is built-in.

It looks like TMCStepper might need an update for that. I'll try compiling it in to see if it barks.

[teemuatlut]

I'll try to go over this during the weekend.

[SheelGreg]

Hello !
Sorry i'm a noob, i hope i'm in the right place for that.
This feature looks great ! But, i've a problem in Visual Code Studio (platform.io) on a BTT SKR 1.2 mini E3 while compiling :

d:\marlin\marlin-bugfix-2.0.x\marlin\configuration_adv.h:2297:24: error: missing binary operator before token "("
   #if AXIS_HAS_COOLSTEP(X)
                        ^

d:\marlin\marlin-bugfix-2.0.x\marlin\configuration_adv.h:2306:24: error: missing binary operator before token "("
   #if AXIS_HAS_COOLSTEP(X2)
                        ^

d:\marlin\marlin-bugfix-2.0.x\marlin\configuration_adv.h:2315:24: error: missing binary operator before token "("
   #if AXIS_HAS_COOLSTEP(Y)
                        ^

d:\marlin\marlin-bugfix-2.0.x\marlin\configuration_adv.h:2324:24: error: missing binary operator before token "("
   #if AXIS_HAS_COOLSTEP(Y2)`

Etc etc for all the axis and extruders.
I just downloaded the latest bugfix 2.0.X, few minutes ago.

Thanks a lot

[daleckystepan]

Hi guys, CoolStep is enabled by default. I'm using TMC 2130. Is it better than stealtchop for precision or print quality? Or only power consumption and cooling?

I have disabled CoolStep by
#define X_COOLSTEP_LOWER_LOAD_THRESHOLD 0
but the motor sound is definitely different than before this patch. Probably SpreadCycle or CoolStep is still active.

https://github.com/daleckystepan/Marlin/blob/bugfix-2.0.x/Marlin/Configuration.h
https://github.com/daleckystepan/Marlin/blob/bugfix-2.0.x/Marlin/Configuration_adv.h

[thinkyhead]

This will be going away. It's not a system that users should be messing with at this time.

[Thinkersbluff]

This will be going away. It's not a system that users should be messing with at this time.

Rats. I got excited there, for a minute.
I had to replace my first BTT SKR e3 mini, 3 weeks after installing it, because the X-Axis drive failed. (My X, Y and Z motors were all hot enough to fry eggs. Not quite sure why, yet, but I suspect the TMC2209 burned-out.)
I am now having similar problems with the replacement board (so far just the X Motor has overheated but no "deaths"), and I am trying to quickly determine what to adjust to prevent killing the new board. Based on the TMC 2209 datasheet activating the Coolstep feature looked like a promising option, but I cannot find it by name it in the Marlin config files.

I have uncommented this line in Configuration_adv.h, in the hopes that it will detect any motor overheat and automatically drop the current another 50mA: #define MONITOR_DRIVER_STATUS.
I was not able to compile with TMC_DEBUG activated, however (did not fit rom), so I am not sure whether the MONITOR will work.

Any comment/advice?

[thinkyhead]

Unfortunately we project maintainers are far from experts in the code we maintain, and though we try to have some general concept of what is going on we are not ourselves very familiar will all kinds of hardware and how to deal with their quirks. So I must throw you a canned reply:

This Issue Queue is for Marlin bug reports and development-related issues, and we prefer not to handle user-support questions here. (As noted on this page.) For best results getting help with configuration and troubleshooting, please use the following resources:

• MarlinFW.org Marlin Documentation
• RepRap.org Marlin Forum
• Tom's 3D Forums
• Facebook Group "Marlin Firmware"
• Facebook Group "Marlin Firmware for 3D Printers"
• Marlin Configuration on YouTube
• Marlin Discord server. Join link: https://discord.gg/n5NJ59y

After seeking help from the community, if the consensus points to to a bug in Marlin, then you should post a bug report.

[Thinkersbluff]

No sweat, Scott. Thanks for the quick response. I thought the thread was discussing plans to add a feature I am looking for. I will move to the right forum. Cheers.

[cryptoAlgorithm]

Would love to see this merged again soon, messing with TMC_ADV isn't my cup of tea