klipper/docs
Dmitry Butyugin 72b301a285 scripts: Added shaper tuning parameters to calibrate_shaper script
The added parameters include square_corner_velocity, shaper frequencies
to optimize, input shapers to test, input shaper damping ratio and
damping ratios to test. All these options can be useful for fine-tuning
the input shapers when the default suggestions generated by the tuning
script are not optimal.

Also the `SHAPER_CALIBRATE` command was modified to pass some of these
parameters to the shaper tuning routine. Specifically, square corner
velocity and the maximum tested frequency are used to adjust shaper
tuning and maximum acceleration recommendations.

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2024-02-16 19:20:56 -05:00
..
_klipper3d docs: Update to mkdocs to use latest jinj2 version 2024-01-18 13:36:17 -05:00
img bed_mesh: Implement adaptive bed mesh (#6461) 2024-01-26 17:50:01 -05:00
prints docs: Suggested improvements to Input Shaper tuning guide 2020-07-29 21:28:18 -04:00
API_Server.md docs: Add link to Moonraker in API_Server.md 2022-04-09 19:32:38 -04:00
Axis_Twist_Compensation.md axis_twist_compensation: Add X twist compensation module (#6149) 2023-08-01 13:08:53 -04:00
BLTouch.md docs: Docs comma culture (#4822) 2022-01-09 21:13:53 -05:00
Beaglebone.md docs: Rename Documents 2021-11-22 21:03:32 -05:00
Bed_Level.md docs: Clarify the Thickness of Paper 2021-12-27 12:24:58 -05:00
Bed_Mesh.md docs: update BED_MESH_OFFSET description 2024-02-15 12:03:41 -05:00
Benchmarks.md ar100: Support for ar100 (#6054) 2023-02-20 20:15:01 -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: Add new CANBUS_Troubleshooting.md document 2023-05-30 20:16:28 -04:00
CANBUS_Troubleshooting.md parsecandump: New utility to parse Klipper messages in a candump capture 2023-05-30 20:18:41 -04:00
CANBUS_protocol.md docs: Updates to CANBUS_protocol.md 2022-07-29 11:40:54 -04:00
CNAME docs: Fixup github pages 2019-04-14 22:41:23 -04:00
CONTRIBUTING.md docs: Update reviewers in CONTRIBUTING.md 2023-03-15 14:55:51 -04:00
Code_Overview.md toolhead: Rename MoveQueue class to LookAheadQueue 2024-01-18 12:16:47 -05:00
Command_Templates.md docs: fix rawparams example by truncating comments 2022-07-19 12:48:16 -04:00
Config_Changes.md docs: Note removal of deprecated options in Config_Changes.md 2024-02-15 12:40:10 -05:00
Config_Reference.md bed_mesh: Remove deprecated relative_reference_index 2024-02-15 12:39:01 -05:00
Config_checks.md Config_checks: Missing ! in pin inversion example in Verify endstops 2023-10-19 13:13:57 -04:00
Contact.md docs: Update Contact.md to note other common ways to obtain Klipper log file 2023-11-01 19:04:13 -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
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 Features.md 2023-11-10 18:35:59 -05:00
G-Codes.md extruder: Remove deprecated commands and config 2024-02-15 12:35:19 -05:00
Hall_Filament_Width_Sensor.md docs: Fix typos (#6032) 2023-02-20 11:06:25 -05:00
Installation.md doc: updates to Installation.md (#6398) 2023-12-03 21:10:59 -05:00
Kinematics.md docs: Use hash marks for header lines 2021-07-27 13:29:36 -04:00
MCU_Commands.md docs: Update MCU_Commands.md with new config_stepper command 2021-11-04 12:06:27 -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
Measuring_Resonances.md scripts: Added shaper tuning parameters to calibrate_shaper script 2024-02-16 19:20:56 -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
Overview.md docs: add info about requesting bootloaders 2023-10-12 20:53:31 -04:00
Packaging.md docs: Fix typos (#6032) 2023-02-20 11:06:25 -05:00
Pressure_Advance.md docs : make modifications to all md files to make them compatible with mkdocs 2021-07-27 13:15:25 -04: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
RPi_microcontroller.md docs: fix typo in RPi_microcontroller.md 2023-09-29 13:58:29 -04:00
Releases.md docs: Note the release of v0.12.0 2023-11-10 18:36:19 -05:00
Resonance_Compensation.md idex_modes: COPY and MIRROR mode implementation (#6297) 2023-08-01 12:23:52 -04:00
Rotation_Distance.md docs: Docs comma culture (#4822) 2022-01-09 21:13:53 -05: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: Add Peopoly to Sponsors.md 2023-09-26 16:51:38 -04:00
Status_Reference.md pwm_cycle_time: New module for output pins with dynamic cycle times 2024-01-23 20:04:03 -05:00
TMC_Drivers.md tmc: Fix s2vs field formatters 2023-03-07 10:52:52 -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
developer-certificate-of-origin docs: Add a CONTRIBUTING document 2017-12-24 12:33:01 -05:00
index.md docs: Add a Sponsors.md file 2022-07-16 10:48:10 -04:00

README.md

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