Software Installation
Table of contents
I already use Klipper with Mainsail on my current printers so it was a natural choice for this project. My installation is running on a Raspberry Pi. Since I prefer to start with a bare bones system and cherry pick what I need, I flashed Raspberry Pi OS Lite then used KIAUH for a “manual” install.
I have a tutorial for Baking a Raspberry Pi in my other blog.
Since so much information already exists between the KIAUH docs along with the Klipper and Mainsail pages I suggest referring to them for more details on the installation process and methods. Here I will outline some basic steps for my general software install and do a deeper dive into things like CANBus and other unique features of my build.
Klipper Host
The first step is to get a Klipper host up and running. I’m running a bare bones install of Raspberry Pi OS Lite on a Raspberry Pi. Using KIAUH, I installed Klipper, Moonraker, and Mainsail. Klipper and Moonraker are mandatory but the frontend, in my case Mainsail, can be different. KIAUH also includes some other software that can be installed at this time if desired. These installations can also be done manually by referencing the individual documentations.
RPi as an MCU
The Raspberry Pi can also be used as a secondary MCU. This means the GPIO pins on the the Pi can be accessed and controlled by Klipper. Since we’re already in the Pi, might as well set that up now.
Open the Klipper directory and set the MCU process to start before Klipper:
cd ~/klipper/
sudo cp ./scripts/klipper-mcu.service /etc/systemd/system/
sudo systemctl enable klipper-mcu.service
Build the MCU firmware by running make menuconfig and selecting Linux process.
Once the firmware is built, flash it to the Raspberry Pi:
sudo service klipper stop
make flash
sudo service klipper start
Sonar
I also run Sonar on my build. Its a WiFi keepalive daemon and occasionally my Pi likes to drop connections. They also provide a straight forward install script.
I also found running the Pi on a 2.4 GHz only WiFi and with IPv6 disabled seems to be more stable.
Mainboard (BTT SKR Mini E3 V3)
I am running my personal setup in a USB to CAN configuration. This this is covered here. The steps below outline a basic Klipper install.
The Klipper firmware needs to be compiled and flashed to the mainboard. On the host run the following:
cd ~/klipper
make menuconfig
This opens the Klipper configuration tool. Make the selections in accordance with the mainboard in use. The Klipper GitHub contains a list of example configs for many mainboards along with the required settings.
I’ve provided a screenshot of the standard SKR Mini E3 V3 settings using USB communications.
After setting and saving the required values clear out any previous firmware builds and generate the new firmware file.
make clean
make
This will generate the firmware as a klipper.bin file in under the standard path of ~/klipper/out/klipper.bin
The SKR Mini E3 V3 requires the firmware be flashed via SD card. Copy klipper.bin to a MicroSD card that has been formatted to FAT32. Rename klipper.bin to firmware.bin.
Copy the firmware with whatever method works best. I’ve used SCP, SFTP, Samba, and a direct mount in the past.
I’ve had issues with 32GB Samsung MicroSD cards flashing the firmware. The cheap 8GB card that came with my Ender always works fine though.
Power off the printer mainboard, insert the firmware SD card, and power on the mainbaord. Wait several moments for the firmware to flash.
A successful flash can be confirmed in two ways.
- Assuming the Pi is connected via USB to the SKR run:
ls /dev/serial/by-idAn output similar to
usb-Klipper-stm32g0b1xx_#####################-####should be generated.OR
- Insert the SD card back into a computer and the
firmware.binfile should have automatically changed tofirmware.cur
Use the ls /dev/serial/by-id output in the printer.cfg file to tell Klipper where it can find the control board.
[mcu]
serial: /usb-Klipper-stm32g0b1xx_#####################-####
With Klipper installed on the Pi and flashed to the mainboard. Its time to start the configuration.