klipper/docs
Dmitry Butyugin cc6736c3e3
kinematics: Generic Cartesian kinematics implementation (#6815)
* tests: Added a regression test for generic_cartesian kinematics

* kinematics: An intial implementation of generic_cartesian kinematics

* generic_cartesian: Refactored kinematics configuration API

* generic_cartesian: Use stepper instead of kinematic_stepper in configs

* generic_cartesian: Added SET_STEPPER_KINEMATICS command

* generic_cartesian: Fixed parsing of section names

* docs: Generic Caretsian kinematics documentation and config samples

* generic_cartesian: Implemented multi-mcu homing validation

* generic_cartesian: Fixed typos in docs, minor fixes

* generic_cartesian: Renamed `kinematics` option to `carriages`

* generic_cartesian: Moved kinematic_stepper.py file

* idex_modes: Internal refactoring of handling dual carriages

* stepper: Refactored the code to not store a reference to config object

* config: Updated example-generic-cartesian config

* generic_cartesian: Restricted SET_STEPPER_CARRIAGES and exported status

* idex_modes: Fixed handling stepper kinematics with input shaper enabled

* config: Updated configs and tests for SET_DUAL_CARRIAGE new params

* generic_cartesian: Avoid inheritance in the added classes

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2025-05-06 18:06:36 -04:00
..
_klipper3d mkdocs-requirements: Update to Jinja 3.1.6 2025-04-03 13:47:00 -04:00
img docs: Update config screenshot for rpi235x (#6748) 2024-11-27 18:31:01 -05:00
prints docs: Suggested improvements to Input Shaper tuning guide 2020-07-29 21:28:18 -04:00
API_Server.md load_cell: Load cell gram scale (#6729) 2025-03-20 19:53:44 -04:00
Axis_Twist_Compensation.md axis_twist_compensation: Remove the auto parameter 2025-03-08 22:23:35 -05:00
Beaglebone.md pru: BeagleBone Firmware upgrade to Debian 11.7 Bullseye (#6577) 2024-04-27 11:01:57 -04:00
Bed_Level.md docs: Clarify the Thickness of Paper 2021-12-27 12:24:58 -05:00
Bed_Mesh.md docs: update Manual_Level.md reference 2024-11-19 17:15:43 -05:00
Benchmarks.md docs: Update stm32h723 benchmarks now that it runs at 520Mhz 2025-05-02 12:06:59 -04:00
BLTouch.md docs: Docs comma culture (#4822) 2022-01-09 21:13:53 -05:00
Bootloader_Entry.md docs: Fix a typo in serial bootloader entry docs 2023-10-19 13:10:05 -04:00
Bootloaders.md config: Add 1LC example configuration and docs 2023-08-13 15:32:27 -04:00
CANBUS.md docs: Note functioning canbus required even in bridge mode in CANBUS.md 2025-04-29 13:02:34 -04:00
CANBUS_protocol.md docs: Updates to CANBUS_protocol.md 2022-07-29 11:40:54 -04:00
CANBUS_Troubleshooting.md docs: Note canbus_query.py limitations in CANBUS_Troubleshooting.md 2025-04-29 13:52:57 -04:00
CNAME docs: Fixup github pages 2019-04-14 22:41:23 -04:00
Code_Overview.md force_move: Implement CLEAR for SET_KINEMATIC_POSITION (#6262) 2025-01-10 10:41:09 -05:00
Command_Templates.md docs: fix rawparams example by truncating comments 2022-07-19 12:48:16 -04:00
Config_Changes.md docs: Update date of cycle_time change in Config_Changes.md 2025-04-28 19:36:12 -04:00
Config_checks.md Config_checks: Missing ! in pin inversion example in Verify endstops 2023-10-19 13:13:57 -04:00
Config_Reference.md kinematics: Generic Cartesian kinematics implementation (#6815) 2025-05-06 18:06:36 -04:00
Contact.md docs: Add a "Professional Services" link to Contacts page 2025-01-21 18:54:33 -05:00
CONTRIBUTING.md docs: Update reviewers in CONTRIBUTING.md 2023-03-15 14:55:51 -04:00
Debugging.md docs: Fix typos (#6032) 2023-02-20 11:06:25 -05:00
Delta_Calibrate.md docs: Note to run DELTA_CALIBRATE before DELTA_ANALYZE in Delta_Calibrate.md 2022-04-29 13:58:05 -04:00
developer-certificate-of-origin docs: Add a CONTRIBUTING document 2017-12-24 12:33:01 -05:00
Eddy_Probe.md docs: update temperature_probe documentation 2024-09-01 13:37:35 -04:00
Endstop_Phase.md docs : make modifications to all md files to make them compatible with mkdocs 2021-07-27 13:15:25 -04:00
Example_Configs.md docs: Update Example_Configs.md to note that baud should be 250000 2022-04-30 14:51:14 -04:00
Exclude_Object.md docs: fix typo in Exclude_Object.md 2022-06-03 18:11:35 -04:00
FAQ.md docs: Add a Sponsors.md file 2022-07-16 10:48:10 -04:00
Features.md docs: Update stm32h723 benchmarks now that it runs at 520Mhz 2025-05-02 12:06:59 -04:00
G-Codes.md kinematics: Generic Cartesian kinematics implementation (#6815) 2025-05-06 18:06:36 -04:00
Hall_Filament_Width_Sensor.md docs: Fix typos (#6032) 2023-02-20 11:06:25 -05:00
index.md docs: Improve wording of main Klipper page 2025-01-21 18:54:00 -05:00
Installation.md docs: Fix typos in installation.md 2025-03-31 11:28:04 -04:00
Kinematics.md toolhead: Replace max_accel_to_decel with minimum_cruise_ratio 2024-03-13 21:31:37 -04:00
Load_Cell.md load_cell: Load cell gram scale (#6729) 2025-03-20 19:53:44 -04:00
Manual_Level.md docs: Note that "minutes" in screws_tilt_adjust means minutes of a clock face 2022-04-05 20:35:56 -04:00
MCU_Commands.md docs: Update MCU_Commands.md with new config_stepper command 2021-11-04 12:06:27 -04:00
Measuring_Resonances.md icm20948: Add support for ICM20948 accelerometer (#6756) 2025-03-04 17:12:26 -05:00
Multi_MCU_Homing.md docs: Update Multi_MCU_Homing.md to note the importance of low-latency 2024-01-16 14:19:11 -05:00
OctoPrint.md docs: Update OctoPrint.md - wrong serial address (#6716) 2024-10-22 10:36:13 -04:00
Overview.md load_cell: Load cell gram scale (#6729) 2025-03-20 19:53:44 -04:00
Packaging.md docs: Fix typos (#6032) 2023-02-20 11:06:25 -05:00
Pressure_Advance.md docs: Update Pressure_Advance.md (#6808) 2025-02-04 19:08:05 -05:00
Probe_Calibrate.md docs: Fix typo in Probe_Calibrate.md 2024-02-09 19:21:34 -05:00
Protocol.md docs : make modifications to all md files to make them compatible with mkdocs 2021-07-27 13:15:25 -04:00
README.md docs: Improve documentation for those starting in docs/ 2017-04-27 16:05:26 -04:00
Releases.md docs: Note the release of v0.13.0 2025-04-11 21:07:28 -04:00
Resonance_Compensation.md docs: Fix typo in Resonance_Compensation.md 2024-04-12 12:17:35 -04:00
Rotation_Distance.md docs: Docs comma culture (#4822) 2022-01-09 21:13:53 -05:00
RPi_microcontroller.md docs: fix typo in RPi_microcontroller.md 2023-09-29 13:58:29 -04:00
SDCard_Updates.md docs: Update the Contact document 2023-11-01 19:04:13 -04:00
Skew_Correction.md docs: Fix typo in Skew_Correction.md 2024-02-15 12:29:13 -05:00
Slicers.md docs: Add missing code block indicators to Slicers.md(#6161) 2023-04-11 11:39:41 -04:00
Sponsors.md docs: Update Sponsors.md 2024-10-26 22:02:20 -04:00
Status_Reference.md kinematics: Generic Cartesian kinematics implementation (#6815) 2025-05-06 18:06:36 -04:00
TMC_Drivers.md docs: Note stealthchop_threshold doesn't impact sensorless homing 2025-02-15 13:55:19 -05:00
TSL1401CL_Filament_Width_Sensor.md docs: Reorganize layout of G-Codes.md 2022-02-01 11:59:55 -05:00
Using_PWM_Tools.md pwm_tool: Add support for high-speed PWM pin updates 2023-11-16 22:07:15 -05:00

Welcome to the Klipper documentation. The overview document is a good starting point.