3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5,226 Commits 1 Branch 0 Tags 27 MiB
Commit Graph

1112 Commits

Author SHA1 Message Date
Yifei Ding 9047702a00 mkdocs: Replace TOC in Translations 
Signed-off-by: Yifei Ding<yifeiding@protonmail.com>
 2022-06-03 19:14:13 -04:00
Stefan Dej 7c8cf7661b docs: fix typo in Exclude_Object.md 
Signed-off-by: Stefan Dej <meteyou@gmail.com>
 2022-06-03 18:11:35 -04:00
Frank Tackitt 638cd4d781 docs: add exclude_object documentation 
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>
 2022-06-03 14:12:04 -04:00
Pedro Lamas c16eab212e virtual_sdcard: Adds on_error_gcode 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2022-06-03 11:26:34 -04:00
Mikkel Schmidt af38d708cb
adxl345: Support recording data from multiple ADXL345's in one run, and more. (#5224) 
Add PROBE and CHIP to TEST_RESONANCES

Since it's possible to specify more than one chip
in TEST_RESONANCES the CHIP parameter has been
renamed to CHIPS

Signed-off-by: Mikkel Schmidt <mikkel.schmidt@gmail.com>
 2022-05-23 19:56:58 -04:00
Kevin O'Connor c7e0372c5d docs: Line wrapping in G-Codes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-23 15:50:43 -04:00
Kevin Nguyen 3081899883
docs: Documentation on screws_tilt_calculate MAX_DEVIATION parameter (#5522) 
Signed-off-by: Kevin Nguyen <ngynkvn@gmail.com>
 2022-05-23 15:49:59 -04:00
camerony f1c6f76a51
docs: Update Config_Reference.md z_hop speed (#5514) 
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>
 2022-05-23 15:05:53 -04:00
th33xitus bbb06a014b docs: fix links to Config_Reference.md 
Signed-off-by: Dominik Willner <th33xitus@gmail.com>
 2022-05-18 12:05:28 -04:00
Kevin O'Connor 1c18265a62 docs: Minor wording update to Code_Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-17 11:55:17 -04:00
Kevin O'Connor e8dc44a0ca docs: Update Code_Overview.md with more realistic task timing guidelines 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-17 11:46:38 -04:00
Kevin O'Connor 95676343db docs: Updates to Installation.md document 
Recommend users obtain an example config file prior to starting the
installation.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-17 11:36:36 -04:00
Kevin O'Connor be4b8b17f2 docs: Minor CanBoot documentation fixes 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-10 11:55:06 -04:00
Eric Callahan 95d06c95e3 docs: add CanBoot documentation to bootloaders.md 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2022-05-10 11:48:06 -04:00
3-5-20 b44eee609a
docs: Update G-Codes.md (#5487) 
Typo correction: my -> by

Signed-off-by: Oscar Cetnarowski <0.007954545@proton.me>
 2022-05-09 22:20:06 -04:00
Kevin O'Connor 661f5b08c8 docs: Fix typo in Benchmarks.md 
Reported by @kaidegit.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-06 14:54:50 -04:00
Kevin O'Connor c4232bea2e docs: Note pins used for stm32flash in Bootloaders.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-05-04 13:54:42 -04:00
Kevin O'Connor 722ad4a1d2 docs: Update Example_Configs.md to note that baud should be 250000 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-30 14:51:14 -04:00
Kevin O'Connor e43fd4fab0 docs: Note to run DELTA_CALIBRATE before DELTA_ANALYZE in Delta_Calibrate.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-29 13:58:05 -04:00
Kevin O'Connor 1eb6afdbe5 docs: List only micro-controller names in benchmarks table in Features.md 
There is concern that some users are interpreting the benchmark table
in Features.md as a list of "supported boards" or possibly
"recommended boards".  This was not the intent.

Remove the board names from the list to make it more clear the intent
is only to describe the benchmarks.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-29 12:20:41 -04:00
Kevin O'Connor 07a90902a5 docs: Improve wording of screws_tilt_adjust in Config_Reference.md 
Reported by @JamesH1978.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-23 21:22:02 -04:00
Kevin O'Connor a02da85101 docs: Fix typo in query_adc section of G-Codes.md 
Reported by @jakep82.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-21 19:20:46 -04:00
Kevin O'Connor 5f0885958d neopixel: Support chains with a mix of color_order 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-18 10:16:10 -04:00
alstoepp 44567879f6
stm32: Add STM32F072 16KiB bootloader option (#5404) 
Signed-off-by: Alexander Stöpperger <a.stoepperger@gmx-topmail.de>
 2022-04-13 11:22:04 -04:00
Kevin O'Connor 4a8a76ead8 docs: Update temperature_fan PID documentation in Config_Reference.md 
Reported by @dewi-ny-je.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-11 11:46:24 -04:00
Karl Bowden 5d82be2f5d
docs: Add link to linux mcu neopixels config docs (#5402) 
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>
 2022-04-11 10:35:38 -04:00
Kevin O'Connor 4d4c8d8f94 docs: Add link to Moonraker in API_Server.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-09 19:32:38 -04:00
Kevin O'Connor 6e61e47a23 docs: Fix smarteffector link in G-Codes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-09 19:13:30 -04:00
Kevin O'Connor 05330fd3e5 docs: Minor updates to SmartEffector docs 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-09 19:10:16 -04:00
Dmitry Butyugin 2060a6908f smart_effector: Config and command reference 
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
 2022-04-09 19:04:57 -04:00
cbc02009 f3b995227a
docster: Fix incorrect default value for max_freq 2022-04-09 16:31:23 -04:00
Kevin O'Connor 7c5b7191c3 docs: Update wording of "quality improvement" section of CONTRIBUTING.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-08 09:56:22 -04:00
Kevin O'Connor 5a409d5d31 docs: Provide more information on PID in Config_Reference.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-07 12:30:02 -04:00
Kevin O'Connor 647a1cd8ca temperature_fan: Remove deprecated pid_integral_max option 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-07 12:10:48 -04:00
Kevin O'Connor 555ac58a3f pca9632: Add support for configurable color_order 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-07 11:48:25 -04:00
Kevin O'Connor f0700c0985 pca9632: Support using hardware I2C 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-07 11:43:52 -04:00
Yifei Ding 61792e3e31 _klipper3d: Specify mkdocs language config options 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-06 19:04:48 -04:00
Yifei Ding b35b6cb10b _klipper3d: New language translation deployment 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-06 19:04:48 -04:00
Kevin O'Connor 444d209cce _klipper3d: Remove translation stubs 
Support for language translations on the klipper3d.org site was
disabled in commit c067d4df.  Fully remove the support in this commit.
This is in preparation for an alternate implementation.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-06 19:04:48 -04:00
Kevin O'Connor dc7b02f329 neopixel: Support arbitrary RGBW strings in color_order config 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-06 09:27:36 -04:00
Kevin O'Connor 92de6e91dc docs: Note that "minutes" in screws_tilt_adjust means minutes of a clock face 
Reported by @kubik369 and @Sineos.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-04-05 20:35:56 -04:00
Kevin O'Connor e6bfc4c9aa led: Support setting display_template parameters via SET_LED_TEMPLATE 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-31 13:08:12 -04:00
Kevin O'Connor 1ab3ac39e4 led: Support automated LED updates based on display_template results 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-31 13:08:12 -04:00
Kevin O'Connor 35ff49e546 docs: Note that neopixel doesn't work on "linux mcu" 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-31 13:08:12 -04:00
Kevin O'Connor a7f69caa37 docs: Note change to neopixel/dotstar API status fields 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-31 13:08:12 -04:00
Kevin O'Connor 96795def9c led: Add support for PWM controlled LEDs 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-31 13:08:12 -04:00
Kevin O'Connor 3340bb2ffd docs: Add explicit Jinja2 prerequisite to mkdocs-requirements.txt 
Avoid build failures by adding explicit Jinja2 version.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-29 20:40:48 -04:00
Kevin O'Connor 4d1c3478ab angle: Add support for reading tle5012b chip registers (for debugging) 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-29 20:34:46 -04:00
Kevin O'Connor 1b08553a42 angle: Report tle5012b temperature 
Export the tle5012b temperature readings when performing measurements.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-29 20:34:46 -04:00
Kevin O'Connor aec742ece4 angle: Initial support for angle sensor calibration 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-29 20:34:46 -04:00
Kevin O'Connor 74937326d3 sensor_angle: Add support for bulk querying of spi angle sensors 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-29 20:34:46 -04:00
Charles Pickering 7e654aed2f docs: Fix config snippet for polar 
Previously the section for stepper_bed was intertwined with printer. This commit makes it match (../config/example-polar.cfg).

Signed-off-by: Charles Pickering <me@charlespick.xyz>
 2022-03-20 11:43:32 -04:00
Kevin O'Connor b4b19b8fc1 docs: Add a link to Rotation_Distance.md in Example_Configs.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-17 21:50:33 -04:00
Kevin O'Connor d7f8bf351f docs: Fix section headers of [display] sections in Config_Reference.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-16 12:04:41 -04:00
Ricardo Alcântara 0761026e36
pca9632: LED module for FlashForge Dreamer 3D printer (#4654) 
Added PCA9632 LED module support using software I2C from MCP4018
modulo drive the LED strip of a FlashForge Dreamer 3D printer.
Based on the PCA9533 module. 

Signed-off-by: Ricardo Alcantara <ricardo@vulcanolabs.xyz>
 2022-03-14 14:28:42 -04:00
electron2410 02d770ae3c
neopixel: add BGR for neopixel (#5160) 
Signed-off-by: Thomas Liebold <electron2410@gmail.com>
 2022-03-14 12:30:58 -04:00
Kevin O'Connor 30098db22a docs: Fix typo in RPi_microcontroller.md 
Reported by @bradengel.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-14 00:38:25 -04:00
Kevin O'Connor 1de0d75079 docs: Move "benefits" review section up in CONTRIBUTING.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-13 17:13:55 -04:00
Fritz Webering 24e7bbf0df
docs: Add missing bltouch lift_speed option to Config_Reference.md (#5344) 
Signed-off-by: Fritz Webering <fritz@webering.eu>
 2022-03-11 13:35:08 -05:00
Kevin O'Connor c721c20c97 docs: Improve G-Codes.md description of extruder commands 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-08 15:34:11 -05:00
Pedro Lamas 38b992532a display_status: stops M73 from setting progress to 0 if P missing 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2022-03-08 14:20:35 -05:00
Kevin O'Connor 4815a946c2 extruder_stepper: Do not default to synching with "extruder" at startup 
With recent changes, the extruder_stepper may be used for new
purposes, and synchronizing to the "extruder" motion queue at startup
may become a confusing default.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-04 13:38:59 -05:00
Kevin O'Connor 6627d036ac extruder: Allow an extruder object to be created without a stepper 
This may be useful for dual hotend printers that have only one
stepper.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-04 13:20:35 -05:00
Kevin O'Connor 4a8aece6a7 docs: Note g-code output is not intented to be parsed in G-Codes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-03 22:20:27 -05:00
Kevin O'Connor c31f981575 docs: Add link to GET_POSITION description in G-Codes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-03-03 21:48:57 -05:00
Kevin O'Connor 9e15321418 docs: Minor wording change to Example_Configs.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-21 12:20:21 -05:00
Kevin O'Connor 7202a5da8e docs: Minor wording change in Example_Configs.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-21 12:17:30 -05:00
Kevin O'Connor 74dbd8a8e4 docs: Fix Example_Configs.md list rendering 
Mkdocs doesn't support a third level of list nesting.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-21 12:14:59 -05:00
Kevin O'Connor c3baa671a5 docs: Update Example_Configs.md 
Document that spaces and special characters should not be in the
config filename.

Remove reference to step_distance and pin_map deprecated features, as
those features are now fully removed.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-21 12:04:45 -05:00
Misterke 8b0c6fcb08 bed_mesh: Report actual mesh profiles as status 
Report the actual profiles available via BED_MESH_PROFILE
via the status for use by clients.

Signed-off-by: Kurt Haenen <kurt.haenen@gmail.com>
 2022-02-16 13:42:19 -05:00
Kevin O'Connor 131cca2b51 docs: Change the klipper3d.org "language selection" icon 
Change from the "material translate icon" to the "material language
icon" for the language selection icon.  (The "material language icon"
is an alias for the "material web icon" and it seems we can't use the
alias, so we directly set the icon to "material/web".)

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-16 12:09:09 -05:00
Yifei Ding 646bb02355
docs: Fix Translation Support Script (#5263) 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2022-02-14 14:13:12 -05:00
Kevin O'Connor c78676ff5f docs: Fixes for mkdocs translation support 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-14 11:35:07 -05:00
Yifei Ding 61329049a6
docs: Mkdocs i18n support (#5072) 
Signed-off-by: Yifei DIng <yifeiding@protonmail.com>
 2022-02-14 11:29:41 -05:00
Wilhelm Schuster f0241d7dec docs: Drop duplicated firmware_retraction G-Codes section 
Signed-off-by: Wilhelm Schuster <dev@rot13.io>
 2022-02-14 11:21:22 -05:00
Kevin O'Connor 2e17519a7e extruder: Deprecate old extruder commands and shared_heater config option 
Deprecate SET_EXTRUDER_STEP_DISTANCE and SYNC_STEPPER_TO_EXTRUDER.
Recommend using SET_EXTRUDER_ROTATION_DISTANCE and
SYNC_EXTRUDER_MOTION.

Deprecate the extruder "shared_heater" option and reocmmend using
extruder_stepper config sections to obtain the same functionality.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-10 13:25:16 -05:00
Kevin O'Connor 2af8c5aa86 extruder: Add new SYNC_EXTRUDER_MOTION command 
This command is a rename of SYNC_STEPPER_TO_EXTRUDER.  This change is
in preparation for the removal of SYNC_STEPPER_TO_EXTRUDER.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-10 13:24:21 -05:00
Kevin O'Connor 9ec9742484 extruder: Add support for reversing the direction of extruder stepper movement 
Extend SET_EXTRUDER_ROTATION_DISTANCE to support reversing the
direction of extruder movement.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-10 13:24:21 -05:00
Kevin O'Connor 189188e3ca extruder: Add a SET_EXTRUDER_ROTATION_DISTANCE command 
Support altering the extruder distance using the higher-level
rotation_distance.  This is in preparation for removal of the
SET_EXTRUDER_STEP_DISTANCE command.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-10 13:24:21 -05:00
Kevin O'Connor 427f4b456e docs: Fix unescaped angle brackets in G-Codes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-01 12:19:23 -05:00
Kevin O'Connor 30be45c1ae docs: Fix link in G-Codes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-02-01 12:11:22 -05:00
Kevin O'Connor c80552f9e7 docs: Reorganize layout of G-Codes.md 
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>
 2022-02-01 11:59:55 -05:00
Kevin O'Connor 9c4172784a docs: Update Resonance_Compensation.md to recommend SET_VELOCITY_LIMIT 
It's no longer necessary to update the printer.cfg file to alter the
max_accel and square_corner_velocity parameters.  Update the
Resonance_Compensation.md document to reflect this.

Also, recommend using STEP_DELTA in the TUNING_TOWER commands.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-01-31 18:36:42 -05:00
Haxk20 15ffa85954
doc: Fix typo in Manual_Level.md (#5161) 
Just a small commit fixing a tiny typo i noticed.

Signed-off-by: Martin Botka <martin.botka@somainline.org>
 2022-01-29 18:18:03 -05:00
Kevin O'Connor 31cefe15cf docs: Improvements to RPi_microcontroller.md 
Wraps lines to 80 columns.  Only use triple backticks on multi-line
code excerpts.  Add backticks around "sudo raspi-config".  Move
"Enabling SPI" section to be near pwm and gpio configuration.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-01-28 18:27:07 -05:00
Dmitry Butyugin 40702bf9db docs: Updated simulavr building instructions 
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
 2022-01-26 18:02:24 -05:00
Yifei Ding 7d57a7c4c8
docs: Various minor fixes (#5175) 
Signed-off-by: Yifei Ding<yifeiding@protonmail.com
 2022-01-26 18:00:18 -05:00
Kevin O'Connor 02d5f9754f extruder: Support disassociating a stepper from all extruders 
Support SYNC_STEPPER_TO_EXTRUDER commands with an EXTRUDER parameter
set to an empty string.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-01-16 19:01:15 -05:00
Kevin O'Connor eb2a67cb95 extruder: Support SYNC_STEPPER_TO_EXTRUDER on extruder objects 
Refactor the extruder_stepper support so that it uses the
ExtruderStepper class defined in extruder.py.

Support the SYNC_STEPPER_TO_EXTRUDER command on steppers defined in
either extruder_stepper or extruder config sections.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-01-16 19:01:15 -05:00
Kevin O'Connor 34a1ce4837 tmc2130: Rework current selection to prefer vsense=1 
It is preferable to program the tmc drivers with an irun (or cs)
setting near 31, as otherwise the driver may have reduced microstep
precision.  It was possible for the driver to be programmed with
irun=16 or irun=17 when it could have been configured with irun=31
with vsense=1 instead.  This would occur on tmc2130/tmc2208/tmc2209
drivers for values around 0.900 to 1.000 amps (when using a typical
sense_resistor settings of 0.110 Ohms).

Change the code to prefer using vsense=1 to avoid this issue.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-01-16 19:00:00 -05:00
Tim Abraham babb067b60
neopixel: Update neopixel.py to add BRG color order (#5110) 
Add BRG color option.
Document BRG color option.

Signed-off-by: Timothy Abraham <Timothyabe93@gmail.com>
 2022-01-12 12:18:08 -05:00
Paul McGowan de366ee854
docs: Docs comma culture (#4822) 
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>
 2022-01-09 21:13:53 -05:00
Kevin O'Connor 8a3727ef74 docs: Note some BL-Touch clones do not support touch_mode in BLTouch.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2022-01-03 22:05:38 -05:00
Kevin O'Connor 608cd38de5 docs: Upgrade to mkdocs-material v8.1.3 
This version seems to fix an error in text highlighting during search.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-31 11:22:44 -05:00
Kevin O'Connor 7e4dff3b37 docs: Remove mkdocs-section-index from mkdocs-requirements.txt 
Commit bd0185cf removed the section-index plugin.  Remove it from the
build requirements as well.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-31 11:22:44 -05:00
Dmitry Butyugin 309b8e030f scripts: Migrated shaper calibration scripts to Python3 
Also updated instructions to install python3-numpy and
python3-matplotlib Python packages.

Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
 2021-12-30 18:14:53 -05:00
Yifei Ding 98af5dffe6
docs: Improve filament width sensor documentation (#5058) 
Add Filament Width Sensor to G-Codes.md

Remove Redundant Filament Width Sensor Entries

Remove Duplicate Status Reference In Hall Filament Width Sensor

Fix Indentation For Filament Width Sensors

Signed-off-by: Yifei Ding<yifeiding@protonmail.com>
 2021-12-27 12:41:31 -05:00
Yifei Ding 4d3198d44d docs: Clarify the Thickness of Paper 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-12-27 12:24:58 -05:00
Kevin O'Connor 0db696b0e9 docs: Fix hybrid_corexy typo in Config_Reference.md 
Reported by @controlflow.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-27 12:21:33 -05:00
Kevin O'Connor 8090d365f6 docs: Add stm32g0b1 to benchmarks 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-27 10:47:52 -05:00
Kevin O'Connor debcc22fc5 docs: Provide details on review process for new submissions 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-18 17:27:49 -05:00
Yifei Ding dd714fc7a1 docs: Update raspberrypi.com Links in FAQ 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-12-15 22:21:48 -05:00
Kevin O'Connor 0f3d68613d docs: Update tmc5160 stealthchop_threshold description in Config_Reference.md 
Don't recommend tuning stealthchop_threshold as it can cause issues.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-15 11:24:44 -05:00
Kevin O'Connor 323268ea02 docs: Note systemic error introduced by interpolate setting in TMC_Drivers.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-12 12:44:06 -05:00
Kevin O'Connor 37a117e64f docs: Update TMC_Drivers.md with notes on spreadCycle vs stealthChop modes 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-12 12:44:06 -05:00
Kevin O'Connor bfd098eb19 config: Remove hold_current from sample configs and sample macros 
Now that the documentation recommends that hold_current not be set,
update the example config files to not specify a hold_current.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-12 12:44:06 -05:00
Kevin O'Connor 9552f5e546 docs: Recommend that hold_current not be specified 
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>
 2021-12-12 12:44:06 -05:00
Yifei Ding bea2027869
docs: Refresh Bootloaders.md Links 
Some links are pointing to a beta bl (v0.5-beta) instead of the newest release (v0.7).

Raspberry Pi documentation had changed to adocs

Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-12-07 23:42:51 -05:00
usrhere 051133f81c
docs: fixed typo in Resonance_Compensation.md option name (#4981) 
Signed-off-by: Joseph Vilimas <4to5@protonmail.com>
 2021-12-02 18:12:15 -05:00
Kevin O'Connor fea30f8771 docs: Add a note on how to view the raw motan logs in Debugging.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-12-01 20:09:25 -05:00
Kevin O'Connor 520273e5ab stepper: Support step_pulse_duration even on TMC drivers in UART/SPI mode 
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>
 2021-11-29 16:56:29 -05:00
Nitram 54acca37ba
delta: max z-accel and speed ratio calculation for deltas (#4689) 
Adding a possibility to use a lower z- acceleration.

Signed-off-by: Martin Malmqvist <volcomosq@gmx.com>
 2021-11-29 13:21:26 -05:00
Kevin O'Connor 790d48b46c docs: Minor spelling fix to Config_Reference.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-24 11:14:26 -05:00
Yifei Ding a1af78cb83 docs: Rename Documents 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Yifei Ding 85667649d1 docs: beaglebone.md Caps and Code Fence 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Yifei Ding f80ec56486 docs: Bed_Mesh.md Fix List Nesting and Commands 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Yifei Ding fe91c0b41a docs: Benchemarks.md missing link to Features.md 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Yifei Ding f5f43d7a8c docs: Installation.md Capitalization 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Yifei Ding 054beb1918 docs: Packaging Better Hyperlink and Fix Title Cap 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Kevin O'Connor 7085ed2d6c docs: Add low-level MMIO coding hints to Code_Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-22 11:03:11 -05:00
Kevin O'Connor 326c12728c docs: Fix incorrect error description in TMC_Drivers.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-19 13:05:41 -05:00
Kevin O'Connor e772a92f16 docs: Fix spurious quote in TMC_Drivers.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-19 13:00:43 -05:00
Pedro Lamas 7ef7bf608a gcode_macro: Add "rawparams" pseudo-variable 
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
 2021-11-19 11:22:36 -05:00
Yifei Ding 08dab6f825 docs: Improve TMC_Drivers Common Error Layout 
Fixed some incorrect bold text introduced in 8f46ab27, corrected some TMC feature names.

Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-19 10:25:06 -05:00
Yifei Ding 0d0d8cbb7d docs: Re-organize Hall Filament Width Sensor Doc 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-19 10:25:06 -05:00
Yifei Ding 71ab552562 docs: skew_correction Typo and Config Highlighting 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-19 10:25:06 -05:00
Yifei Ding c0ea48a582 docs: Match Single Blank Line Above and Below A Title 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-19 10:25:06 -05:00
Yifei Ding d602177281 docs: Correct TMC_Drivers Title Nesting 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-19 10:25:06 -05:00
Yifei Ding ee04a6340a docs: Align Lists 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-19 10:25:06 -05:00
Kevin O'Connor 68c92991ed docs: Minor example change in Code_Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-16 20:33:12 -05:00
Kevin O'Connor 4861a0d958 docs: Add recommendation on Python type handling to Code_Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-16 19:27:07 -05:00
Kevin O'Connor 779793c746 docs: Update Code_Overview.md with information on get_status() 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-16 19:15:20 -05:00
Kevin O'Connor bea16c74be docs: Remove unneeded "raw" markdown tags from documentation 
The `<!-- {% raw %} -->` tags are no longer needed now that the Jekyll
package is no longer used to process the markdown documentation.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-16 11:47:59 -05:00
Kevin O'Connor d93e21fe67 docs: Expand on default_parameter_X conversion in Config_Changes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-16 11:45:30 -05:00
Geoffrey Young 5dcc377cde temperature_sensors: add ATC Semitec 104NT-4-R025H42G thermistor 
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>
 2021-11-15 23:14:32 -05:00
Kevin O'Connor cf811e52d7 docs: Update benchmarks after stepper and scheduler changes 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-15 22:56:42 -05:00
Kevin O'Connor c179db3d43 temperature_sensors: Deprecate "NTC 100K beta 3950" thermistor 
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>
 2021-11-10 18:56:51 -05:00
Kevin O'Connor 14cbc6f754 docs: Update MCU_Commands.md with new config_stepper command 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-04 12:06:27 -04:00
Kevin O'Connor 4acfd8d7c8 stepper: Make step pulse duration customizable at run-time 
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>
 2021-11-04 12:06:27 -04:00
Kevin O'Connor ffeafb690b docs: Note removal of deprecated features in Config_Changes.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-02 12:45:11 -04:00
Kevin O'Connor 1699f378de console: Remove support for PINS command 
Remove support for builtin pin aliases from the console.py tool.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-02 12:45:11 -04:00
Kevin O'Connor 5d9d91d3a6 docs: Should be "LM75" instead of "lm75" in Config_Reference.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-11-01 11:34:29 -04:00
Kevin O'Connor 86fee2d517 tmc: Track requested hold_current so SET_TMC_CURRENT doesn't reduce it 
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>
 2021-10-27 12:13:38 -04:00
Kevin O'Connor 9a0bcf21cf docs: Update mkdocs-requirements.txt 
Update mkdocs to v1.2.3 to avoid a github "dependabot" warning for
CVE-2021-40978.  (The CVE doesn't impact the klipper3d.org site, but
no harm in updating.)

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-10-15 12:24:10 -04:00
Ilia Rebane 372cd2834c
docs: Update BLTouch.md to prevent position_endstop error (#4731) 
Klipper with Fluid complains about `position_endstop` line if `endstop_pin:
probe:z_virtual_endstop` used

Signed-off-by: Ilia Rebane <Agilatosay@gmail.com>
 2021-10-15 11:55:20 -04:00
Philipp Temminghoff 64e4649877
tmc: add current values to get_status() (#4696) 
Signed-off-by: Philipp Temminghoff <philipptemminghoff@gmail.com>
 2021-10-11 12:03:08 -04:00
Rufo Sanchez b336a21fe7 button: Support half-stepping encoders 
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:
6b784cca67/Rotary.cpp (L21-L40)

Signed-off-by: Rufo Sanchez <rufo@rufosanchez.com>
 2021-10-11 11:29:53 -04:00
Dmitry Butyugin bd5dc03317 adxl345: Renamed debug commands to fix their parsing by Klipper 
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
 2021-10-06 21:16:31 -04:00
Kevin O'Connor b806d71eb0 docs: Fix link in Releases.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-29 21:43:58 -04:00
Kevin O'Connor 2a964a4614 docs: Note the release of v0.10.0 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-29 21:36:52 -04:00
Kevin O'Connor 1b166dd599 docs: Update Features.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-29 21:20:40 -04:00
Kevin O'Connor e4089e846e docs: Update CONTRIBUTING.md with new repo location; minor wording changes 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-29 21:13:08 -04:00
Yifei Ding b3b597a215 docs: add Translation Contributor Guide 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-09-29 21:05:42 -04:00
Kevin O'Connor 17dcf4e5f0 docs: Fix table rendering in RPi_microcontroller.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-29 10:56:50 -04:00
Eric Callahan 00a9e4ad9a docs: background color fix for bed_mesh svgs 
Signed-off-by:  Eric Callahan <arksine.code@gmail.com>
 2021-09-29 09:56:09 -04:00
Kevin O'Connor 0ec13bc27a docs: Change Kinematics.md images to use a solid white background 
Avoid transparent backgrounds as they don't render well if there is a
dark background.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-27 18:33:58 -04:00
Kevin O'Connor 6e87befa21 docs: Fix typo in Bed_Mesh.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-27 17:22:49 -04:00
Kevin O'Connor 44e2c630b3 docs: Update documentation with new klipper github URL 
The main code repository moved from
https://github.com/KevinOConnor/klipper.git to
https://github.com/Klipper3d/klipper.git .

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-23 19:37:27 -04:00
Kevin O'Connor 59bd51d207 avrsim: Change default speed to 16Mhz and default baud to 250K 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-16 20:11:42 -04:00
Kevin O'Connor 46167cae67 configfile: Add support for reporting deprecated options 
Add a new printer.configfile.warnings with a list of config features
that are deprecated.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-16 13:44:54 -04:00
Kevin O'Connor c84956befe heaters: Change default smooth_time from 2 seconds to 1 second 
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>
 2021-09-03 18:11:05 -04:00
Pascal af3622544d
docs: Add referenced config example for PWM tools (#4537) 
Signed-off-by: Pascal Pieper <accounts@pascalpieper.de>
 2021-09-03 18:10:09 -04:00
Kevin O'Connor 1feea0cfe8 docs: Fix typo in Measuring_Resonances.md 
Reported by @fredrikbaberg.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-09-02 12:42:45 -04:00
github@matthewlloyd.net 830c80a88a tuning_tower: Add STEP_DELTA and STEP_HEIGHT parameters as alternate tuning tower syntax 
Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
 2021-09-02 12:05:31 -04:00
github@matthewlloyd.net 286cc1becc tuning_tower: Add SKIP parameter 
Signed-off-by: Matthew Lloyd <github@matthewlloyd.net>
 2021-09-02 12:05:31 -04:00
Kevin O'Connor f11acd8065 motan: Add support for dumping and analyzing adxl345 data 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-30 12:26:39 -04:00
Kevin O'Connor 404b64fd62 adxl345: Change default chip name from "default" to "adxl345" 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-30 12:26:36 -04:00
Kevin O'Connor e03e0e9dac adxl345: Move g-code commands to new helper class 
Separate out the G-Code command handlers to a new ADXLCommandHelper()
class.  This helps separate the sensing code from the user interface
code.

Deprecate the RATE parameter of the ACCELEROMETER_MEASURE command.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-30 12:25:45 -04:00
Kevin O'Connor 1e4041a96b motan: Pass dataset parameters in parenthesis 
Replace names like "trapq:toolhead:x" with "trapq(toolhead,x)".

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-30 12:12:01 -04:00
Kevin O'Connor 5fd1c9853d tmc: Add support for a get_status() method 
Export mcu_phase_offset and drv_status information.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-30 12:00:46 -04:00
Kevin O'Connor 950477849d mcu: Support multi-mcu homing 
Support endstops and probes attached to a different micro-controller
than their associated steppers.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-28 16:08:57 -04:00
Kevin O'Connor 25e493ef75 docs: Note importance of slow extrude rate in Rotation_Distance.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-25 12:07:21 -04:00
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