3diy
/
klipper
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Kevin O'Connor 2021-05-28 20:58:32 -04:00
parent 624d94f6ac
commit 977c334e2e
10 changed files with 107 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/API_Server.md
View File

@ -204,8 +204,8 @@ object name and the value is a dictionary containing its fields. The
response message will also contain an "eventtime" field containing the response message will also contain an "eventtime" field containing the
timestamp from when the query was taken. timestamp from when the query was taken.
Available fields are documented in the [Status Available fields are documented in the
Reference](Status_Reference.md) document. [Status Reference](Status_Reference.md) document.
### objects/subscribe ### objects/subscribe

10
docs/Bootloaders.md
View File

@ -313,8 +313,10 @@ section above, substituting the file name for the desired hid bootloader binary
It is not possible to use stm32flash for the SKR Mini E3 as the boot0 pin is It is not possible to use stm32flash for the SKR Mini E3 as the boot0 pin is
tied directly to ground and not broken out via header pins. It is recommended tied directly to ground and not broken out via header pins. It is recommended
to use a STLink V2 with STM32Cubeprogrammer to flash the bootloader. If you to use a STLink V2 with STM32Cubeprogrammer to flash the bootloader. If you
don't have access to a STLink it is also possible to use a [Raspberry Pi and don't have access to a STLink it is also possible to use a
OpenOCD](#running-openocd-on-the-raspberry-pi) with the following chip config: [Raspberry Pi and OpenOCD](#running-openocd-on-the-raspberry-pi) with
the following chip config:
``` ```
source [find target/stm32f1x.cfg] source [find target/stm32f1x.cfg]
``` ```
@ -398,8 +400,8 @@ board, a [build for the SKR Pro 1.1 is available here](
https://github.com/Arksine/STM32_HID_Bootloader/releases/tag/v0.5-beta). https://github.com/Arksine/STM32_HID_Bootloader/releases/tag/v0.5-beta).
Unless your board is DFU capable the most accessable flashing method Unless your board is DFU capable the most accessable flashing method
is likely via 3.3v serial, which follows the same procedure as [flashing the is likely via 3.3v serial, which follows the same procedure as
STM32F103 using stm32flash](#stm32f103-micro-controllers-blue-pill-devices). [flashing the STM32F103 using stm32flash](#stm32f103-micro-controllers-blue-pill-devices).
For example: For example:
``` ```
wget https://github.com/Arksine/STM32_HID_Bootloader/releases/download/v0.5-beta/hid_bootloader_SKR_PRO.bin wget https://github.com/Arksine/STM32_HID_Bootloader/releases/download/v0.5-beta/hid_bootloader_SKR_PRO.bin

18
docs/CANBUS.md
View File

@ -15,17 +15,17 @@ and flash it to the target board.
In order to use a CAN bus, it is necessary to have a host adapter. In order to use a CAN bus, it is necessary to have a host adapter.
There are currently two common options: There are currently two common options:
1. Use a [Waveshare Raspberry Pi CAN 1. Use a
hat](https://www.waveshare.com/rs485-can-hat.htm) or one of its [Waveshare Raspberry Pi CAN hat](https://www.waveshare.com/rs485-can-hat.htm)
many clones. or one of its many clones.
2. Use a USB CAN adapter (for example 2. Use a USB CAN adapter (for example
[https://hacker-gadgets.com/product/cantact-usb-can-adapter/](https://hacker-gadgets.com/product/cantact-usb-can-adapter/)). There [https://hacker-gadgets.com/product/cantact-usb-can-adapter/](https://hacker-gadgets.com/product/cantact-usb-can-adapter/)). There
are many different USB to CAN adapters available - when choosing are many different USB to CAN adapters available - when choosing
one, we recommend verifying it can run the [candlelight one, we recommend verifying it can run the
firmware](https://github.com/candle-usb/candleLight_fw). (Unfortunately, [candlelight firmware](https://github.com/candle-usb/candleLight_fw).
we've found some USB adapters run defective firmware and are locked (Unfortunately, we've found some USB adapters run defective
down, so verify before purchasing.) firmware and are locked down, so verify before purchasing.)
It is also necessary to configure the host operating system to use the It is also necessary to configure the host operating system to use the
adapter. This is typically done by creating a new file named adapter. This is typically done by creating a new file named
@ -37,8 +37,8 @@ iface can0 can static
up ifconfig $IFACE txqueuelen 128 up ifconfig $IFACE txqueuelen 128
``` ```
Note that the "Raspberry Pi CAN hat" also requires [changes to Note that the "Raspberry Pi CAN hat" also requires
config.txt](https://www.waveshare.com/wiki/RS485_CAN_HAT). [changes to config.txt](https://www.waveshare.com/wiki/RS485_CAN_HAT).
# Terminating Resistors # Terminating Resistors

4
docs/Command_Templates.md
View File

@ -139,8 +139,8 @@ gcode:
M106 S{ printer.fan.speed * 0.9 * 255} M106 S{ printer.fan.speed * 0.9 * 255}
``` ```
Available fields are defined in the [Status Available fields are defined in the
Reference](Status_Reference.md) document. [Status Reference](Status_Reference.md) document.
Important! Macros are first evaluated in entirety and only then are Important! Macros are first evaluated in entirety and only then are
the resulting commands executed. If a macro issues a command that the resulting commands executed. If a macro issues a command that

9
docs/Config_Changes.md
View File

@ -9,8 +9,9 @@ All dates in this document are approximate.
20210503: The gcode_macro `default_parameter_<name>` config option is 20210503: The gcode_macro `default_parameter_<name>` config option is
deprecated. Use the `params` pseudo-variable to access macro deprecated. Use the `params` pseudo-variable to access macro
parameters. Other methods for accessing macro parameters will be parameters. Other methods for accessing macro parameters will be
removed in the near future. See the [Command Templates removed in the near future. See the
document](Command_Templates.md#macro-parameters) for examples. [Command Templates document](Command_Templates.md#macro-parameters)
for examples.
20210430: The SET_VELOCITY_LIMIT (and M204) command may now set a 20210430: The SET_VELOCITY_LIMIT (and M204) command may now set a
velocity, acceleration, and square_corner_velocity larger than the velocity, acceleration, and square_corner_velocity larger than the
@ -23,8 +24,8 @@ config option will be removed in the near future.
20210313: Klipper's support for micro-controllers that communicate 20210313: Klipper's support for micro-controllers that communicate
with CAN bus has changed. If using CAN bus then all micro-controllers with CAN bus has changed. If using CAN bus then all micro-controllers
must be reflashed and the [Klipper configuration must be must be reflashed and the
updated](CANBUS.md). [Klipper configuration must be updated](CANBUS.md).
20210310: The TMC2660 default for driver_SFILT has been changed from 1 20210310: The TMC2660 default for driver_SFILT has been changed from 1
to 0. to 0.

8
docs/Config_Reference.md
View File

@ -3458,12 +3458,12 @@ text:
## [display_template] ## [display_template]
Display data text "macros" (one may define any number of sections Display data text "macros" (one may define any number of sections with
with a display_template prefix). This feature allows one to reduce a display_template prefix). This feature allows one to reduce
repetitive definitions in display_data sections. One may use the repetitive definitions in display_data sections. One may use the
builtin render() function in display_data sections to evaluate a builtin render() function in display_data sections to evaluate a
template. For example, if one were to define [display_template template. For example, if one were to define `[display_template
my_template] then one could use `{ render('my_template') }` in a my_template]` then one could use `{ render('my_template') }` in a
display_data section. display_data section.
``` ```

60
docs/Contact.md
View File

@ -10,8 +10,9 @@ This document provides contact information for Klipper.
# Community Forum # Community Forum
There is a [Klipper Community Discourse There is a
server](https://community.klipper3d.org) for discussions on Klipper. [Klipper Community Discourse server](https://community.klipper3d.org)
for discussions on Klipper.
# Discord Chat # Discord Chat
@ -24,18 +25,18 @@ real-time.
# I have a question about Klipper # I have a question about Klipper
Many questions we receive are already answered in the [Klipper Many questions we receive are already answered in the
documentation](Overview.md). Please be sure to to read the [Klipper documentation](Overview.md). Please be sure to to read the
documentation and follow the directions provided there. documentation and follow the directions provided there.
It is also possible to search for similar questions in the [Klipper It is also possible to search for similar questions in the
Community Forum](#community-forum). [Klipper Community Forum](#community-forum).
If you are interested in sharing your knowledge and experience with If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the [Klipper Community other Klipper users then you can join the
Forum](#community-forum) or [Klipper Discord [Klipper Community Forum](#community-forum) or
Chat](#discord-chat). Both are communities where Klipper users can [Klipper Discord Chat](#discord-chat). Both are communities where
discuss Klipper with other users. Klipper users can discuss Klipper with other users.
Many questions we receive are general 3d-printing questions that are Many questions we receive are general 3d-printing questions that are
not specific to Klipper. If you have a general question or are not specific to Klipper. If you have a general question or are
@ -49,9 +50,10 @@ Do not open a Klipper github issue to ask a question.
All new features require someone interested and able to implement that All new features require someone interested and able to implement that
feature. If you are interested in helping to implement or test a new feature. If you are interested in helping to implement or test a new
feature, you can search for ongoing developments in the [Klipper feature, you can search for ongoing developments in the
Community Forum](#community-forum). There is also [Klipper Discord [Klipper Community Forum](#community-forum). There is also
Chat](#discord-chat) for discussions between collaborators. [Klipper Discord Chat](#discord-chat) for discussions between
collaborators.
Do not open a Klipper github issue to request a feature. Do not open a Klipper github issue to request a feature.
@ -75,14 +77,14 @@ the printer hardware then you will likely get a better response by
searching in a general 3d-printing forum or in a forum dedicated to searching in a general 3d-printing forum or in a forum dedicated to
your printer hardware. your printer hardware.
It is also possible to search for similar issues in the [Klipper It is also possible to search for similar issues in the
Community Forum](#community-forum). [Klipper Community Forum](#community-forum).
If you are interested in sharing your knowledge and experience with If you are interested in sharing your knowledge and experience with
other Klipper users then you can join the [Klipper Community other Klipper users then you can join the
Forum](#community-forum) or [Klipper Discord [Klipper Community Forum](#community-forum) or
Chat](#discord-chat). Both are communities where Klipper users can [Klipper Discord Chat](#discord-chat). Both are communities where
discuss Klipper with other users. Klipper users can discuss Klipper with other users.
Do not open a Klipper github issue to request help. Do not open a Klipper github issue to request help.
@ -99,8 +101,8 @@ bug. Please follow these steps:
someone interested and able will need to first research and someone interested and able will need to first research and
diagnose the root cause of the problem. If you would like to share diagnose the root cause of the problem. If you would like to share
the results of your research or check if other users are the results of your research or check if other users are
experiencing similar issues then you can search the [Klipper experiencing similar issues then you can search the
Community Forum](#community-forum). [Klipper Community Forum](#community-forum).
2. Make sure you are running unmodified code from 2. Make sure you are running unmodified code from
[https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper). [https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper).
If the code has been modified or is obtained from another source, If the code has been modified or is obtained from another source,
@ -151,11 +153,11 @@ New contributions (for both code and documentation) are submitted via
Github Pull Requests. See the [CONTRIBUTING document](CONTRIBUTING.md) Github Pull Requests. See the [CONTRIBUTING document](CONTRIBUTING.md)
for important information. for important information.
There are several [documents for There are several
developers](Overview.md#developer-documentation). If you have [documents for developers](Overview.md#developer-documentation). If
questions on the code then you can also ask in the [Klipper Community you have questions on the code then you can also ask in the
Forum](#community-forum) or on the [Klipper Community [Klipper Community Forum](#community-forum) or on the
Discord](#discord-chat). If you would like to provide an update on [Klipper Community Discord](#discord-chat). If you would like to
your current progress then you can open a Github issue with the provide an update on your current progress then you can open a Github
location of your code, an overview of the changes, and a description issue with the location of your code, an overview of the changes, and
of its current status. a description of its current status.

19
docs/Example_Configs.md
View File

@ -1,10 +1,10 @@
This document contains guidelines for contributing an example Klipper This document contains guidelines for contributing an example Klipper
configuration to the Klipper github repository (located in the [config configuration to the Klipper github repository (located in the
directory](../config/)). [config directory](../config/)).
Note that the [Klipper Community Discourse Note that the
server](https://community.klipper3d.org) is also a useful resource for [Klipper Community Discourse server](https://community.klipper3d.org)
finding and sharing config files. is also a useful resource for finding and sharing config files.
# Guidelines # Guidelines
@ -37,8 +37,9 @@ finding and sharing config files.
track in the main Klipper repository.) Similarly, we only add track in the main Klipper repository.) Similarly, we only add
example config files for printers, kits, and boards that have example config files for printers, kits, and boards that have
mainstream popularity (eg, there should be at least a 100 of them mainstream popularity (eg, there should be at least a 100 of them
in active use). Consider using the [Klipper Community Discourse in active use). Consider using the
server](https://community.klipper3d.org) for other configs. [Klipper Community Discourse server](https://community.klipper3d.org)
for other configs.
5. Only specify those devices present on the given printer or board. 5. Only specify those devices present on the given printer or board.
Do not specify settings specific to your particular setup. Do not specify settings specific to your particular setup.
1. For `generic` config files, only those devices on the mainboard 1. For `generic` config files, only those devices on the mainboard
@ -97,5 +98,5 @@ finding and sharing config files.
example there should not be a `force_move` config section. example there should not be a `force_move` config section.
Example config files are submitted by creating a github "pull Example config files are submitted by creating a github "pull
request". Please also follow the directions in the [contributing request". Please also follow the directions in the
document](CONTRIBUTING.md). [contributing document](CONTRIBUTING.md).

24
docs/Status_Reference.md
View File

@ -1,11 +1,12 @@
This document is a reference of printer status information that This document is a reference of printer status information that
available in Klipper [macros](Command_Templates.md), [display available in Klipper [macros](Command_Templates.md),
fields](Config_Reference.md#display), and via the [API [display fields](Config_Reference.md#display), and via the
Server](API_Server.md). [API Server](API_Server.md).
The fields in this document are subject to change - if using an The fields in this document are subject to change - if using an
attribute be sure to review the [Config Changes attribute be sure to review the
document](Config_Changes.md) when upgrading the Klipper software. [Config Changes document](Config_Changes.md) when upgrading the
Klipper software.
# bed_mesh # bed_mesh
@ -243,12 +244,13 @@ The following information is available in the `system_stats` object
# temperature sensors # temperature sensors
The following information is available in [bme280 The following information is available in
config_section_name](Config_Reference.md#bmp280bme280bme680-temperature-sensor),
[htu21d config_section_name](Config_Reference.md#htu21d-sensor), [lm75 [bme280 config_section_name](Config_Reference.md#bmp280bme280bme680-temperature-sensor),
config_section_name](Config_Reference.md#lm75-temperature-sensor), and [htu21d config_section_name](Config_Reference.md#htu21d-sensor),
[temperature_host [lm75 config_section_name](Config_Reference.md#lm75-temperature-sensor),
config_section_name](Config_Reference.md#host-temperature-sensor) and
[temperature_host config_section_name](Config_Reference.md#host-temperature-sensor)
objects: objects:
- `temperature`: The last read temperature from the sensor. - `temperature`: The last read temperature from the sensor.
- `humidity`, `pressure`, `gas`: The last read values from the sensor - `humidity`, `pressure`, `gas`: The last read values from the sensor

49
docs/TMC_Drivers.md
View File

@ -6,8 +6,8 @@ However, when the drivers are in this mode, no special Klipper
configuration is needed and the advanced Klipper features discussed in configuration is needed and the advanced Klipper features discussed in
this document are not available. this document are not available.
In addition to this document, be sure to review the [TMC driver config In addition to this document, be sure to review the
reference](Config_Reference.md#tmc-stepper-driver-configuration). [TMC driver config reference](Config_Reference.md#tmc-stepper-driver-configuration).
# Enabling "Stealthchop" mode # Enabling "Stealthchop" mode
@ -161,9 +161,9 @@ homing_retract_dist: 0
``` ```
The examples above only show settings specific to sensorless The examples above only show settings specific to sensorless
homing. See the [config homing. See the
reference](Config_Reference.md#tmc-stepper-driver-configuration) for [config reference](Config_Reference.md#tmc-stepper-driver-configuration)
all the available options. for all the available options.
### Find highest sensitivity that successfully homes ### Find highest sensitivity that successfully homes
@ -289,9 +289,9 @@ gcode:
``` ```
<!-- {% endraw %} --> <!-- {% endraw %} -->
The resulting macro can be called from a [homing_override config The resulting macro can be called from a
section](Config_Reference.md#homing_override) or from a [START_PRINT [homing_override config section](Config_Reference.md#homing_override)
macro](Slicers.md#klipper-gcode_macro). or from a [START_PRINT macro](Slicers.md#klipper-gcode_macro).
Note that if the driver current during homing is changed, then the Note that if the driver current during homing is changed, then the
tuning process should be run again. tuning process should be run again.
@ -327,23 +327,24 @@ fields configured by Klipper as well as all fields that can be queried
from the driver. from the driver.
All of the reported fields are defined in the Trinamic datasheet for All of the reported fields are defined in the Trinamic datasheet for
each driver. These datasheets can be found on the [Trinamic each driver. These datasheets can be found on the
website](https://www.trinamic.com/). Obtain and review the Trinamic [Trinamic website](https://www.trinamic.com/). Obtain and review the
datasheet for the driver to interpret the results of DUMP_TMC. Trinamic datasheet for the driver to interpret the results of
DUMP_TMC.
# Configuring driver_XXX settings # Configuring driver_XXX settings
Klipper supports configuring many low-level driver fields using Klipper supports configuring many low-level driver fields using
`driver_XXX` settings. The [TMC driver config `driver_XXX` settings. The
reference](Config_Reference.md#tmc-stepper-driver-configuration) has [TMC driver config reference](Config_Reference.md#tmc-stepper-driver-configuration)
the full list of fields available for each type of driver. has the full list of fields available for each type of driver.
In addition, almost all fields can be modified at run-time using the In addition, almost all fields can be modified at run-time using the
[SET_TMC_FIELD command](G-Codes.md#tmc-stepper-drivers). [SET_TMC_FIELD command](G-Codes.md#tmc-stepper-drivers).
Each of these fields is defined in the Trinamic datasheet for each Each of these fields is defined in the Trinamic datasheet for each
driver. These datasheets can be found on the [Trinamic driver. These datasheets can be found on the
website](https://www.trinamic.com/). [Trinamic website](https://www.trinamic.com/).
Note that the Trinamic datasheets sometime use wording that can Note that the Trinamic datasheets sometime use wording that can
confuse a high-level setting (such as "hysteresis end") with a confuse a high-level setting (such as "hysteresis end") with a
@ -359,9 +360,9 @@ high-level value of 0.
## Can I use stealthchop mode on an extruder with pressure advance? ## Can I use stealthchop mode on an extruder with pressure advance?
Many people successfully use "stealthchop" mode with Klipper's Many people successfully use "stealthchop" mode with Klipper's
pressure advance. Klipper implements [smooth pressure pressure advance. Klipper implements
advance](Kinematics.md#pressure-advance) which does not introduce any [smooth pressure advance](Kinematics.md#pressure-advance) which does
instantaneous velocity changes. not introduce any instantaneous velocity changes.
However, "stealthchop" mode may produce lower motor torque and/or However, "stealthchop" mode may produce lower motor torque and/or
produce higher motor heat. It may or may not be an adequate mode for produce higher motor heat. It may or may not be an adequate mode for
@ -398,11 +399,11 @@ Klipper. If a device on a shared SPI bus is not configured, then it
may incorrectly respond to commands not intended for it and corrupt may incorrectly respond to commands not intended for it and corrupt
the communication to the intended device. If there is a device on a the communication to the intended device. If there is a device on a
shared SPI bus that can not be configured in Klipper, then use a shared SPI bus that can not be configured in Klipper, then use a
[static_digital_output config [static_digital_output config section](Config_Reference.md#static_digital_output)
section](Config_Reference.md#static_digital_output) to set the CS pin to set the CS pin of the unused device high (so that it will not
of the unused device high (so that it will not attempt to use the SPI attempt to use the SPI bus). The board's schematic is often a useful
bus). The board's schematic is often a useful reference for finding reference for finding which devices are on an SPI bus and their
which devices are on an SPI bus and their associated pins. associated pins.
## Why did I get a "TMC reports error: ..." error? ## Why did I get a "TMC reports error: ..." error?