aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Update to mkdocs to use latest jinj2 versionKevin O'Connor2024-01-181-2/+2
| | | | | | | | There is a jinja2 security advisory on the current Jinja2 version. Klipper is not impacted by this advisory (as it does not run jinja2 on any untrusted data), but there is no harm in updating. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* toolhead: Rename MoveQueue class to LookAheadQueueKevin O'Connor2024-01-181-17/+19
| | | | | | | Rename this class so that is is not confused with the mcu "move queue". Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Multi_MCU_Homing.md to note the importance of low-latencyKevin O'Connor2024-01-161-3/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typo in Bed_Mesh.md (#6450)marbocub2024-01-061-1/+1
| | | | | the meaning and the illustration shows 13x9 mesh however the text was 13x8. Signed-off-by: Mitsunori YOSHIDA <marbocub@gmail.com>
* hall_filament_width_sensor: max filament diameterSami Haahtinen2023-12-172-0/+9
| | | | | | | | | Add support for maximum filament diameter to hall filament width sensor. If the diameter of the filament diameter is larger than the limit, the virtual runout sensor will trigger. The default value is set to maximum flow adjustment threshold to prevent oversized filament from clogging. Signed-off-by: Sami Haahtinen <ressu@ressukka.net>
* pwm_tool: Add support for maximum_mcu_durationKevin O'Connor2023-12-161-0/+1
| | | | | | | Implement the maximum_mcu_duration config parameter along with its associated queue flushing. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: add rp2040 to internal temp sensor list (#6426)Razor2023-12-131-1/+1
| | | Signed-off-by: Levi Szabo <iamrazorshark@gmail.com>
* gcode: expose status with available commandsPedro Lamas2023-12-111-0/+6
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* toolhead: Remove undocumented buffer management config parametersKevin O'Connor2023-12-071-0/+6
| | | | | | | | These internal low-level config parameters were never documented. Going forward, developers may modify them by altering the internal settings in toolhead.py. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve max_accel documentation in Config_Reference.mdKevin O'Connor2023-12-052-7/+18
| | | | | | | | | | Note that the max_accel parameter is the actual acceleration used in most movements. Note that the accel/velocity limits can be changed using the SET_VELOCITY_LIMIT command. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* doc: updates to Installation.md (#6398)Thijs Triemstra2023-12-031-8/+8
| | | | | | | omit rpi device version nrs rpi2 or newer Signed-off-by: Thijs Triemstra <info@collab.nl>
* bmp280: Add support for BMP180 sensor (#6370)vaxxi2023-11-161-3/+3
| | | | | Extends the BMxx80 category with support for the older BMP180 sensor, providing temperature and humidity output. Signed-off-by: VAXXi Popescu <github@vaxxi.net>
* pwm_tool: Add support for high-speed PWM pin updatesKevin O'Connor2023-11-164-11/+25
| | | | | | | | | The output_pin module is only capable of updating an output pin at most once every 100ms. Add a new pwm_tool module that is capable of queuing updates in the micro-controller and thus allowing for much higher update rates. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note the release of v0.12.0Kevin O'Connor2023-11-101-0/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Features.mdKevin O'Connor2023-11-101-11/+13
| | | | | | Note additional features that have been added recently. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Contact.md to note other common ways to obtain Klipper log fileKevin O'Connor2023-11-011-13/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update the Contact documentKevin O'Connor2023-11-012-49/+21
| | | | | | | | | | | | | | | | | | Try to make it more clear that Discord is not Discourse, as the two similarly sounding services are often confused by users unfamiliar with them. The Klipper Discourse and Klipper Discord are available for many topics related to Klipper - reword some sections to make their use more open. Avoid referring to the Klipper github repo in this Contact document as we no longer use Klipper github issues at all. Remove the table of contents as it is largely redundant for the document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Config_checks: Missing ! in pin inversion example in Verify endstopsTom Dunn2023-10-191-1/+1
| | | | | | | | | In the "Verify endstops" section there is an example of adding an exclamation point to the pin definition to invert its logic. I believe the intention in the example is to keep the hardware pull-up ^ and follow it with ! to invert the pin logic, but the ! is missing. Signed-off-by: Tom Dunn <thomas.dunn@gmail.com>
* docs: Fix a typo in serial bootloader entry docsAaron B. Haun2023-10-191-1/+1
| | | | Signed-off-by: Aaron B. Haun <aaron@haun.guru>
* docs: add info about requesting bootloadersAaron B. Haun2023-10-123-0/+127
| | | | Signed-off-by: Aaron B. Haun <aaron@haun.guru>
* docs: fix typo in RPi_microcontroller.mdIkko Eltociear Ashimine2023-09-291-1/+1
| | | | | | additionaly -> additionally Signed-off-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
* idex_modes: Fixed the case when carriages home in the same direction (#6310)Dmitry Butyugin2023-09-292-0/+17
| | | | | | | | | | | | | | | | | | | | | Previous version of the code assumed that dual carriages home away from each other, which is not true on some machines, which have the second dual carriage homing on the first carriage. The new code correctly identifies the relative order of the carriages now. This fixes discrepancies between the documentation and the actual implementation of the carriages kinematic ranges calculation. Notes about dual_carriage homing and proximity checks changes Fixed clearing of homing state after homing in certain modes In case of multi-MCU homing it is possible that the carriage position will end up outside of the allowed motion range due to latencies in data transmission between MCUs. Selecting certain modes after homing could result in home state clearing instead of blocking the motion of the active carriage. This commit fixes this undesired behavior. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* docs: Add Peopoly to Sponsors.mdKevin O'Connor2023-09-262-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc2240: Adding UART interface support to tmc2240 (#6305)FrY Sennberg2023-09-101-1/+4
| | | Signed-off-by: Christoph Frei <fryakatkop@gmail.com>
* docs: Add how to configure LIS2DW instructionsbigtreetech2023-08-212-4/+45
| | | | Signed-off-by: Alan.Ma from BigTreeTech tech@biqu3d.com
* config: Add 1LC example configuration and docsWulfsta2023-08-131-0/+44
| | | | Signed-off-by: Luke Vuksta <wulfstawulfsta@gmail.com>
* docs: Update RPi_microcontroller.md (pwm-2chan) (#6304)FatalBulletHit2023-08-131-8/+26
| | | | | Added a more detailed explanation for pwm-2chan. Signed-off-by: Alfie Batthullt <FatalBulletHit@gmail.com>
* docs: Update Config_Changes.md to reflect new SKR-3 flash-sdcard naming.Donna Whisnant2023-08-111-0/+4
| | | | Signed-off-by: Donna Whisnant <dewhisna@dewtronics.com>
* heaters: adds temperature monitorsPedro Lamas2023-08-011-0/+5
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* temperature_combined: A class that can combine several other temperature ↵Michael Jäger2023-08-012-1/+20
| | | | | sensors (#6230) Signed-off-by: Michael Jäger <michael@mjaeger.eu>
* axis_twist_compensation: Add X twist compensation module (#6149)Philippe Daouadi2023-08-015-0/+93
| | | | | | | | | | | | Implements AxisTwistCompensation, and Calibrater Supports calibration of z-offsets caused by x gantry twist Modify PrinterProbe._probe function to check if the probed z value should be adjusted based on axis_twist_compensation's configuration Add documentation for [axis_twist_compensation] module Signed-off-by: Jeremy Tan <jeremytkw98@gmail.com>
* idex_modes: COPY and MIRROR mode implementation (#6297)Dmitry Butyugin2023-08-015-24/+89
| | | | | | | | | | | COPY and MIRROR mode implementation Correctly apply input shaper params to new dual_carriage Added SAVE_/RESTORE_IDEX_STATE commands Documentation updates for the new IDEX modes Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* screws_tilt_adjust: add max_deviation to report statusStefan Dej2023-08-011-0/+2
| | | | Signed-off-by: Stefan Dej <meteyou@gmail.com>
* docs: Update Config_checks.md (#6278)JamesH19782023-07-301-42/+36
| | | | | I am endeavoring to rewrite some of the docs to be more front end agnostic to reflect the different front ends available since these docs were written. I am starting with this one, as it quite often used. Signed-off-by: James Hartley <james@hartleyns.com>
* docs: Update Config_Reference.md - heater_fan wording (#6273)JamesH19782023-06-281-1/+1
| | | | | The reference to my_nozzle_fan is misleading and could cause people to skip over the [fan] definition and assume this is the parts/print cooling fan. Alias changed to reflect heatbreak_cooling_fan as used in most configs that have a controllable hotend fan. Signed-off-by: James Hartley <james@hartleyns.com>
* docs: Update Measuring_Resonances.md (#6234)Adam2023-06-281-4/+5
| | | | | Clarifying the ADXL345 on pi instructions. Previously, the instructions on installing the linux klipper instance were in a confusing place. Signed-off-by: Adam Kramer <akramer@gmail.com>
* docs: Improve documentation of i2c_software_scl_pin/i2c_software_sda_pinKevin O'Connor2023-06-201-8/+7
| | | | | | Reported by @rootiest Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: note rri deprecation in config_changesEric Callahan2023-06-201-0/+7
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* docs: update Bed Mesh documentationEric Callahan2023-06-202-23/+58
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* tmc: Configurable `multistep_filt`Alex Voinea2023-06-162-0/+7
| | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* i2c_software: Implementation of software i2c (#6141)BIGTREETECH2023-06-071-0/+24
| | | Signed-off-by: Alan.Ma from BigTreeTech <tech@biqu3d.com>
* docs: Fix link in Sponsors.mdKevin O'Connor2023-06-051-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Sponsors.mdKevin O'Connor2023-06-052-0/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* parsecandump: New utility to parse Klipper messages in a candump captureKevin O'Connor2023-05-301-0/+26
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add new CANBUS_Troubleshooting.md documentKevin O'Connor2023-05-305-0/+121
| | | | | | Add information on troubleshooting canbus connections. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Kconfig: Change default CANbus frequency to 1000000Kevin O'Connor2023-05-301-0/+6
| | | | | | | | Change the default CANbus frequency from 500000 to 1000000. A higher frequency allows for greater data transfer rates, lower latency of messages, and should overall be more robust. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update CANBUS.mdKevin O'Connor2023-05-301-37/+44
| | | | | | | | | | | | | Recommend USB to CAN adapter and no longer recommend using the waveshare rpi hat. Recommend using allow-hotplug for all USB adapters. Note bandwidth limitations when using USB to CAN bridge mode. Note that a USB to CAN mcu is not a USB serial device. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor update to Config_Changes.md datesKevin O'Connor2023-05-251-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* resonance_tester: Apply input shaper params on SHAPER_CALIBRATEDmitry Butyugin2023-05-252-1/+6
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* resonance_tester: Support CHIPS= parameter in SHAPER_CALIBRATE commandDmitry Butyugin2023-05-251-1/+1
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 11:21:38 +0000