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
05330fd3e5
docs: Minor updates to SmartEffector docs
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-04-09 19:10:16 -04:00
2060a6908f
smart_effector: Config and command reference
...
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2022-04-09 19:04:57 -04:00
f3b995227a
docster: Fix incorrect default value for max_freq
2022-04-09 16:31:23 -04:00
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
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
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
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
f0700c0985
pca9632: Support using hardware I2C
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-04-07 11:43:52 -04:00
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
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
444d209cce
_klipper3d: Remove translation stubs
...
Support for language translations on the klipper3d.org site was
disabled in commit c067d4df
2022-04-06 19:04:48 -04:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
02d770ae3c
neopixel: add BGR for neopixel ( #5160 )
...
Signed-off-by: Thomas Liebold <electron2410@gmail.com>
2022-03-14 12:30:58 -04:00
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
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
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
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
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
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
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
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
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
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
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
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
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
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
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
646bb02355
docs: Fix Translation Support Script ( #5263 )
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2022-02-14 14:13:12 -05:00
c78676ff5f
docs: Fixes for mkdocs translation support
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2022-02-14 11:35:07 -05:00
61329049a6
docs: Mkdocs i18n support ( #5072 )
...
Signed-off-by: Yifei DIng <yifeiding@protonmail.com>
2022-02-14 11:29:41 -05:00
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
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
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
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
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
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
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
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
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
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
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
40702bf9db
docs: Updated simulavr building instructions
...
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
2022-01-26 18:02:24 -05:00
7d57a7c4c8
docs: Various minor fixes ( #5175 )
...
Signed-off-by: Yifei Ding<yifeiding@protonmail.com
2022-01-26 18:00:18 -05:00
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
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
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
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
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
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
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
7e4dff3b37
docs: Remove mkdocs-section-index from mkdocs-requirements.txt
...
Commit bd0185cf
2021-12-31 11:22:44 -05:00
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
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
4d3198d44d
docs: Clarify the Thickness of Paper
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-12-27 12:24:58 -05:00
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
8090d365f6
docs: Add stm32g0b1 to benchmarks
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-12-27 10:47:52 -05:00
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
dd714fc7a1
docs: Update raspberrypi.com Links in FAQ
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-12-15 22:21:48 -05:00
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
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
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
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
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
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
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
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
520273e5ab
stepper: Support step_pulse_duration even on TMC drivers in UART/SPI mode
...
Commit 689231df
2021-11-29 16:56:29 -05:00
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
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
a1af78cb83
docs: Rename Documents
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-22 21:03:32 -05:00
85667649d1
docs: beaglebone.md Caps and Code Fence
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-22 21:03:32 -05:00
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
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
f5f43d7a8c
docs: Installation.md Capitalization
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-22 21:03:32 -05:00
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
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
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
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
7ef7bf608a
gcode_macro: Add "rawparams" pseudo-variable
...
Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
2021-11-19 11:22:36 -05:00
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
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
71ab552562
docs: skew_correction Typo and Config Highlighting
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-19 10:25:06 -05:00
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
Kevin O'Connor
Dmitry Butyugin
cbc02009
Yifei Ding
Charles Pickering
Ricardo Alcântara
electron2410
Fritz Webering
Pedro Lamas
Misterke
Wilhelm Schuster
Haxk20
Tim Abraham
Paul McGowan
usrhere
Nitram