Commit Graph

898 Commits

Author SHA1 Message Date
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