aboutsummaryrefslogtreecommitdiffstats
path: root/docs/Config_Reference.md
Commit message (Collapse)AuthorAgeFilesLines
* 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>
* docs: Revise sensorless homing configuration guideKevin O'Connor2021-03-251-13/+16
| | | | | | | Recommend finding the minimum and maximum stallguard settings while tuning sensorless homing. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Deprecate support for the pin_map config optionKevin O'Connor2021-03-251-8/+0
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* replicape: Don't require a host alias for the enable_pin defaultKevin O'Connor2021-03-251-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* bme280: Add support for BMP280 and BME680 sensors (#4040)Michael Kurz2021-03-151-6/+6
| | | | | | | | | This adds support for BMP280 and BME680 sensor ICs, along with fixing calibration data readout for BME280. Gas sensor readout for the BME680 is just the raw compensated value. To get actual meaningful values, more research is needed. Signed-off-by: Michael Kurz <michi.kurz@gmail.com>
* filament_motion_sensor: Add filament_motion_sensor (#3857)TheJoshW2021-03-141-0/+28
| | | | | Add functionality to support a Filament Motion Sensor for detecting extruder jams as well as runouts. Works by an encoder toggling the switch_pin 0/1 as the filament is pulled through the sensor. Signed-off-by: Joshua Wherrett <thejoshw.code@gmail.com>
* mcu: Add support for connecting to devices on a CAN busKevin O'Connor2021-03-131-1/+8
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rename Sensorless_homing.md to TMC_Drivers.md and extendKevin O'Connor2021-03-101-4/+6
| | | | | | Add additional information on configuring and using TMC drivers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc2660: Do not enable SFILT by defaultKevin O'Connor2021-03-101-1/+1
| | | | | | | None of the other TMC driver enable SFILT by default and it seems enabling SFILT may not be ideal for sensorless homing. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* st7920: Better support for emulated ST7920 displays (#3979)teeminus2021-03-011-3/+15
| | | | | Added new ST7920E display driver which is better suited for displays with emulated ST7920 Signed-off-by: Christian Kehe <teeminus@posteo.net>
* fan: Add tachometer supportAdrian Keet2021-03-011-0/+25
| | | | | | | | | | | | | | This adds new config options for fans: 'tachometer_pin' to specify the GPIO pin, and 'tachometer_ppr' (default 2) to specify the number of signal pulses per revolution. The rpm is also exposed by get_status for command templates and the API server. For fast fans (at least 10000 RPM), the polling interval can be shortened using the 'tachometer_poll_interval' option. There is a new mcu object for a generic edge counter, which repeatedly polls a GPIO pin and periodically reports the count to the host. Signed-off-by: Adrian Keet <arkeet@gmail.com>
* tmc2130: Add spi daisy chain supportMarco D'Alessio2021-02-261-0/+12
| | | | | | | | This patch adds the ability to daisy-chain multiple tmc2130 and tmc5160 drivers. Signed-off-by: Marco D'Alessio <marco@wrecklab.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use BME280 (uppercase) in Config_Reference.md (#3896)Stefan Dej2021-02-221-2/+2
| | | Signed-off-by: Stefan Dej <meteyou@gmail.com>
* temperature_host: Rename "path" config to "sensor_path"Kevin O'Connor2021-02-201-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* temperature_host: Rename rpi_temperature and add support for custom pathsEvgenii2021-02-191-3/+7
| | | | | Signed-off-by: Evgenii Shavrin <shavrin0591@gmail.com> Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* ds18b20: new module for 1-wire temperature sensor (#3462)Alan Lord2021-02-021-0/+17
| | | | | | | | | Initial commit of code to support 1-wire (Dallas) sensors such as the DS18B20. Requires Linux kernel drivers to create a file in /sysfs which is read by this module, and temperature typically returned to a temperature_fan. Signed-off-by: Alan Lord <alanslists@gmail.com> Signed-off-by: Josh Headapohl <joshhead@gmail.com>
* hd44780: Add hd44780 protocol init configThomas Kroll2021-01-311-0/+5
| | | | | | | LDO OLED needs a different init string. Fixes: #3722 Signed-off-by: Thomas Kroll <t.kroll@outlook.com>
* docs: Limiting max_smoothing for input shaper autocalibrationDmitry Butyugin2020-12-221-1/+8
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* docs: Add a Rotation_Distance.md documentKevin O'Connor2020-12-181-0/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* endstop_phase: Obtain phases directly from stepper microsteps configKevin O'Connor2020-12-181-9/+5
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* stepper: Calculate step_distance from rotation_distanceKevin O'Connor2020-12-181-38/+43
| | | | | | | | Add support for automatically calculating the internal step_distance from new config parameters - rotation_distance, microsteps, full_steps_per_rotation, and gear_ratio. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Input Shaper and Resonances docs improvements (#3627)Dmitry Butyugin2020-12-171-3/+3
| | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
generated by cgit v1.2.3-70-g09d2 (git 2.50.1) at 2025-09-02 18:36:12 +0000