aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Reorganize layout of G-Codes.mdKevin O'Connor2022-02-011-44/+39
| | | | | | | Break listing up by module name. Provide links to "extended" commands. Sort reference by module name. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Various minor fixes (#5175)Yifei Ding2022-01-261-1/+1
| | | Signed-off-by: Yifei Ding<yifeiding@protonmail.com
* extruder: Support disassociating a stepper from all extrudersKevin O'Connor2022-01-161-2/+3
| | | | | | | Support SYNC_STEPPER_TO_EXTRUDER commands with an EXTRUDER parameter set to an empty string. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* neopixel: Update neopixel.py to add BRG color order (#5110)Tim Abraham2022-01-121-1/+1
| | | | | | Add BRG color option. Document BRG color option. Signed-off-by: Timothy Abraham <Timothyabe93@gmail.com>
* docs: Docs comma culture (#4822)Paul McGowan2022-01-091-44/+44
| | | | | Many non-English speaking countries use a comma as a decimal separator for printed numbers. This can create some confusion in documentation and config files when not surrounded by contextual clues like parenthesis. Improve documentation by adding spaces to coordinates. Signed-off-by: Paul McGowan <mental450@gmail.com>
* docs: Fix hybrid_corexy typo in Config_Reference.mdKevin O'Connor2021-12-271-1/+1
| | | | | | Reported by @controlflow. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update tmc5160 stealthchop_threshold description in Config_Reference.mdKevin O'Connor2021-12-151-2/+1
| | | | | | Don't recommend tuning stealthchop_threshold as it can cause issues. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note systemic error introduced by interpolate setting in TMC_Drivers.mdKevin O'Connor2021-12-121-3/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend that hold_current not be specifiedKevin O'Connor2021-12-121-6/+9
| | | | | | | Changing motor current may itself introduce unwanted motor movement. As such, document that specifying a hold_current is not recommended. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Support step_pulse_duration even on TMC drivers in UART/SPI modeKevin O'Connor2021-11-291-1/+3
| | | | | | | | | | | | | | | Commit 689231df changed the default step_pulse_duration to 100ns for TMC drivers that are configured in UART/SPI mode, but it failed to document that change in Config_Changes.md and Config_Reference.md. Update those documents to reflect that change. Update the code so that a user may specify a custom step_pulse_duration even on TMC drivers that are configured in UART/SPI mode. This may be useful for drivers that use a level shifter on the step pin that requires more than a ~300ns to detect a level change. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* delta: max z-accel and speed ratio calculation for deltas (#4689)Nitram2021-11-291-0/+5
| | | | | Adding a possibility to use a lower z- acceleration. Signed-off-by: Martin Malmqvist <volcomosq@gmx.com>
* docs: Minor spelling fix to Config_Reference.mdKevin O'Connor2021-11-241-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rename DocumentsYifei Ding2021-11-221-4/+4
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* temperature_sensors: add ATC Semitec 104NT-4-R025H42G thermistorGeoffrey Young2021-11-151-7/+8
| | | | | | | | | | | | | | | | module: extras/temperature_sensors.cfg this thermistor is the 104NT-4 resold by Trianglelab (and others on Ali), as well as the 300 degree resold by Slice Engineering, both of which use the same RT table (TL even links to the ATC Semitec website) see the 300 C tab on the Slice spreadsheet: https://docs.google.com/spreadsheets/d/1904x5JK-Sup-cX5DqHiiZWaFVTK6_PQBFxgi_6yXEJw/edit#gid=934228925 as well as the TL product page: https://www.aliexpress.com/item/32843785247.html in addition to the RT table provided in temperature_sensors.cfg Signed-off-by: Geoffrey Young <geoffrey.young@gmail.com>
* temperature_sensors: Deprecate "NTC 100K beta 3950" thermistorKevin O'Connor2021-11-101-2/+2
| | | | | | | | | | It seems the common "beta 3950" thermistors generally follow a temperature table defined by the new "Generic 3950" definition. Using a table that actually follows the "beta 3950" temperature curve is generally less accurate. Deprecate the existing "NTC 100K beta 3950" definition to avoid this common issue. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Make step pulse duration customizable at run-timeKevin O'Connor2021-11-041-0/+5
| | | | | | | | | | | | Remove the STEP_DELAY Kconfig option and replace it with a per-stepper step_pulse_duration printer.cfg config option. The AVR code will continue to have optimized code to step and "unstep" in the same function (which is automatically activated when the step delay is 40 ticks or less). This change removes the Kconfig option for single function step/unstep on 32bit processors. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Should be "LM75" instead of "lm75" in Config_Reference.mdKevin O'Connor2021-11-011-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc: Track requested hold_current so SET_TMC_CURRENT doesn't reduce itKevin O'Connor2021-10-271-2/+2
| | | | | | | | | | | The code automatically reduces the hold_current so that it is no greater than the run_current. However, this could lead to confusing behavior if one reduced and then increased the run_current via SET_TMC_CURRENT commands. To avoid that, this change adds support for tracking the requested hold_current - thus changes to run_current don't subtly alter the hold_current. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* button: Support half-stepping encodersRufo Sanchez2021-10-111-0/+5
| | | | | | | | | | | | | Adds support for half-stepping encoders (encoders that only emit two steps per detent, instead of four). Incorporates the feedback from @susisstrolch's PR: https://github.com/KevinOConnor/klipper/pull/4202 , which was itself built upon a previous PR from @nickbrennan01: https://github.com/KevinOConnor/klipper/pull/730 Uses the table from the Rotary Arduino library linked in buttons.py: https://github.com/brianlow/Rotary/blob/6b784cca67c5f1ce5e11d757a540fc4c0311efca/Rotary.cpp#L21-L40 Signed-off-by: Rufo Sanchez <rufo@rufosanchez.com>
* heaters: Change default smooth_time from 2 seconds to 1 secondKevin O'Connor2021-09-031-2/+2
| | | | | | | | | | | | A larger smooth_time results in a slower reaction time for the PID. This increased delay can cause temperature oscillations with high power heaters. Many boards produce good results without any smoothing. So, it seems a smooth_time of 1 second is a better default. Reported by @ReXT3D. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* mcu: Support multi-mcu homingKevin O'Connor2021-08-281-4/+10
| | | | | | | Support endstops and probes attached to a different micro-controller than their associated steppers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add comment on additional stepper fields available in extruder sectionKevin O'Connor2021-08-171-0/+2
| | | | | | Reported by @alexsomesan. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-123/+125
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* controller_fan: Add "stepper" config option (#4447)Sophie Hirn2021-07-201-5/+7
| | | | | | Allows contoller_fan sections to monitor only certain steppers instead of all of them, similar to how heaters are currently handled. Signed-off-by: Sophie Hirn <sophie.hirn@wyvernscale.com>
* samd_sercom: Specify the sercom explicitly in a config optionKevin O'Connor2021-07-041-5/+9
| | | | | | | Do not infer the sercom from the config section name, as that prevents one from using SPI buses on multiple samd mcus. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* duplicate_pin_override: Debugging tool to permit multiple use pinsKevin O'Connor2021-06-271-0/+16
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* config: Specify gear_ratio for Prusa Mini+ extrudergithub@matthewlloyd.net2021-06-181-1/+2
| | | | | | | Also clarifies the documentation for rotation_distance in the stepper docs. Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
* docs: Deprecate pid_integral_max config optionKevin O'Connor2021-06-121-5/+0
| | | | | | | | The default pid_integral_max setting should be sufficient; it's not necessary to complicate the documentation and config to support customization. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid link descriptions that span multiple linesKevin O'Connor2021-05-281-4/+4
| | | | | | | The Jekyll markdown renderer gets confused by links that span multiple lines. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix link in Config_Reference.mdKevin O'Connor2021-05-281-3/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move description of menu templates to Command_Templates.mdKevin O'Connor2021-05-281-19/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* gcode_macro: add description property (#4317)Alex Zellner2021-05-261-0/+3
| | | Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
* safe_z_home: Update documentationFlorian Heilmann2021-05-261-5/+2
| | | | Signed-off-by: Florian Heilmann <Florian.Heilmann@gmx.net>
* docs: Minor updates to sdcard_loop documentationKevin O'Connor2021-05-261-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* loop_sdcard: Add loopable SD card file sectionsJason S. McMullan2021-05-261-0/+14
| | | | | | | | | | | | | | | | | | | | | To support continuous belt printing, add nestable repeat loop support via an `[sdcard_loop]` module. Supported G-Code: - SDCARD_LOOP_BEGIN COUNT=n ; Loop for N times, or infinitely if N is 0 - SDCARD_LOOP_END ; End of loop - SDCARD_LOOP_DESIST ; Complete all loops without iterating Marlin M808 compatibility example in `config/sample-macros.cfg`: - M808 Ln ; Loop for N times, or infinitely if N is 0 - M808 ; End of loop - M808 K ; Complete all loops without iterating Added unit tests in test/klippy/sdcard_loop.test See https://reprap.org/wiki/G-code#M808:_Set_or_Goto_Repeat_Marker Signed-off-by: Jason S. McMullan <jason.mcmullan@gmail.com>
* docs: Fix typo in Config_Reference.mdKevin O'Connor2021-05-061-1/+1
| | | | | | | Should be "hybrid-corexy" instead of "hybrid-codexy". Reported by @mak0t0san. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* kinematics: Add hybrid-corexy and hybrid-corexz (#4229)Tircown2021-05-031-1/+70
| | | Signed-off-by: Fabrice GALLET <tircown@gmail.com>
* gcode_macro: Deprecate default_parameter_<name>Kevin O'Connor2021-05-031-10/+0
| | | | | | | | | | | | The Jinja2 "set" directive is more flexible and easier to understand than default_parameter_XXX parameters. Deprecate it and encourage using "set" as a replacement. This also deprecates direct access to parameters via parameter name in a macro. Going forward, the `params` pseudo-variable must be used to access a parameter. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Move palette2 location in Config_Reference.mdKevin O'Connor2021-04-281-36/+36
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* probe: Add deactivate_on_each_sample: param for Probe (#4161)nlef2021-04-241-0/+4
| | | Signed-off-by: Nick Lefskiy <n.lefskiy@yandex.ru>
* palette2: Add ping variation + ping status reports (#4114)Clifford Roche2021-04-141-2/+4
| | | Signed-off-by: Clifford Roche <clifford.roche@gmail.com>
* docs: document bed mesh "faulty_regions"Arksine2021-04-101-0/+5
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* docs: Minor changs to pca9533 in Config_Reference.mdKevin O'Connor2021-04-091-10/+12
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* pca9533: RGB support for the mightyboard (#4150)le-Bark2021-04-091-0/+22
| | | Signed-off-by: Marc-André Denis <marcadenis@msn.com>
* docs: Minor display sectoin updates to Config_Reference.mdKevin O'Connor2021-04-091-7/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Docs: Split the display section of Config_Reference.md into multiple sectionsKevin O'Connor2021-04-091-81/+173
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor copy-and-paste fix to Config_Reference.mdKevin O'Connor2021-04-091-3/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* hd44780_spi: added lcd support to the mightyboard (#4121)le-Bark2021-04-071-7/+12
| | | Signed-off-by: Marc-André Denis <marcadenis@msn.com>
* output_pin: Support setting max_duration (#3995)Pascal P2021-03-261-0/+7
| | | | | Also added documentation for using powered tools. Signed-off-by: Pascal Pieper <accounts@pascalpieper.de>
* palette2: Add support for P2 devices (#4057)Clifford Roche2021-03-261-0/+34
| | | | | Module which bring support for P2 devices running in connected mode. This enables using a Palette2 directly with Klippy without Octoprint, or without Palette2 plugins for Octoprint which are not functional out of the box with Klipper. Signed-off-by: Clifford Roche <clifford.roche@gmail.com>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 22:11:20 +0000