There are two mainstream options for software: OctoPrint and Mainsail. Both are supported, however Mainsail was developed specifically for the Voron environment.
Install OctoPrint on the Raspberry Pi by following the instructions found at OctoPrint Download
Once installed, ssh to your Raspberry Pi (Using PuTTY on Windows or the terminal on MacOS) at the address [email protected]. The default password is 'raspberry'. It is highly recommended to change the default password using the following process:
- Login to Raspberry Pi
sudo raspi-config(password may be requested again)- Select "Change User Password" to change the password
Make sure to only do the testing after Klipper is installed
The OctoPrint web server needs to be configured to communicate with the Klipper host software. Using a web browser, login to the OctoPrint web page and then configure the following items:
- Navigate to the Settings tab (the wrench icon at the top of the page)
- Under "Serial Connection" in "Additional serial ports" add "/tmp/printer" then click "Save"
- Open Settings tab and under "Serial Connection" change the "Serial Port" setting to "/tmp/printer"
- In the Settings tab, navigate to the "Behavior" sub-tab and select the "Cancel any ongoing prints but stay connected to the printer" option, then click “Save”
- From the main page, under the "Connection" section (at the top left of the page) make sure the "Serial Port" is set to "/tmp/printer" and click "Connect". (If "/tmp/printer" is not an available selection then try reloading the page)
- Once connected, navigate to the "Terminal" tab and type "status" (without the quotes) into the command entry box and click "Send". The terminal window will likely report there is an error opening the config file - that means OctoPrint is successfully communicating with Klipper.
- OctoKlipper
- Themeify
- TerminalCommands
- Bed Level Visualizer
- Print Time Genius
Mainsail is a lightweight web interface for Klipper and other subsystems. It does not support plugins but generally doesn't need to. To install Mainsail, follow the instructions on the Mainsail page.
Do not install Mainsail onto an OctoPi image!
External References:
If installing Mainsail and using that process, skip just the installation step as it will already be covered.
Once at the command line of the Raspberry Pi, run the following commands to download and install the latest version of Klipper:
cd
git clone https://github.com/KevinOConnor/klipper
./klipper/scripts/install-octopi.sh
The Klippy log file (/tmp/klippy.log) contains debugging information.
Execute the M112 command in the OctoPrint terminal window immediately after the undesirable event.
There is also a logextract.py script that may be useful when analyzing a micro-controller shutdown or similar problem. To use it follow this procedure:
mkdir work_directory
cd work_directory
cp /tmp/klippy.log .
~/klipper/scripts/logextract.py ./klippy.log
The script will extract the printer config file and MCU shutdown information to work_directory.
This appears when the communication between the TMC drivers and the MCU is not working. Typically this means that you have not powered the SKR board with 12-24V (TMC drivers didn’t boot), you haven’t plugged in the TMC steppers to the correct spots, or you forgot to add or remove a jumper as detailed above.
ADC stands for “Analog to Digital Converter” and is what is used to convert thermistor readings to temperatures for your hotend and heated bed. As a safety precaution, if Klipper is expecting a thermistor to be plugged in but it is reading an invalid reading (no thermistor = open, or 0 ohms for a shorted wire as closed), it will go in to this shut down mode. Double check to make sure your thermistors are plugged in to the correct boards and plugs.
Once the underlying issue is corrected, use the FIRMWARE_RESTART command to reset the firmware, reload the config, and restart the host software. Check MCU IDs match your printer.cfg. Make sure you get the paths right!