Installation

First steps

Install the screen, following the instructions provided by the manufacturer, Some screens don't neeed extra software but some need to be installed with a script. It's strongly recommended to test it and ensure your hardware is working with RaspberryOS, Ubuntu or any distro you like. Once you have established that the screen is working, then proceed installing KlipperScreen.

Setup

This install process is meant for a non-desktop version of the OS for example RaspberryOS Lite, but it should work on other debian derivatives.

If you installed a desktop (GUI version) of the OS and want to run KlipperScreen exclusively then do:

Boot to console / KlipperScreen

sudo systemctl set-default multi-user.target
sudo reboot

to undo and go back to the desktop environment:

Boot to the desktop

sudo systemctl set-default graphical.target
sudo reboot

Auto install

KIAUH is a tool that helps you install or upgrade Klipper, Moonraker, Mainsail, and other extensions.

You can visit KIAUH on GitHub to learn more and view its documentation.

Manual Install

First install Klipper and Moonraker.

KlipperScreen Installation

Execute the following commands:

cd ~/
git clone https://github.com/KlipperScreen/KlipperScreen.git
cd ~/KlipperScreen
./scripts/KlipperScreen-install.sh

This script will install packages that are listed under manual install, create a python virtual environment at ~/.KlipperScreen-env and install a systemd service file.

If you need a custom location for the configuration file, you can add -c or --configfile to the systemd file and specify the location of your configuration file.

At this point KlipperScreen should be working, if it doesn't start then go to the troubleshooting page

Moonraker configuration

In moonraker.conf ensure that the IP of the device is a trusted client:

moonraker.conf

[authorization]
trusted_clients:
  127.0.0.1

Warning

having force_logins: true in this section or if you don't want to use trusted_clients

Will require the moonraker api key in KlipperScreen.conf

If you wish to use the update manager feature of moonraker for KlipperScreen, add the following block to moonraker.conf:

moonraker.conf

[update_manager KlipperScreen]
type: git_repo
path: ~/KlipperScreen
origin: https://github.com/KlipperScreen/KlipperScreen.git
virtualenv: ~/.KlipperScreen-env
requirements: scripts/KlipperScreen-requirements.txt
system_dependencies: scripts/system-dependencies.json
managed_services: KlipperScreen

Tip

If you see warnings in other UIs ignore them until KlipperScreen finishes installing, and Moonraker is restarted.

Printer Configuration

Some basic configuration needs to be applied for correct functionality.

printer.cfg

[virtual_sdcard]
path: ~/printer_data/gcodes
[display_status]
[pause_resume]

Macros

You may need some macros for the printer to function as you expected, read more in the macros page