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
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
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
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
d602177281
docs: Correct TMC_Drivers Title Nesting
...
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
2021-11-19 10:25:06 -05:00
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
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
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
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
977c334e2e
docs: Avoid link descriptions that span multiple lines
...
The Jekyll markdown renderer gets confused by links that span multiple
lines.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-05-28 20:58:32 -04:00
a58e9eddbe
docs: Note stealthchop can cause overcurrent error in TMC_Drivers.md
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-04-24 12:30:27 -04:00
a0307c0e1c
docs: Fix Jekyll rendering of docs/TMC_Drivers.md
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-25 12:24:45 -04:00
5c2c43b05f
docs: Revise sensorless homing configuration guide
...
Recommend finding the minimum and maximum stallguard settings while
tuning sensorless homing.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-25 12:21:13 -04:00
c8dc3afc23
docs: Update TMC_Drivers.md with note on SPI failures on TMC driver checks
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-16 14:49:29 -04:00
0ddd6e8d21
docs: Add common reasons for tmc error reports to TMC_Drivers.md
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-16 12:14:45 -04:00
11b9b72b41
docs: Minor wording change to TMC_Drivers.md
...
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-11 17:57:18 -05:00
715b89ce0c
docs: Rename Sensorless_homing.md to TMC_Drivers.md and extend
...
Add additional information on configuring and using TMC drivers.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
2021-03-10 20:09:34 -05:00
Kevin O'Connor
Yifei Ding
Damien