Skip to content

# Overview

Welcome to the Klipper documentation. If new to Klipper, start with the features and installation documents.

## Overview information

- Features: A high-level list of features in Klipper.
- FAQ: Frequently asked questions.
- Releases: The history of Klipper releases.
- Config changes: Recent software changes that may require users to update their printer config file.
- Contact: Information on bug reporting and general communication with the Klipper developers.

## Installation and Configuration

- Installation: Guide to installing Klipper.
- Config Reference: Description of config parameters.
  - Rotation Distance: Calculating the rotation_distance stepper parameter.
- Config checks: Verify basic pin settings in the config file.
- Bed level: Information on "bed leveling" in Klipper.
  - Delta calibrate: Calibration of delta kinematics.
  - Probe calibrate: Calibration of automatic Z probes.
  - BL-Touch: Configure a "BL-Touch" Z probe.
  - Manual level: Calibration of Z endstops (and similar).
  - Bed Mesh: Bed height correction based on XY locations.
  - Endstop phase: Stepper assisted Z endstop positioning.
- Resonance compensation: A tool to reduce ringing in prints.
  - Measuring resonances: Information on using adxl345 accelerometer hardware to measure resonance.
- Pressure advance: Calibrate extruder pressure.
- G-Codes: Information on commands supported by Klipper.
- Command Templates: G-Code macros and conditional evaluation.
  - Status Reference: Information available to macros (and similar).
- TMC Drivers: Using Trinamic stepper motor drivers with Klipper.
- Multi-MCU Homing: Homing and probing using multiple micro-controllers.
- Slicers: Configure "slicer" software for Klipper.
- Skew correction: Adjustments for axes not perfectly square.
- PWM tools: Guide on how to use PWM controlled tools such as lasers or spindles.
- Exclude Object: The guide to the Exclude Objecs implementation.

## Developer Documentation

- Code overview: Developers should read this first.
- Kinematics: Technical details on how Klipper implements motion.
- Protocol: Information on the low-level messaging protocol between host and micro-controller.
- API Server: Information on Klipper's command and control API.
- MCU commands: A description of low-level commands implemented in the micro-controller software.
- CAN bus protocol: Klipper CAN bus message format.
- Debugging: Information on how to test and debug Klipper.
- Benchmarks: Information on the Klipper benchmark method.
- Contributing: Information on how to submit improvements to Klipper.
- Packaging: Information on building OS packages.

## Device Specific Documents

- Example configs: Information on adding an example config file to Klipper.
- SDCard Updates: Flash a micro-controller by copying a binary to an sdcard in the micro-controller.
- Raspberry Pi as Micro-controller: Details for controlling devices wired to the GPIO pins of a Raspberry Pi.
- Beaglebone: Details for running Klipper on the Beaglebone PRU.
- Bootloaders: Developer information on micro-controller flashing.
- CAN bus: Information on using CAN bus with Klipper.
- TSL1401CL filament width sensor
- Hall filament width sensor

Back to top