aboutsummaryrefslogtreecommitdiffstats
path: root/docs/TMC_Drivers.md
Commit message (Collapse)AuthorAgeFilesLines
* docs: Reorganize layout of G-Codes.mdKevin O'Connor2022-02-011-6/+6
| | | | | | | 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>
* docs: Note systemic error introduced by interpolate setting in TMC_Drivers.mdKevin O'Connor2021-12-121-0/+27
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update TMC_Drivers.md with notes on spreadCycle vs stealthChop modesKevin O'Connor2021-12-121-1/+14
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* config: Remove hold_current from sample configs and sample macrosKevin O'Connor2021-12-121-7/+4
| | | | | | | 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>
* docs: Recommend that hold_current not be specifiedKevin O'Connor2021-12-121-0/+47
| | | | | | | 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>
* docs: Fix incorrect error description in TMC_Drivers.mdKevin O'Connor2021-11-191-9/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix spurious quote in TMC_Drivers.mdKevin O'Connor2021-11-191-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Improve TMC_Drivers Common Error LayoutYifei Ding2021-11-191-25/+26
| | | | | | Fixed some incorrect bold text introduced in 8f46ab27, corrected some TMC feature names. Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* docs: Correct TMC_Drivers Title NestingYifei Ding2021-11-191-10/+14
| | | | Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
* docs: Remove unneeded "raw" markdown tags from documentationKevin O'Connor2021-11-161-2/+0
| | | | | | | 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>
* docs : make modifications to all md files to make them compatible with mkdocsDamien2021-07-271-19/+21
| | | | | | | | all markdown files must have a single H1 heading at the top. Signed-off-by: Damien Martin <damlobster@gmail.com> Update CNAME
* docs: Note previous firmware state issue with TMC2209/TMC2209 in TMC_Drivers.mdKevin O'Connor2021-06-121-0/+6
| | | | | | | | | | | 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>
* docs: Recommend pause of 2 seconds during sensorless homingKevin O'Connor2021-06-121-13/+17
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Avoid link descriptions that span multiple linesKevin O'Connor2021-05-281-24/+25
| | | | | | | The Jekyll markdown renderer gets confused by links that span multiple lines. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Note stealthchop can cause overcurrent error in TMC_Drivers.mdKevin O'Connor2021-04-241-0/+7
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Fix Jekyll rendering of docs/TMC_Drivers.mdKevin O'Connor2021-03-251-0/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Revise sensorless homing configuration guideKevin O'Connor2021-03-251-99/+227
| | | | | | | Recommend finding the minimum and maximum stallguard settings while tuning sensorless homing. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update TMC_Drivers.md with note on SPI failures on TMC driver checksKevin O'Connor2021-03-161-0/+9
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add common reasons for tmc error reports to TMC_Drivers.mdKevin O'Connor2021-03-161-0/+29
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor wording change to TMC_Drivers.mdKevin O'Connor2021-03-111-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Rename Sensorless_homing.md to TMC_Drivers.md and extendKevin O'Connor2021-03-101-0/+282
Add additional information on configuring and using TMC drivers. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>