2021-07-22 00:40:40 +02:00
|
|
|
# Overview
|
|
|
|
|
|
2019-04-17 02:39:41 +02:00
|
|
|
Welcome to the Klipper documentation. If new to Klipper, start with
|
|
|
|
|
the [features](Features.md) and [installation](Installation.md)
|
|
|
|
|
documents.
|
|
|
|
|
|
2021-07-22 00:40:40 +02:00
|
|
|
## Overview information
|
2019-04-17 02:39:41 +02:00
|
|
|
|
|
|
|
|
- [Features](Features.md): A high-level list of features in Klipper.
|
|
|
|
|
- [FAQ](FAQ.md): Frequently asked questions.
|
|
|
|
|
- [Releases](Releases.md): The history of Klipper releases.
|
|
|
|
|
- [Config changes](Config_Changes.md): Recent software changes that
|
|
|
|
|
may require users to update their printer config file.
|
|
|
|
|
- [Contact](Contact.md): Information on bug reporting and general
|
|
|
|
|
communication with the Klipper developers.
|
|
|
|
|
|
2021-08-18 01:39:23 +02:00
|
|
|
## Installation and Configuration
|
2019-04-17 02:39:41 +02:00
|
|
|
|
|
|
|
|
- [Installation](Installation.md): Guide to installing Klipper.
|
2020-11-17 00:47:32 +01:00
|
|
|
- [Config Reference](Config_Reference.md): Description of config
|
|
|
|
|
parameters.
|
2020-12-14 04:20:52 +01:00
|
|
|
- [Rotation Distance](Rotation_Distance.md): Calculating the
|
|
|
|
|
rotation_distance stepper parameter.
|
2019-04-17 02:39:41 +02:00
|
|
|
- [Config checks](Config_checks.md): Verify basic pin settings in the
|
|
|
|
|
config file.
|
|
|
|
|
- [Bed level](Bed_Level.md): Information on "bed leveling" in Klipper.
|
|
|
|
|
- [Delta calibrate](Delta_Calibrate.md): Calibration of delta
|
|
|
|
|
kinematics.
|
|
|
|
|
- [Probe calibrate](Probe_Calibrate.md): Calibration of automatic Z
|
|
|
|
|
probes.
|
|
|
|
|
- [BL-Touch](BLTouch.md): Configure a "BL-Touch" Z probe.
|
|
|
|
|
- [Manual level](Manual_Level.md): Calibration of Z endstops (and
|
|
|
|
|
similar).
|
2021-01-24 16:47:15 +01:00
|
|
|
- [Bed Mesh](Bed_Mesh.md): Bed height correction based on XY
|
|
|
|
|
locations.
|
2019-04-17 02:39:41 +02:00
|
|
|
- [Endstop phase](Endstop_Phase.md): Stepper assisted Z endstop
|
|
|
|
|
positioning.
|
2020-08-06 05:28:54 +02:00
|
|
|
- [Resonance compensation](Resonance_Compensation.md): A tool to
|
|
|
|
|
reduce ringing in prints.
|
2020-10-17 03:32:33 +02:00
|
|
|
- [Measuring resonances](Measuring_Resonances.md): Information on
|
|
|
|
|
using adxl345 accelerometer hardware to measure resonance.
|
2019-04-17 02:39:41 +02:00
|
|
|
- [Pressure advance](Pressure_Advance.md): Calibrate extruder
|
|
|
|
|
pressure.
|
2021-06-04 05:24:44 +02:00
|
|
|
- [G-Codes](G-Codes.md): Information on commands supported by Klipper.
|
2019-05-28 21:16:50 +02:00
|
|
|
- [Command Templates](Command_Templates.md): G-Code macros and
|
|
|
|
|
conditional evaluation.
|
2021-04-29 02:16:13 +02:00
|
|
|
- [Status Reference](Status_Reference.md): Information available to
|
|
|
|
|
macros (and similar).
|
2021-03-10 20:14:11 +01:00
|
|
|
- [TMC Drivers](TMC_Drivers.md): Using Trinamic stepper motor drivers
|
|
|
|
|
with Klipper.
|
2021-06-04 05:24:44 +02:00
|
|
|
- [Multi-MCU Homing](Multi_MCU_Homing.md): Homing and probing using multiple micro-controllers.
|
|
|
|
|
- [Slicers](Slicers.md): Configure "slicer" software for Klipper.
|
2021-11-21 08:23:56 +01:00
|
|
|
- [Skew correction](Skew_Correction.md): Adjustments for axes not
|
2019-06-27 15:50:17 +02:00
|
|
|
perfectly square.
|
2021-03-26 16:25:09 +01:00
|
|
|
- [PWM tools](Using_PWM_Tools.md): Guide on how to use PWM controlled
|
|
|
|
|
tools such as lasers or spindles.
|
2019-04-17 02:39:41 +02:00
|
|
|
|
2021-07-22 00:40:40 +02:00
|
|
|
## Developer Documentation
|
2019-04-17 02:39:41 +02:00
|
|
|
|
|
|
|
|
- [Code overview](Code_Overview.md): Developers should read this
|
|
|
|
|
first.
|
|
|
|
|
- [Kinematics](Kinematics.md): Technical details on how Klipper
|
|
|
|
|
implements motion.
|
|
|
|
|
- [Protocol](Protocol.md): Information on the low-level messaging
|
|
|
|
|
protocol between host and micro-controller.
|
2020-10-15 03:13:47 +02:00
|
|
|
- [API Server](API_Server.md): Information on Klipper's command and
|
|
|
|
|
control API.
|
2019-04-17 02:39:41 +02:00
|
|
|
- [MCU commands](MCU_Commands.md): A description of low-level commands
|
|
|
|
|
implemented in the micro-controller software.
|
2021-02-07 21:23:19 +01:00
|
|
|
- [CAN bus protocol](CANBUS_protocol.md): Klipper CAN bus message
|
|
|
|
|
format.
|
2019-04-17 02:39:41 +02:00
|
|
|
- [Debugging](Debugging.md): Information on how to test and debug
|
|
|
|
|
Klipper.
|
|
|
|
|
- [Benchmarks](Benchmarks.md): Information on the Klipper benchmark
|
|
|
|
|
method.
|
|
|
|
|
- [Contributing](CONTRIBUTING.md): Information on how to submit
|
|
|
|
|
improvements to Klipper.
|
|
|
|
|
- [Packaging](Packaging.md): Information on building OS packages.
|
|
|
|
|
|
2021-07-22 00:40:40 +02:00
|
|
|
## Device Specific Documents
|
2019-04-17 02:39:41 +02:00
|
|
|
|
2021-03-23 03:12:26 +01:00
|
|
|
- [Example configs](Example_Configs.md): Information on adding an
|
|
|
|
|
example config file to Klipper.
|
2021-02-10 19:00:19 +01:00
|
|
|
- [SDCard Updates](SDCard_Updates.md): Flash a micro-controller by
|
|
|
|
|
copying a binary to an sdcard in the micro-controller.
|
2020-08-01 19:09:09 +02:00
|
|
|
- [Raspberry Pi as Micro-controller](RPi_microcontroller.md): Details
|
|
|
|
|
for controlling devices wired to the GPIO pins of a Raspberry Pi.
|
2021-11-21 08:23:56 +01:00
|
|
|
- [Beaglebone](Beaglebone.md): Details for running Klipper on the
|
2019-04-17 02:39:41 +02:00
|
|
|
Beaglebone PRU.
|
2020-08-01 19:09:09 +02:00
|
|
|
- [Bootloaders](Bootloaders.md): Developer information on
|
|
|
|
|
micro-controller flashing.
|
2021-03-04 18:51:13 +01:00
|
|
|
- [CAN bus](CANBUS.md): Information on using CAN bus with Klipper.
|
2019-04-17 02:39:41 +02:00
|
|
|
- [TSL1401CL filament width sensor](TSL1401CL_Filament_Width_Sensor.md)
|
2021-11-21 08:23:56 +01:00
|
|
|
- [Hall filament width sensor](Hall_Filament_Width_Sensor.md)
|
