aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
Commit message (Collapse)AuthorAgeFilesLines
* toolhead: Replace max_accel_to_decel with minimum_cruise_ratioKevin O'Connor2024-03-131-7/+18
| | | | | | | | | The user facing max_accel_to_decel setting is complicated and confusing. Replace it with a new minimum_cruise_ratio parameter. Internally this user-facing parameter will calculate the existing low-level "accel_to_decel" mechanism. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bed_mesh: Remove deprecated relative_reference_indexKevin O'Connor2024-02-151-7/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bed_mesh: Implement adaptive bed mesh (#6461)voidtrance2024-01-261-0/+3
| | | | | | | | | | | | | | | | | | | | Adaptive bed mesh allows the bed mesh algorithm to probe only the area of the bed that is being used by the current print. It uses [exclude_objects] to get a list of the printed objects and their area on the bed. It, then, modifies the bed mesh parameters so only the area used by the objects is measured. Adaptive bed mesh works on both cartesian and delta kinematics printers. On Delta printers, the algorithm, adjusts the origin point and radius in order to translate the area of the bed being probe. Signed-off-by: Mitko Haralanov <voidtrance@gmail.com> Signed-off-by: Kyle Hansen <kyleisah@gmail.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pwm_cycle_time: New module for output pins with dynamic cycle timesKevin O'Connor2024-01-231-0/+18
| | | | | | | | | Remove support for changing the cycle time of pwm pins from the output_pin module. Use a new pwm_cycle_time module that supports setting dynamic cycle times. This simplifies the output_pin code and low-level pin update code. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* output_pin: Deprecate the maximum_mcu_duration parameterKevin O'Connor2024-01-231-9/+9
| | | | | | | Advise users to configure a pwm_tool config section if checking for maximum mcu duration is required. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* output_pin: Deprecate static_value parameterKevin O'Connor2024-01-231-5/+2
| | | | | | | | | | | | Remove support for configuring "static" pins in output_pin module. A "static" pin only saves a few bytes of memory in the micro-controller. The savings does not justify the increased code complexity. Deprecate the static_value parameter to warn users. In the interim, a static_value parameter will set both value and shutdown_value parameters. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* hall_filament_width_sensor: max filament diameterSami Haahtinen2023-12-171-0/+3
| | | | | | | | | 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>
* docs: Improve max_accel documentation in Config_Reference.mdKevin O'Connor2023-12-051-5/+13
| | | | | | | | | | 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>
* 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-161-0/+20
| | | | | | | | | 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>
* idex_modes: Fixed the case when carriages home in the same direction (#6310)Dmitry Butyugin2023-09-291-0/+8
| | | | | | | | | | | | | | | | | | | | | 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>
* 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-211-0/+21
| | | | Signed-off-by: Alan.Ma from BigTreeTech tech@biqu3d.com
* temperature_combined: A class that can combine several other temperature ↵Michael Jäger2023-08-011-0/+18
| | | | | sensors (#6230) Signed-off-by: Michael Jäger <michael@mjaeger.eu>
* axis_twist_compensation: Add X twist compensation module (#6149)Philippe Daouadi2023-08-011-0/+29
| | | | | | | | | | | | 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-011-8/+27
| | | | | | | | | | | 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>
* 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: 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: update Bed Mesh documentationEric Callahan2023-06-201-3/+11
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* tmc: Configurable `multistep_filt`Alex Voinea2023-06-161-0/+4
| | | | 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>
* aht10: update comments and docs for AHT20/AHT21 supportScott Mudge2023-04-241-2/+3
| | | | | The control bytes for the AHT20 and AHT21 are identical to the AHT10, but I had not been able to test just yet to ensure the sensor code supported the other sensors. I've wrapped up testing and updated the comments/docs to reflect this additional support. Signed-off-by: Scott Mudge <mail@scottmudge.com>
* docs: Add AHT10 temperature sensor doc section in Config_Reference.md ↵Scott Mudge2023-04-151-0/+23
| | | | | | | (followup #6138) (#6167) Followed general outline used by HTU21D and BME280. Signed-off-by: Scott Mudge <mail@scottmudge.com>
* tmc5160: add DRV_CONF Register for TMC5160 (#6154)vcore852023-04-111-0/+4
| | | | | | | In some condition ,“drvstrength 2” does not work. According to page 17, some mosfets need “drvstrength” set to 0 . From datasheet rev1.15, the DRVSTRENGTH reset default is 0 . (instead of 2) Signed-off-by: Albert Lin <vcore85@gmail.com>
* tmc: Enable sg_angle_offset for smooth switching from Stealthchop to ↵BIGTREETECH2023-03-271-0/+1
| | | | | Spreadcycle (#6123) Signed-off-by: Alan.Ma from BigTreeTech <tech@biqu3d.com>
* avr: Allow I2C bus speed to be set by Klipper (#6111)Dr. Matthew Swabey2023-03-211-8/+8
| | | | | Allow I2C bus speed to be set by appropriate Klipper commands. Signed-off-by: Matthew Swabey <matthew@swabey.org>
* tmc2240: initial implementationAlex Voinea2023-03-011-0/+119
| | | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typos (#6032)Thijs Triemstra2023-02-201-3/+3
| | | Signed-off-by: Thijs Triemstra <info@collab.nl>
* docs: Fix 'screw_thread' explanation in 'screws_tilt_adjust' section. (#6039)Bassam Husain2023-02-091-5/+5
| | | Signed-off-by: Bassam Husain <bassam.husain@gmail.com>
* docs: Fix typo in mpu9250 documentationCODeRUS2022-12-301-1/+1
| | | | | | Adding MPU-6515, replacing MPU-9255 duplicate Signed-off-by: Andrei Kozhevnikov <coderusinbox@gmail.com>
* tmc: Configurable microstep lookup table (#5920)Alex Voinea2022-12-211-0/+48
| | | | | | | Make all the microstep lookup table registers configurable via the config file. It also loads the default values. TMC220x and TMC2660 do not support this feature. Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* mpu9250: add MPU6500 (#5767)Yifei Ding2022-11-191-3/+4
| | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* z_thermal_adjust: Add Z thermal adjuster module (#4157)alchemyEngine2022-09-251-0/+39
| | | | | | Use a frame-coupled temperature probe to compensate for thermal expansion in real-time. Signed-off by: Robert Pazdzior <robertp@norbital.com>
* fan: add enable_pin option (#5732)dalegaard2022-09-031-0/+10
| | | Signed-off-by: Lasse Dalegaard <dalegaard@gmail.com>
* kinematics: Add deltesian printers (#5743)Tircown2022-09-011-2/+76
| | | | | Initial push of the working deltesian kinematics after some successful tests. Signed-off-by: Fabrice GALLET <tircown@gmail.com>
* docs: fixes typo on heater_bedPedro Lamas2022-07-281-1/+1
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* docs: Note mcu types with i2c_speed support in Config_Reference.mdKevin O'Connor2022-06-201-2/+11
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add mpu9250 to Config_Reference.mdKevin O'Connor2022-06-201-0/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note that i2c is not noise resilient in Config_Reference.mdKevin O'Connor2022-06-161-2/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: add exclude_object documentationFrank Tackitt2022-06-031-0/+14
| | | | | | | Also include sample macros to add M486 compatibility. Signed-off-by: Franklyn Tackitt <git@frank.af> Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
* virtual_sdcard: Adds on_error_gcodePedro Lamas2022-06-031-0/+3
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* docs: Update Config_Reference.md z_hop speed (#5514)camerony2022-05-231-2/+2
| | | | | The default z-hop speed is actually 15 mm/s according to the code in safe_z_home.py Signed-off-by: Cameron River <camerony@gmail.com>
* docs: Improve wording of screws_tilt_adjust in Config_Reference.mdKevin O'Connor2022-04-231-4/+4
| | | | | | Reported by @JamesH1978. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* neopixel: Support chains with a mix of color_orderKevin O'Connor2022-04-181-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update temperature_fan PID documentation in Config_Reference.mdKevin O'Connor2022-04-111-4/+15
| | | | | | Reported by @dewi-ny-je. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add link to linux mcu neopixels config docs (#5402)Karl Bowden2022-04-111-1/+4
| | | | | The reference to the linux mcu was helpful to understand what a linux mcu was but didn't help with understanding the technical reasons why it's not supported. Signed-off-by: Karl Bowden <karl@bearded.sexy>
* docs: Minor updates to SmartEffector docsKevin O'Connor2022-04-091-7/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* smart_effector: Config and command referenceDmitry Butyugin2022-04-091-0/+52
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>