3.9 KiB
** Flashing the firmware is not required for any method
Should You Update?
I treat this config like software, and like any piece of modern software, it will require periodic updates to fix issues, add features, improve functionality, etc. So, if you want to have the latest and greatest, I recommend you periodically pull the changes from this repo.
What Changes Should You Be Concerned With
The only changes you need to be concerned with relate to the .cfg and .conf files; all changes to .md files (these are markdown files, the text that you see when you visit this repo) can be ignored.
Git Users
If you do a git diff origin/master --name-only and it shows you that a .cfg file has changed, you might want to pull in those changes (but you don't have to).
Non-Git Users
Unfortunately, there's no simple way for you to ascertain whether there have been changes. I simply recommend that you update your config via the instructions below from time to time.
How to Update
There are three methods to accomplish this:
- The correct method, using
git. - The mostly acceptable method, without using
git. - The start-from-scratch method. Recommended for non-git users and those who haven't made many changes to their configuration.
The git method.
⚠️ This method is only intended for those who already know how to use git.
📝 In this example, I'm using the master branch which applies to SV06 users only. Be sure to use the appropriate branch for your printer.
📝 The assumption is that you didn't change branches after the initial setup, so you are in master, and there are many untracked changes.
sshinto your Klipper host.cd ~/printer_data/configgit checkout -b my-settingsgit add .git commit -m "Saving my settings."git checkout mastergit pullgit checkout my-settingsgit merge master --no-ff --no-commit- Deal with comparing and pulling in incoming changes from
masterusing your favourite code editor. You can also do this from the command line viagit commit --interactive, however, only advancedgitusers should attempt this, though it is easy enough. - Add all welcomed changes to the staging area, and discard all other changes.
git commit -m "Update with upstream."
You should push your branch to your own fork of this repo.
For any future updates, you can run through the same process again, however, you cannot re-create the my-settings branch as you did in step 3, because it already exists. Simply omit the -b flag in step 3 next time you update.
The mostly acceptable method.
This method has shortcomings, because it relies on the user's memory, and requires more manual edits. Perfectly functional method, however.
- Read all the documentation.
- Backup your current configuration, essentially everything inside
~/printer_data/config. - Repeat steps in Download OSS Klipper Configuration, and Adjust Configuration with MCU Path.
- Copy everything from
#*# <---------------------- SAVE_CONFIG ---------------------->onward and paste into newprinter.cfg, inclusive. - Copy any other changes you might have made into the new configuration. Maybe you had adjusted the size of your printer (
position_max), or other such changes.
The start-from-scratch method.
- Delete the folder
~/printer_data/config. - Recreate the folder
~/printer_data/configviamkdir ~/printer_data/config. - Start the Klipper installation process starting from
Download OSS Klipper Configurationin the appropriate branch.
Linux Tips
- In linux, you can delete files via
rm fileNameand directories viarmdir directoryName. - In linux, you can list files and folders via
ls -lah.
You are now up-to-date with this repo, and have added your personal settings on top.