klipper README

The project's README from github.com/Klipper3d/klipper. As one markdown file: README.md.

Welcome to the Klipper project!

Klipper

https://www.klipper3d.org/

The Klipper firmware controls 3d-Printers. It combines the power of a general purpose computer with one or more micro-controllers. See the features document for more information on why you should use the Klipper software.

Start by installing Klipper software.

Klipper software is Free Software. See the license or read the documentation. We depend on the generous support from our sponsors.

klipper (Klipper3d/klipper)

Searching Database…

What is this?Klipper is firmware that controls 3D printers by combining a general-purpose computer (like a Raspberry Pi) with one or more micro-controllers on the printer board.
Does it run entirely on the printer's control board, or does it need a separate computer too?It splits the job: the host computer handles the heavy motion-planning math while lightweight firmware on the printer's micro-controller(s) executes the actual stepper and heater commands, with the two communicating together.
How do I get Klipper running on my printer?You start by installing the Klipper software, which involves flashing the micro-controller firmware and setting up the 'klippy' host software on the companion computer.
What hardware do I need besides the printer's own control board?You need a general-purpose computer running the host software; a Raspberry Pi is the most common choice, paired with the printer's existing micro-controller board.
Is this a drop-in replacement, or does switching firmware take real setup work?Moving to Klipper means flashing new firmware onto the micro-controller and running a separate host process on a computer, so it's a more involved swap than just updating stock firmware.
Do I specifically need a Raspberry Pi, or will any computer work?Any general-purpose computer can act as the host; Raspberry Pi is the commonly used option but the project only specifies 'a general purpose computer'.
Why should I use Klipper instead of my printer's built-in firmware?Klipper offloads the complex motion math to a full computer instead of a limited printer microcontroller, which the project says enables better print quality — see its features document for the full rationale.
What are the two main pieces that make up Klipper?Klipper is split into micro-controller firmware that runs on the printer board and a host-side program ('klippy') that runs on the general-purpose computer, working together to drive the printer.
Creator
Klipper3d
Size
250 MB
Stars
12K
Updated
CommitOct 13
Age
10y
Commits · 90 Days