aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* _klipper3d: Add comments to files in this directoryKevin O'Connor2021-07-274-0/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* _klipper3d: Add trailing newline to extra.cssKevin O'Connor2021-07-271-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Use hash marks for header linesKevin O'Connor2021-07-279-104/+67
| | | | | | Consistently use leading hash marks (#) to note section headers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: make mkdocs_hooks.transform more robustDamien Martin2021-07-271-10/+23
| | | | | | | - Keeps the markdown inside the code blocks as is - Logs the modified lines (mkdocs serve —verbose) Signed-off-by: Damien Martin <damlobster@gmail.com>
* docs: Setup mkdocs with mkdocs-material themeDamien2021-07-279-165/+41
| | | | | | This changes the framework used to generate the klipper3d site. Signed-off-by: Damien Martin <damlobster@gmail.com>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-2744-536/+565
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* docs: Note to enable SPI in RPi_microcontroller.md (#4503)strayr2021-07-251-0/+4
| | | | | whilst this line is in Measuring_Resonances.md, users following this guide for other reasons have no cause reason to read that and don't have an explanation for what they didn't know they didn't do. Signed-off-by: Rowland Straylight <rowlandstraylight@gmail.com>
* probe: add ability to save babystepping (#4404)shiftingtech2021-07-251-5/+11
| | | | | | | | Created two new extended gcodes: Z_OFFSET_APPLY_ENDSTOP, and Z_OFFSET_APPLY_PROBE. These use the z gcode offset to revise the probe offset, or z endstop position allowing users to make a frequently used babystepping value permanent without manual config editing. Signed-off-by: Ben Eastep <shifting@shifting.ca>
* controller_fan: Minor updatesKevin O'Connor2021-07-201-0/+5
| | | | | | | | | | Document change in behavior of the controller_fan module. Lookup heater objects in connect() event handler. Return list of stepper names from stepper_enable.get_steppers(). Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* 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>
* docs: Add hardware RPi PWM documentation (#4418)Martin2021-07-151-0/+36
| | | Signed-off-by: Martin van Es <martin@mrvanes.com>
* docs: Updated docs for custom AXIS in TEST_RESONANCESDmitry Butyugin2021-07-082-2/+35
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* docs: added an apt update to measuring_resonance (#4417)shiftingtech2021-07-081-1/+2
| | | Signed-off-by: Ben Eastep <shifting@shifting.ca>
* docs: Add rp2040 benchmark results to Benchmarks.mdKevin O'Connor2021-07-041-0/+27
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* samd_sercom: Specify the sercom explicitly in a config optionKevin O'Connor2021-07-042-5/+12
| | | | | | | 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>
* kinematics: Add dual_carriage to hybrid-corexyz (#4296)Tircown2021-06-271-0/+9
| | | | | | | - Add dual_carriage abilities for hybrid-corexy and hybrid-corexz - Introduce the module idex_mode - Fix add_stepper to the correct rail in hybrid-corexy Signed-off-by: Fabrice GALLET <tircown@gmail.com>
* screws_tilt_adjust: Add DIRECTION parameter to SCREWS_TILT_CALCULATE (#4357)Matthew Lloyd2021-06-222-9/+20
| | | Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
* virtual_sdcard: add `file_path` and `file_size` to `status`Kamil Trzcinski2021-06-221-0/+2
| | | | | | | This provides a comprehensive information if currently we have a file loaded. Signed-off-by: Kamil Trzcinski <ayufan@ayufan.eu>
* 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: add status documentaton for neopixel and dotstarEric Callahan2021-06-181-0/+9
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* docs: add CANCEL_PRINT to docs/G-Codes.md (#4370)Alex Zellner2021-06-141-0/+1
| | | Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
* extruder: expose `can_extrude` flag based on temperatureKamil Trzcinski2021-06-141-0/+2
| | | | | | | | | Sometimes an automated filament load is implemented, but extruder might not always extrude filament. This adds a flag to check if this operation is possible. Signed-off-by: Kamil Trzcinski <ayufan@ayufan.eu>
* docs: Note previous firmware state issue with TMC2209/TMC2209 in TMC_Drivers.mdKevin O'Connor2021-06-121-0/+6
| | | | | | | | | | | If a high UART frequency is used to communicate with TMC2208/TMC2209 drivers then it may not be possible for Klipper to communicate with the drivers until they are reset. Note this in the troubleshooting document. Reported by @matthewlloyd. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Recommend pause of 2 seconds during sensorless homingKevin O'Connor2021-06-121-13/+17
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Deprecate pid_integral_max config optionKevin O'Connor2021-06-122-5/+4
| | | | | | | | 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: Update Code_Overview.md with the removal of calc_tag_position()Kevin O'Connor2021-06-111-11/+10
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add documentation for BED_MESH_OFFSETEric Callahan2021-06-082-0/+15
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* resonance_tester: Set max_accel ignoring the limit from the config (#4174)Dmitry Butyugin2021-06-061-11/+1
| | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* docs: Fix missing backtick in API_Server.mdKevin O'Connor2021-06-061-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* endstop_phase: Add support for reporting phase information via get_status()Kevin O'Connor2021-06-031-0/+14
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update G-Codes.md now that SET_VELOCITY_LIMIT can exceed configKevin O'Connor2021-06-031-2/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* z_tilt: expose an 'applied' status to allow macros to skip QGL/Z_TILT_ADJUST ↵Michael Rose2021-06-021-0/+14
| | | | | | | | | | | | | | (#4313) This is useful for macros that'd like to skip QGL if already leveled, e.g.: ``` {% if not printer.quad_gantry_level.applied %} QUAD_GANTRY_LEVEL {% endif %} ``` Signed-off-by: Michael Rose <elementation@gmail.com>
* neopixel: add sync parameter to prevent waking toolhead (#4339)Paul McGowan2021-06-021-2/+7
| | | | | | | neopixel: add sync param to prevent waking toolhead dotstar: refactor to match neopixel methods and add sync parameter Signed-off-by: Paul McGowan <mental405@gmail.com>
* stepper: Remove set_tag_position() codeKevin O'Connor2021-05-291-6/+5
| | | | | | Have callers store the stepper positions in a dict. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix malformed link in beaglebone.mdKevin O'Connor2021-05-291-5/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix typo in Status_Reference.mdKevin O'Connor2021-05-281-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid link descriptions that span multiple linesKevin O'Connor2021-05-2810-98/+107
| | | | | | | 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-282-19/+27
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Updated adxl345 wiring imageDmitry Butyugin2021-05-281-0/+0
| | | | | | | ADXL345 3.3v and GND pins can be wired closer to the other pins on RPi, which is often more convenient. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* gcode_macro: add description property (#4317)Alex Zellner2021-05-262-0/+22
| | | 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-262-9/+14
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* loop_sdcard: Add loopable SD card file sectionsJason S. McMullan2021-05-262-0/+21
| | | | | | | | | | | | | | | | | | | | | 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>
* filament_motion_sensor: add get_status (#4281)Alex Zellner2021-05-111-0/+9
| | | Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
* debugcmds: Remove start/end_group commandsKevin O'Connor2021-05-071-1/+1
| | | | | | | | These commands were never used by the main code and are not particularly helpful for debugging. Remove them to reduce code size - in particular on the pru architecture. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* 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-032-10/+6
| | | | | | | | | | | | 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>