2017-04-27 21:31:48 +02:00
|
|
|
Welcome to the Klipper documentation. There are two parts to Klipper -
|
|
|
|
|
code that runs on a micro-controller and code that runs on a "host"
|
|
|
|
|
machine. The host code is intended to run on a low-cost
|
|
|
|
|
general-purpose machine such as a Raspberry Pi, while the
|
|
|
|
|
micro-controller code is intended to run on commodity micro-controller
|
|
|
|
|
chips. Read [features](Features.md) for reasons to use Klipper. See
|
2017-12-27 02:16:53 +01:00
|
|
|
[installation](Installation.md) to get started with Klipper. See
|
|
|
|
|
[config checks](Config_checks.md) for a guide to verify basic pin
|
|
|
|
|
settings in the config file.
|
2017-04-19 21:24:57 +02:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
The Klipper configuration is stored in a simple text file on the host
|
2019-04-15 03:12:21 +02:00
|
|
|
machine. The
|
|
|
|
|
[config/example.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/example.cfg)
|
|
|
|
|
file serves as a reference for the config file. See the
|
|
|
|
|
[Slicers](Slicers.md) document for information on configuring a slicer
|
|
|
|
|
with Klipper. See the [Bed Level](Bed_Level.md),
|
|
|
|
|
[Endstop Phase](Endstop_Phase.md),
|
2019-02-17 04:19:34 +01:00
|
|
|
[Probe Calibrate](Probe_Calibrate.md),
|
|
|
|
|
[Delta Calibrate](Delta_Calibrate.md), and
|
|
|
|
|
[Manual Level](Manual_Level.md) documents for information on bed
|
|
|
|
|
leveling with Klipper. The [Pressure Advance](Pressure_Advance.md)
|
|
|
|
|
document contains information on tuning the pressure advance config.
|
2016-05-25 17:37:40 +02:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
The [kinematics](Kinematics.md) document provides some technical
|
2017-11-30 21:00:00 +01:00
|
|
|
details on how Klipper implements motion. The [FAQ](FAQ.md) answers
|
2018-03-08 20:06:24 +01:00
|
|
|
some common questions. The [G-Codes](G-Codes.md) document lists
|
|
|
|
|
currently supported run-time commands.
|
2017-04-27 21:31:48 +02:00
|
|
|
|
|
|
|
|
The history of Klipper releases is available at
|
2018-12-28 00:57:17 +01:00
|
|
|
[releases](Releases.md). The [config changes](Config_Changes.md)
|
|
|
|
|
document describes recent software changes that may require users to
|
|
|
|
|
update their printer config file. See [contact](Contact.md) for
|
|
|
|
|
information on bug reporting and general communication with the
|
|
|
|
|
developers.
|
2016-05-25 17:37:40 +02:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
Developer Documentation
|
|
|
|
|
=======================
|
|
|
|
|
|
|
|
|
|
There are also several documents available for developers interested
|
|
|
|
|
in understanding how Klipper works. Start with the
|
|
|
|
|
[code overview](Code_Overview.md) document - it provides information
|
2017-12-27 02:16:53 +01:00
|
|
|
on the structure and layout of the Klipper code. See the
|
|
|
|
|
[contributing](CONTRIBUTING.md) document to submit improvements to Klipper.
|
2016-12-24 00:28:09 +01:00
|
|
|
|
2017-04-27 21:31:48 +02:00
|
|
|
See [protocol](Protocol.md) for information on the low-level messaging
|
|
|
|
|
protocol between host and micro-controller. See also
|
2017-04-27 21:14:11 +02:00
|
|
|
[MCU commands](MCU_Commands.md) for a description of low-level
|
|
|
|
|
commands implemented in the micro-controller software.
|
2016-10-15 07:03:56 +02:00
|
|
|
|
2016-12-24 00:28:09 +01:00
|
|
|
See [debugging](Debugging.md) for information on how to test and debug
|
2019-03-28 14:47:10 +01:00
|
|
|
Klipper. See [benchmarks](Benchmarks.md) for information on
|
|
|
|
|
benchmarking. See [stm32f1](stm32f1.md) for information on the STM32F1
|
2018-09-21 02:11:04 +02:00
|
|
|
micro-controller port. See [bootloaders](Bootloaders.md) for developer
|
|
|
|
|
information on micro-controller flashing.
|
