Commit Graph

790 Commits

Author SHA1 Message Date
Kevin O'Connor 8e1929649f docs: Fix typo in Debugging.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-24 10:17:49 -04:00
Kevin O'Connor 7f704c4749 docs: Add information on motan scripts to Debugging.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-22 12:22:11 -04:00
Kevin O'Connor 2fdd8a420d motion_report: Add support for dumping steps/trapq via API server
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-22 11:10:19 -04:00
Kevin O'Connor e37d2dee90 docs: Note config list change to Config_Changes.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-21 18:08:11 -04:00
Kevin O'Connor 3814a13251 homing: Calculate homing position based on trigger time
Calculate the "homing position" using the endstop trigger time instead
of the position of the steppers.

This is in preparation for multi-mcu homing.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-17 22:35:59 -04:00
Kevin O'Connor bd0185cf75 docs: Don't use section-index plugin during klipper3d.org site generation
The section-index plugin can cause some confusing navigation.  Use the
simpler site navigation for now.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-17 19:39:23 -04:00
Randell Hodges f313a2294a
bed_mesh: Added PROFILE name option (#4522)
Added optional PROFILE parameter to allow bed_mesh_calibrate to
save the mesh directly into the provided profile name instead of
default. If omitted, it will be stored in default.

Signed-off-by: Randell L Hodges <rhodges@taxfodder.com>
2021-08-17 15:30:14 -04:00
Matt Heath df98470659 docs: Fix reference to neopixel color_data
Fix reference to neopixel color_data in status reference documentation
so the given example works as expected.

Signed-off-by: Matt Heath <hello@mattheath.com>
2021-08-17 14:43:51 -04:00
Kevin O'Connor 4edab5b3da docs: Add comment on additional stepper fields available in extruder section
Reported by @alexsomesan.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-17 14:21:45 -04:00
Kevin O'Connor cf3c7cd99a avr: Rename the analog-only PE0/PE1 pins on atmega168/328 to PE2/PE3
The atmega328pb has officially named these pins as PE2 and PE3, so use
that naming scheme instead of the previous Klipper invented names.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-14 22:00:17 -04:00
Kevin O'Connor 24586f0c31 stepper: Query the stepper mcu position during startup
Try to keep the host mcu_position synchronized with the
micro-controller by querying during startup and after every homing
event.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-06 13:12:49 -04:00
Kevin O'Connor 3176150050 mkdocs_hooks: Improve check for not in a list
Look for lines that don't start with a list and don't start with a
space to check for the end of a list.  This fixes the rendering of the
list in BLTouch.md .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 16:14:54 -04:00
Kevin O'Connor b8f6b90467 mkdocs_hooks: Add some comments to the script
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 15:48:51 -04:00
Kevin O'Connor b837a344c1 _klipper3d: Add additional comments to mkdocs.yml
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 14:05:25 -04:00
Kevin O'Connor c3ab8fee90 docs: Reorder sections of Debugging.md
Reorder the sections to put most useful information at the top.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-08-02 12:49:48 -04:00
Kevin O'Connor 60aa05829f motion_report: Add get_status() method with current requested toolhead position
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-29 16:53:32 -04:00
Damien be122411b5 klipper3d: links to anchors not working with Safari
Solves issue #4538

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-28 09:26:08 -04:00
shiftingtech 32eb2ee2d1
docs: fixed babystepping patch (#4526)
Just a quick cleanup to where I flubbed the Z_OFFSET_APPLY_ENDSTOP and  Z_OFFSET_APPLY_PROBE documentation

Signed-off-by: Ben Eastep <shifting@shifting.ca>
2021-07-27 21:57:18 -04:00
Kevin O'Connor a17c2ae397 _klipper3d: Set use_directory_urls to False
Restore old link behavior - each document file will have a single html
file ending in the ".html" suffix.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 18:58:08 -04:00
Kevin O'Connor ba16c0f1aa _klipper3d: Move mkdocs.yml to docs/_klipper3d
Reported by @damlobster .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 17:10:59 -04:00
Kevin O'Connor 9c6b4d1bf4 _klipper3d: Add comments to files in this directory
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:49:06 -04:00
Kevin O'Connor bca64895e4 _klipper3d: Add trailing newline to extra.css
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:34:40 -04:00
Kevin O'Connor 37efd1b8f1 docs: Use hash marks for header lines
Consistently use leading hash marks (#) to note section headers.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-27 13:29:36 -04:00
Damien Martin afca515e2c docs: make mkdocs_hooks.transform more robust
- Keeps the markdown inside the code blocks as is
- Logs the modified lines (mkdocs serve —verbose)

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-27 13:15:25 -04:00
Damien ea802aa91e docs: Setup mkdocs with mkdocs-material theme
This changes the framework used to generate the klipper3d site.

Signed-off-by: Damien Martin <damlobster@gmail.com>
2021-07-27 13:15:25 -04:00
Damien cff61605fb docs : make modifications to all md files to make them compatible with mkdocs
all markdown files must have a single H1 heading at the top.

Signed-off-by: Damien Martin <damlobster@gmail.com>

Update CNAME
2021-07-27 13:15:25 -04:00
strayr c8405fe3db
docs: Note to enable SPI in RPi_microcontroller.md (#4503)
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>
2021-07-25 20:34:00 -04:00
shiftingtech f949bc882d
probe: add ability to save babystepping (#4404)
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>
2021-07-25 20:20:15 -04:00
Kevin O'Connor 103dcf27ff controller_fan: Minor updates
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>
2021-07-20 10:34:14 -04:00
Sophie Hirn de57ce3a99
controller_fan: Add "stepper" config option (#4447)
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>
2021-07-20 10:19:59 -04:00
Martin 4cf25c714a
docs: Add hardware RPi PWM documentation (#4418)
Signed-off-by: Martin van Es <martin@mrvanes.com>
2021-07-15 13:24:02 -04:00
Dmitry Butyugin 2ef5e03ce4 docs: Updated docs for custom AXIS in TEST_RESONANCES
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2021-07-08 11:00:23 -04:00
shiftingtech 0edcd0bb7b
docs: added an apt update to measuring_resonance (#4417)
Signed-off-by: Ben Eastep <shifting@shifting.ca>
2021-07-08 10:38:12 -04:00
Kevin O'Connor ff5689e9e1 docs: Add rp2040 benchmark results to Benchmarks.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-07-04 10:16:01 -04:00
Kevin O'Connor d1bdde56cc samd_sercom: Specify the sercom explicitly in a config option
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>
2021-07-04 09:48:45 -04:00
Kevin O'Connor 7fd7853785 duplicate_pin_override: Debugging tool to permit multiple use pins
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-06-27 18:50:51 -04:00
Tircown 4d559633e3
kinematics: Add dual_carriage to hybrid-corexyz (#4296)
- 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>
2021-06-27 18:37:05 -04:00
Matthew Lloyd c2907c998c
screws_tilt_adjust: Add DIRECTION parameter to SCREWS_TILT_CALCULATE (#4357)
Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
2021-06-22 15:18:05 -04:00
Kamil Trzcinski f1091a484b virtual_sdcard: add `file_path` and `file_size` to `status`
This provides a comprehensive information if currently
we have a file loaded.

Signed-off-by: Kamil Trzcinski <ayufan@ayufan.eu>
2021-06-22 15:15:03 -04:00
github@matthewlloyd.net 478f26cab6 config: Specify gear_ratio for Prusa Mini+ extruder
Also clarifies the documentation for rotation_distance in the
stepper docs.

Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
2021-06-18 10:54:51 -04:00
Eric Callahan 8bcfaa53aa docs: add status documentaton for neopixel and dotstar
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2021-06-18 10:53:12 -04:00
Alex Zellner f7279a037d
docs: add CANCEL_PRINT to docs/G-Codes.md (#4370)
Signed-off-by: Alex Zellner <alexander.zellner@googlemail.com>
2021-06-14 13:01:42 -04:00
Kamil Trzcinski d2c2aaf55d extruder: expose `can_extrude` flag based on temperature
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>
2021-06-14 12:56:50 -04:00
Kevin O'Connor a0c27571dd docs: Note previous firmware state issue with TMC2209/TMC2209 in TMC_Drivers.md
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>
2021-06-12 14:16:23 -04:00
Kevin O'Connor 07004a889d docs: Recommend pause of 2 seconds during sensorless homing
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-06-12 13:34:39 -04:00
Kevin O'Connor 6db40df6af docs: Deprecate pid_integral_max config option
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>
2021-06-12 13:29:11 -04:00
Kevin O'Connor d1665fae4f docs: Update Code_Overview.md with the removal of calc_tag_position()
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-06-11 23:04:30 -04:00
Eric Callahan b513d085a5 docs: Add documentation for BED_MESH_OFFSET
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
2021-06-08 00:02:35 -04:00
Dmitry Butyugin 4596a244e3
resonance_tester: Set max_accel ignoring the limit from the config (#4174)
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2021-06-06 13:04:53 -04:00
Kevin O'Connor e0e8615aaf docs: Fix missing backtick in API_Server.md
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-06-06 12:01:03 -04:00