Skip to content

Ultimaker Cura plugin to enable various settings and features specific to Klipper firmware.

License

Notifications You must be signed in to change notification settings

Moschkara/KlipperSettingsPlugin

 
 

Repository files navigation

KlipperSettingsPlugin

Compatibility tested up to Cura version 5.0.0 (SDK 8.0.0)

Unofficial Cura plugin which adds a new "Klipper Settings" category and a number of Klipper-specific setting features to the bottom of the Cura settings list. Designed to work natively on any printer running Klipper without the need for macros.

This is a work in progress spawned from my PressureAdvanceSettingPlugin which this is intended to take the place of. The current version implements the same Pressure Advance settings into the new category as well as options to initiate Klipper's Tuning Tower sequence and various other Klipper settings.

Additional features are in the works but please feel free to propose suggestions.

Initial Release Notes (v0.8.0 Beta)

  • Compatible up to Cura version 5.
  • Adds new "Klipper Settings" category
  • Pressure Advance control with support for per-object settings and multiple extruders.
  • Simplified Tuning Tower command settings.
  • Klipper-specific velocity limit settings.

Current Release Notes (v0.9.x Beta)

  • Adds Klipper category icon.
  • Firmware retraction settings.
  • Input shaper settings.
  • New preset feature for tuning tower.
    • Pressure Advance preset settings.
    • Ringing Tower preset settings.
  • Improved tooltip descriptions and setting behavior.
  • Various bug fixes and other improvements.
Bug Fix (v0.9.2 Beta)

  • v0.9.1
    • Fixed crashing in older Cura versions.
    • Custom icon now only enabled for Cura 5.0+
    • Improved presets and backup behavior
  • v0.9.2
    • Fixed incorrect parameter in Pressure Advance Preset
    • Preset layer height now suggested from nozzle size

Check setting visibility for new features after updating!

Compatibility

Tested stable up to Cura 5.0 and 4.8+ seems to work well but various quality of life features are disabled as versions get older. Per-object Pressure Advance setting support is currently disabled for Cura versions prior to 4.7. Please report any significant version problems. Multiple extruders are generally supported but new tuning tower presets may not yet properly restore settings for all extruders.

How to Use

Once installed, the Klipper Settings category will initially be hidden but should show up at the bottom of setting visibility preferences. If they don't appear, try selecting the "All" settings preset. Enable visibility of every settings to ensure it's working then hide whatever you don't plan to use. I suggest leaving visibility enabled for checkbox settings like the Apply Suggested Settings preset option since it only becomes visible for specific settings.

The current Tuning Tower presets are defined by settings described in the Klipper documentation. If the Apply Suggested Settings option is disabled, the preset will only affect Tuning Tower settings. When enabled, additional Klipper and printer settings necessary for the calibration will also be set. For example, reducing max_accel and square_corner_velocity during Pressure Advance calibration. Any settings changed will be restored to their prior values when the tuning tower is disabled or Cura is restarted.

Read setting tooltips for additional help with current features.

All Supported Klipper Settings
Tooltips explain why some settings have negative values by default.

image

Pressure Advance Tuning Tower Preset
Example with 'Apply Suggested Settings' enabled.

image

Ringing Tower Tuning Tower Preset
Example with 'Apply Suggested Settings' enabled.

image

I highly recommend also using Ghostkeeper's amazing SettingsGuide to improve readability of tooltips.

Installation

If Plugin Already Installed

Simply delete and replace contents of KlipperSettingsPlugin folder with those from the latest release. Make sure all files are replaced. Any additional files in the previous version are obsolete or temporary and can safely be deleted. If you have issues, delete entire folder and install as instructed below.

Install from Source Files

Uninstall PressureAdvanceSettingPlugin, if already added to Cura.

Download KlipperSettingsPlugin source .zip file from Github.

Open Cura, click 'Help', 'Show Configuration Folder', then navigate to the "plugins" subfolder and unpack .zip file there. Rename folder to "KlipperSettingsPlugin", removing suffix added by Github (e.g "-master").

Repeat process if there's a subfolder of the same name.

More Info

For more information about Klipper firmware, see the official documentaion at Klipper3D.org.

For quicker response to questions or feedback, contact me directly at jjfx.contact@gmail.com.

About

Ultimaker Cura plugin to enable various settings and features specific to Klipper firmware.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • Python 100.0%