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

The installation script is meant for RaspberryOS Lite, but it should work on other debian derivatives.

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

Execute the following commands:

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

This script will install the necessary packages, 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.

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

Or add the moonraker api key to 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