aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Update Installation.md - Flash loop protection (#6935)JamesH19782025-05-191-0/+19
| | | | | Added a paragraph about flash loop protection on some motherboards. It has been noted that not all people know about the need to change the bin filename on some stock boards or other methods that may hinder progress. Signed-off-by: James Hartley <james@hartleyns.com>
* docs: Fix index.md linksKevin O'Connor2025-05-161-7/+5
| | | | | | | Use relative links in index.md and correct the location of the COPYING file. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: BED_MESH_CALIBRATE makes a mesh that is immediately available. (#6919)Rowland2025-05-142-2/+9
| | | | | The docs aren't particularly clear that if you generate a mesh in our start g-code, you can just use it without additional commands. This is causing issues with support on r/klippers Signed-off-by: Rowland Straylight <rowlandstraylight@gmail.com>
* manual_stepper: Support LIMIT_VELOCITY and LIMIT_ACCEL when using gcode axisKevin O'Connor2025-05-121-0/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* manual_stepper: Support position_min and position_max optionsKevin O'Connor2025-05-121-0/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* manual_stepper: Support INSTANTANEOUS_CORNER_VELOCITY on gcode axesKevin O'Connor2025-05-121-11/+14
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* manual_stepper: Support registering as an additional axisKevin O'Connor2025-05-121-0/+12
| | | | | | | Add a new G-Code command that can register a manual_stepper as an additional axis on standard G-Code G1 commands. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* kinematics: Generic Cartesian kinematics implementation (#6815)Dmitry Butyugin2025-05-063-14/+286
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | * 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>
* docs: Update stm32h723 benchmarks now that it runs at 520MhzKevin O'Connor2025-05-022-8/+8
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note canbus_query.py limitations in CANBUS_Troubleshooting.mdKevin O'Connor2025-04-291-0/+17
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note functioning canbus required even in bridge mode in CANBUS.mdKevin O'Connor2025-04-291-0/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update date of cycle_time change in Config_Changes.mdKevin O'Connor2025-04-281-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mcu: Decrease mcu.max_nominal_duration() to 3 seconds from 5Kevin O'Connor2025-04-281-0/+5
| | | | | | This allows the mcu to utilize faster internal speeds. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update benchmarks for stm32h7Kevin O'Connor2025-04-192-11/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* manual_stepper: Implement "drip moves" for manual stepper STOP_ON_ENDSTOPKevin O'Connor2025-04-181-0/+5
| | | | | | | | | | | | | Currently, `MANUAL_STEPPER STOP_ON_ENDSTOP=1` type commands will move until hitting the endstop, but it will still always consume the total amount of move time. That is, following moves can't be started until the total possible time of the homing move is completed. Implement "drip moves" so that the code only schedules the movement in small segments. This allows following movements to be scheduled without a significant delay. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Config_Changes.md to note software spi is now rate limitedKevin O'Connor2025-04-171-0/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* hall_filament_width_sensor: Add filament switch values to statusRussell Cloran2025-04-171-0/+2
| | | | | | | | | | | | | | | | | | | | | | | | | | | `hall_filament_width_sensor` contains a runout sensor object internally. This exposes those values in the API status result. ``` SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","filament_detected","is_active","Diameter","Raw"]}}} GOT: b'{"id":123,"result":{"eventtime":199567.823596603,"status":{"hall_filament_width_sensor":{"enabled":true,"filament_detected":true,"is_active":true,"Diameter":1.9499999999999986,"Raw":6113}}}}' ``` The duplication of `is_active` and `enabled` seems confusing, but both of these can be independently manipulated by GCode: ``` SEND: {"id":123,"method":"gcode/script","params":{"script":"DISABLE_FILAMENT_WIDTH_SENSOR"}} GOT: b'{"id":123,"result":{}}' SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","is_active"]}}} GOT: b'{"id":123,"result":{"eventtime":199770.446013297,"status":{"hall_filament_width_sensor":{"enabled":true,"is_active":false}}}}' SEND: {"id":123,"method":"gcode/script","params":{"script":"SET_FILAMENT_SENSOR SENSOR=hall_filament_width_sensor ENABLE=0"}} GOT: b'{"id":123,"result":{}}' SEND: {"id":123,"method":"objects/query","params":{"objects":{"hall_filament_width_sensor":["enabled","is_active"]}}} GOT: b'{"id":123,"result":{"eventtime":199847.927726196,"status":{"hall_filament_width_sensor":{"enabled":false,"is_active":false}}}}' ``` Signed-off-by: Russell Cloran <rcloran@gmail.com>
* tmc: add missing freewheel config optionsTimofey Titovets2025-04-171-0/+3
| | | | Signed-off-by: Timofey Titovets <nefelim4ag@gmail.com>
* docs: Note the release of v0.13.0Kevin O'Connor2025-04-111-0/+29
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Features.md to reflect recent workKevin O'Connor2025-04-111-5/+8
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* force_move: Support a SET_HOMED parameter to SET_KINEMATIC_POSITIONKevin O'Connor2025-04-081-11/+44
| | | | | | | | | | | | | | | Commit 70838797 added support for clearing the homing state in SET_KINEMATIC_POSITION commands. However, it can be difficult to use that support as the default for SET_KINEMATIC_POSITION is to set all axes as homed. Add a new SET_HOMED parameter to allow one to explicitly request which axes to consider in a homed state. Also introduce a CLEAR_HOMED parameter and prefer that to the existing CLEAR parameter. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fixup G-Codes.md so that sections are sorted alphabeticallyKevin O'Connor2025-04-071-127/+126
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add icm20948 descriptionMRX80242025-04-031-0/+19
| | | | Signed-off-by: Maksim Bolgov maksim8024@gmail.com
* mkdocs-requirements: Update to Jinja 3.1.6Kevin O'Connor2025-04-031-1/+1
| | | | | | | | A security vulnerability was found in Jinja 3.1.5 . The software is not impacted by this vulnerability, but there is no harm in updating to the fixed version. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix link syntax typo for bed_screwsRussell Cloran2025-04-011-1/+1
| | | | Signed-off-by: Russell Cloran <rcloran@gmail.com>
* docs: Fix typo in docs generation documentationRussell Cloran2025-04-011-2/+2
| | | | Signed-off-by: Russell Cloran <rcloran@gmail.com>
* docs: Fix typos in installation.mdTobias Rumiz2025-03-311-21/+21
| | | | | Fixed typos, hyphenation, and minor phrasing for better readability. Signed-off-by: Tobias Rumiz <TobiasRumiz@gmail.com>
* ldc_1612: Supports configurable external crystal frequency (#6734)XiaoK2025-03-291-0/+3
| | | | | | | You can use the 40Mhz crystal oscillator recommended by TI official manual to get the best performance. refer to: [ldc1612.pdf](https://www.ti.com/cn/lit/ds/symlink/ldc1612.pdf) 7.3.4 Signed-off-by: Xiaokui Zhao <xiaok@zxkxzk.cn>
* buttons: Debounce gcode_button and filament_switch_sensor (#6848)Gareth Farrington2025-03-201-0/+9
| | | | | Add `debounce_delay` config option which sets the debounce time, defaults to 0 Signed-off-by: Gareth Farrington <gareth@waves.ky>
* load_cell: Load cell gram scale (#6729)Gareth Farrington2025-03-207-24/+187
| | | | | | | | | | | | | | * Add gram scale features to load_cell * Convert sensor counts to grams and make this available via unix socket and object status * Basic GCodes for tearing and reading the load cell * Guided Calibration * Diagnostic gcode to check the health of the load cell * Update load_cell Documentation * Add API server load_cell/dump_force endpoint * Update [load_cell] config with calibration fields * Add G-Code commands for working with load cells * Add status reference for load_cell objects Signed-off-by: Gareth Farrington <gareth@waves.ky>
* docs: Note AXIS_TWIST_COMPENSATION_CALIBRATE AUTO removal in Config_Changes.mdKevin O'Connor2025-03-081-0/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* axis_twist_compensation: Remove the auto parameteryochiwarez2025-03-082-16/+1
| | | | | | from axis_twist_compensation Signed-off-by: Jorge Apaza Merma <yochiwarez@gmail.com>
* icm20948: Add support for ICM20948 accelerometer (#6756)Paul Hansel2025-03-041-4/+7
| | | Signed-off-by: Paul Hansel <github@paulhansel.com>
* docs: fix markup in Axis_Twist_Compensation.md (#6827)Thijs Triemstra2025-02-281-12/+12
| | | Signed-off-by: Thijs Triemstra <info@collab.nl>
* skew_correction: Supports retrieving the name of the currently loaded skew ↵GofranChang2025-02-271-0/+6
| | | | | correction … (#6821) Signed-off-by: Zhang Gaofan <zhanggaofan0827@gmail.com>
* docs: Update benchmarks for rp2040Kevin O'Connor2025-02-262-6/+6
| | | | | | Update benchmarks now that the rp2040 runs at 200Mhz. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve suggestions on bytes_invalid in CANBUS_Troubleshooting.mdKevin O'Connor2025-02-151-11/+27
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note stealthchop_threshold doesn't impact sensorless homingKevin O'Connor2025-02-152-8/+16
| | | | | | Reported by @paulfertser. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fixed incorrect spelling in Config_Reference.md (#6819)Nicholas Parry2025-02-151-1/+1
| | | | | changed spelling of single word Signed-off-by: Nicholas Parry <rounded-gully-5r@icloud.com>
* docs: Fix broken link to MainsailOSLexi Beavil2025-02-051-1/+1
| | | | | | The documentation install page has a link to the old mainsail OS site, which is no longer available Signed-off-by: Lexi Beavil <github@aeroniemi.com>
* docs: Update Pressure_Advance.md (#6808)Auxon2025-02-041-1/+1
| | | | | Added language to disable "scarf joint" seams as it messes with the TUNING_TOWER script. Signed-off-by: Roman Simanovich <romsimanovich@gmail.com>
* mkdocs-requirements: Update jinja dependency to 3.1.5Kevin O'Connor2025-02-021-1/+1
| | | | | | | | It appears there was a security vulnerability in Jinja v3.1.4 . The Klipper docs are not impacted by this vulnerability, but it's simple enough to increment the version to avoid warnings. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* save_variables: Check lowercase variable namesPedro Lamas2025-02-022-2/+7
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* canbus_stats: Periodically report canbus interface statisticsKevin O'Connor2025-02-021-0/+21
| | | | | | | | | Add support for a new get_canbus_status command to canserial.c . Add new canbus_stats.py module that will periodically query canbus mcus for connection status information. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* ads1x1x: added support for ADC chip (#6584)Konstantin Koch2025-01-211-0/+44
| | | | | | Added a temperature sensor configuration for ADS1103, ADS1104, ADS1105, ADS1113, ADS1114 and ADS1115 chips that can be used to add Analog to Digital Conversion capability to machines that don't have that on their own. Like Raspberry Pi's or if more analog input pins are needed than the chip provides like for RP2040. Generally they can be used for any analog input, but the typical use case is for temperature measurement. This code also has been written with temperature measurement in mind and not as a general ADC. Signed-off-by: Konstantin Koch <korsarnek@gmail.com> Signed-off-by: Jack Wakefield <jackwakefield@protonmail.com>
* docs: Add a "Professional Services" link to Contacts pageKevin O'Connor2025-01-211-0/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve wording of main Klipper pageKevin O'Connor2025-01-211-8/+11
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc2240: Allow the slope_control field to be configured via printer.cfgKevin O'Connor2025-01-101-0/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* force_move: Implement CLEAR for SET_KINEMATIC_POSITION (#6262)Dennis Marttinen2025-01-102-13/+16
| | | | | | | | `CLEAR` clears the homing status (resets the axis limits) without turning off the motors. This is particularly useful when implementing safe Z homing in `[homing_override]` on printers with multiple independent Z steppers (where `FORCE_MOVE` can't be used). Signed-off-by: Dennis Marttinen <twelho@welho.tech>
* docs: Document the QUAD_GANTRY_LEVEL command in G-Codes.mdKevin O'Connor2024-12-191-0/+15
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 10:47:23 +0000