Commit Graph

870 Commits

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