Caution
This is still very much a work in progress, and has had very little practical testing.
This is my custom configuration for the Kalico 3D printer firmware. It is designed to be easy to set up, and highly modular. I made this primarily to make it easier to share macros and other settings between printers, as well as to provide a config backup in case anything unfortunate happens.
Warning
Usage of this config is at your own risk.
This config is tailored to my own printers with the specific idiosyncrasies that they have. One of those is Kalico, so there are options and features in use here that won't be compatible with mainline Klipper.
This config works by symlinking the config files into ~/printer_data/config.
Because of this, they will not be editable outside of the repo directory. The
intent is that the "User" files are where on-the-fly tweaks happen in order to
tune the printer. Once things settle in, those changes should be moved to the
"Printer" files in the repo leaving the editable files mostly empty.
The only files editable from the web interface will be the printer.cfg and
moonraker.conf files that are created during installation. These are created
with just an [include] to their respective "Printer" files and a boilerplate
SAVE_CONFIG section to ensure the command works out of the box.
The printer name is used in various ways to define a specific printer, so it's important to have a unique name for each printer using this config. This is especially important if hosting multiple printers on one device.
In the repo directory, there should be separate directories with unique names
used to identify a printer (eg. ~/klipper_config/printer_ruby
or ~/klipper_config/printer_slate). This is where printer
specific files are kept to actually define its hardware capabilities. Each will
have [include]s to their respective "Common" files for the various hardware
and software that it uses.
These files will be symlinked to the config folder as eg. _ruby.conf, _ruby.cfg, and _variables.cfg.
All major config files are located in ~/klipper_config/common. These define the macros, MCUs, drivers, etc. These are generally self contained and can be thought of as a parts bin of sorts. Also included here are the most basic moonraker.conf and printer.cfg files, populated with the options that any printer would need.
Like many generalist configs these days, this one makes significant use of a
_USER_VARIABLES macro. The variable.cfg file in this folder provides the
defaults for all defined user vars, along with any necessary documentation.
You should start with a fresh OS installation, like Raspberry Pi OS Lite. If using a some other spare computer, I recommend Pop!_OS. I also recommend setting up any OS level customizations like wifi, ssh, hostname, etc., then making a backup image prior to installing this config. This can then be used to quickly spin up a new printer, or recover an existing one.
Next, you'll need to fork this repo and rename the printer_<name> folders to
match your setup. If you're not comfortable with linux and git commands, you can
press period (.) to open web vs code. From here you can rename the folders and
then in the Source Control tab enter "Rename printer folders" as the message and
click "Commit & Push".
Install KIAUH and use this guide to install Kalico. If installing multiple instances, be sure to use the same names used for the folders above. You'll also need to install Moonraker and Fluidd, as well as to flash your MCU(s).
wget -O - https://raw.githubusercontent.com/gethe/klipper_config/main/install.sh | bash -s nameThe install script will look for folders matching the default patterns used by
KIAUH -- ~/printer_data for single-instance setups and ~/printer_<name>_data
for multi-instance setups. If you're using a different naming scheme, the full
path can be supplied as an optional second parameter to the install script.
If you're setting up a new printer on a multi-instance host, run this command
from $HOME:
./klipper_config/install.sh <name>OrcaSlicer
In OrcaSlicer go to "Printer settings" -> "Machine start g-code" and update it to:START_PRINT EXTRUDER=[first_layer_temperature[initial_extruder]] BED=[first_layer_bed_temperature[initial_extruder]] CHAMBER=[chamber_temperature[initial_extruder]] MATERIAL=[filament_type[initial_extruder]]END_PRINTBEFORE_LAYER_CHANGE Z=[layer_z] LAYER=[layer_num];[layer_z]
AFTER_LAYER_CHANGEA lot of inspiration outside of my own has gone into this config, and I would be remiss to not place credit where it is due.
Projects that this config depends on include:
Many of the scripts, macros, and config files included in this repo are based on or inspired by work from: