diff --git a/docs/API_Server.md b/docs/API_Server.md index eaa5bdb9..42885f9b 100644 --- a/docs/API_Server.md +++ b/docs/API_Server.md @@ -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 timestamp from when the query was taken. -Available fields are documented in the [Status -Reference](Status_Reference.md) document. +Available fields are documented in the +[Status Reference](Status_Reference.md) document. ### objects/subscribe diff --git a/docs/Bootloaders.md b/docs/Bootloaders.md index 20b5e734..bf52794b 100644 --- a/docs/Bootloaders.md +++ b/docs/Bootloaders.md @@ -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 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 -don't have access to a STLink it is also possible to use a [Raspberry Pi and -OpenOCD](#running-openocd-on-the-raspberry-pi) with the following chip config: +don't have access to a STLink it is also possible to use a +[Raspberry Pi and OpenOCD](#running-openocd-on-the-raspberry-pi) with +the following chip config: + ``` 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). 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 -STM32F103 using stm32flash](#stm32f103-micro-controllers-blue-pill-devices). +is likely via 3.3v serial, which follows the same procedure as +[flashing the STM32F103 using stm32flash](#stm32f103-micro-controllers-blue-pill-devices). For example: ``` wget https://github.com/Arksine/STM32_HID_Bootloader/releases/download/v0.5-beta/hid_bootloader_SKR_PRO.bin diff --git a/docs/CANBUS.md b/docs/CANBUS.md index 2446c533..de652cee 100644 --- a/docs/CANBUS.md +++ b/docs/CANBUS.md @@ -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. There are currently two common options: -1. Use a [Waveshare Raspberry Pi CAN - hat](https://www.waveshare.com/rs485-can-hat.htm) or one of its - many clones. +1. Use a + [Waveshare Raspberry Pi CAN hat](https://www.waveshare.com/rs485-can-hat.htm) + or one of its many clones. 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 are many different USB to CAN adapters available - when choosing - one, we recommend verifying it can run the [candlelight - firmware](https://github.com/candle-usb/candleLight_fw). (Unfortunately, - we've found some USB adapters run defective firmware and are locked - down, so verify before purchasing.) + one, we recommend verifying it can run the + [candlelight firmware](https://github.com/candle-usb/candleLight_fw). + (Unfortunately, we've found some USB adapters run defective + firmware and are locked down, so verify before purchasing.) It is also necessary to configure the host operating system to use the adapter. This is typically done by creating a new file named @@ -37,8 +37,8 @@ iface can0 can static up ifconfig $IFACE txqueuelen 128 ``` -Note that the "Raspberry Pi CAN hat" also requires [changes to -config.txt](https://www.waveshare.com/wiki/RS485_CAN_HAT). +Note that the "Raspberry Pi CAN hat" also requires +[changes to config.txt](https://www.waveshare.com/wiki/RS485_CAN_HAT). # Terminating Resistors diff --git a/docs/Command_Templates.md b/docs/Command_Templates.md index d9533f29..0d45b7b3 100644 --- a/docs/Command_Templates.md +++ b/docs/Command_Templates.md @@ -139,8 +139,8 @@ gcode: M106 S{ printer.fan.speed * 0.9 * 255} ``` -Available fields are defined in the [Status -Reference](Status_Reference.md) document. +Available fields are defined in the +[Status Reference](Status_Reference.md) document. Important! Macros are first evaluated in entirety and only then are the resulting commands executed. If a macro issues a command that diff --git a/docs/Config_Changes.md b/docs/Config_Changes.md index 5025d9f7..15d94883 100644 --- a/docs/Config_Changes.md +++ b/docs/Config_Changes.md @@ -9,8 +9,9 @@ All dates in this document are approximate. 20210503: The gcode_macro `default_parameter_` config option is deprecated. Use the `params` pseudo-variable to access macro parameters. Other methods for accessing macro parameters will be -removed in the near future. See the [Command Templates -document](Command_Templates.md#macro-parameters) for examples. +removed in the near future. See the +[Command Templates document](Command_Templates.md#macro-parameters) +for examples. 20210430: The SET_VELOCITY_LIMIT (and M204) command may now set a 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 with CAN bus has changed. If using CAN bus then all micro-controllers -must be reflashed and the [Klipper configuration must be -updated](CANBUS.md). +must be reflashed and the +[Klipper configuration must be updated](CANBUS.md). 20210310: The TMC2660 default for driver_SFILT has been changed from 1 to 0. diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index ec48559e..e3b2b33f 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -3458,12 +3458,12 @@ text: ## [display_template] -Display data text "macros" (one may define any number of sections -with a display_template prefix). This feature allows one to reduce +Display data text "macros" (one may define any number of sections with +a display_template prefix). This feature allows one to reduce repetitive definitions in display_data sections. One may use the builtin render() function in display_data sections to evaluate a -template. For example, if one were to define [display_template -my_template] then one could use `{ render('my_template') }` in a +template. For example, if one were to define `[display_template +my_template]` then one could use `{ render('my_template') }` in a display_data section. ``` diff --git a/docs/Contact.md b/docs/Contact.md index ac27be64..a140b7a4 100644 --- a/docs/Contact.md +++ b/docs/Contact.md @@ -10,8 +10,9 @@ This document provides contact information for Klipper. # Community Forum -There is a [Klipper Community Discourse -server](https://community.klipper3d.org) for discussions on Klipper. +There is a +[Klipper Community Discourse server](https://community.klipper3d.org) +for discussions on Klipper. # Discord Chat @@ -24,18 +25,18 @@ real-time. # I have a question about Klipper -Many questions we receive are already answered in the [Klipper -documentation](Overview.md). Please be sure to to read the +Many questions we receive are already answered in the +[Klipper documentation](Overview.md). Please be sure to to read the documentation and follow the directions provided there. -It is also possible to search for similar questions in the [Klipper -Community Forum](#community-forum). +It is also possible to search for similar questions in the +[Klipper Community Forum](#community-forum). If you are interested in sharing your knowledge and experience with -other Klipper users then you can join the [Klipper Community -Forum](#community-forum) or [Klipper Discord -Chat](#discord-chat). Both are communities where Klipper users can -discuss Klipper with other users. +other Klipper users then you can join the +[Klipper Community Forum](#community-forum) or +[Klipper Discord Chat](#discord-chat). Both are communities where +Klipper users can discuss Klipper with other users. Many questions we receive are general 3d-printing questions that 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 feature. If you are interested in helping to implement or test a new -feature, you can search for ongoing developments in the [Klipper -Community Forum](#community-forum). There is also [Klipper Discord -Chat](#discord-chat) for discussions between collaborators. +feature, you can search for ongoing developments in the +[Klipper Community Forum](#community-forum). There is also +[Klipper Discord Chat](#discord-chat) for discussions between +collaborators. 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 your printer hardware. -It is also possible to search for similar issues in the [Klipper -Community Forum](#community-forum). +It is also possible to search for similar issues in the +[Klipper Community Forum](#community-forum). If you are interested in sharing your knowledge and experience with -other Klipper users then you can join the [Klipper Community -Forum](#community-forum) or [Klipper Discord -Chat](#discord-chat). Both are communities where Klipper users can -discuss Klipper with other users. +other Klipper users then you can join the +[Klipper Community Forum](#community-forum) or +[Klipper Discord Chat](#discord-chat). Both are communities where +Klipper users can discuss Klipper with other users. 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 diagnose the root cause of the problem. If you would like to share the results of your research or check if other users are - experiencing similar issues then you can search the [Klipper - Community Forum](#community-forum). + experiencing similar issues then you can search the + [Klipper Community Forum](#community-forum). 2. Make sure you are running unmodified code from [https://github.com/KevinOConnor/klipper](https://github.com/KevinOConnor/klipper). 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) for important information. -There are several [documents for -developers](Overview.md#developer-documentation). If you have -questions on the code then you can also ask in the [Klipper Community -Forum](#community-forum) or on the [Klipper Community -Discord](#discord-chat). If you would like to provide an update on -your current progress then you can open a Github issue with the -location of your code, an overview of the changes, and a description -of its current status. +There are several +[documents for developers](Overview.md#developer-documentation). If +you have questions on the code then you can also ask in the +[Klipper Community Forum](#community-forum) or on the +[Klipper Community Discord](#discord-chat). If you would like to +provide an update on your current progress then you can open a Github +issue with the location of your code, an overview of the changes, and +a description of its current status. diff --git a/docs/Example_Configs.md b/docs/Example_Configs.md index c9994a47..e5d6cc19 100644 --- a/docs/Example_Configs.md +++ b/docs/Example_Configs.md @@ -1,10 +1,10 @@ This document contains guidelines for contributing an example Klipper -configuration to the Klipper github repository (located in the [config -directory](../config/)). +configuration to the Klipper github repository (located in the +[config directory](../config/)). -Note that the [Klipper Community Discourse -server](https://community.klipper3d.org) is also a useful resource for -finding and sharing config files. +Note that the +[Klipper Community Discourse server](https://community.klipper3d.org) +is also a useful resource for finding and sharing config files. # Guidelines @@ -37,8 +37,9 @@ finding and sharing config files. track in the main Klipper repository.) Similarly, we only add example config files for printers, kits, and boards that have mainstream popularity (eg, there should be at least a 100 of them - in active use). Consider using the [Klipper Community Discourse - server](https://community.klipper3d.org) for other configs. + in active use). Consider using the + [Klipper Community Discourse server](https://community.klipper3d.org) + for other configs. 5. Only specify those devices present on the given printer or board. Do not specify settings specific to your particular setup. 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 config files are submitted by creating a github "pull -request". Please also follow the directions in the [contributing -document](CONTRIBUTING.md). +request". Please also follow the directions in the +[contributing document](CONTRIBUTING.md). diff --git a/docs/Status_Reference.md b/docs/Status_Reference.md index 169394f3..10b5b457 100644 --- a/docs/Status_Reference.md +++ b/docs/Status_Reference.md @@ -1,11 +1,12 @@ This document is a reference of printer status information that -available in Klipper [macros](Command_Templates.md), [display -fields](Config_Reference.md#display), and via the [API -Server](API_Server.md). +available in Klipper [macros](Command_Templates.md), +[display fields](Config_Reference.md#display), and via the +[API Server](API_Server.md). The fields in this document are subject to change - if using an -attribute be sure to review the [Config Changes -document](Config_Changes.md) when upgrading the Klipper software. +attribute be sure to review the +[Config Changes document](Config_Changes.md) when upgrading the +Klipper software. # bed_mesh @@ -243,12 +244,13 @@ The following information is available in the `system_stats` object # temperature sensors -The following information is available in [bme280 -config_section_name](Config_Reference.md#bmp280bme280bme680-temperature-sensor), -[htu21d config_section_name](Config_Reference.md#htu21d-sensor), [lm75 -config_section_name](Config_Reference.md#lm75-temperature-sensor), and -[temperature_host -config_section_name](Config_Reference.md#host-temperature-sensor) +The following information is available in + +[bme280 config_section_name](Config_Reference.md#bmp280bme280bme680-temperature-sensor), +[htu21d config_section_name](Config_Reference.md#htu21d-sensor), +[lm75 config_section_name](Config_Reference.md#lm75-temperature-sensor), +and +[temperature_host config_section_name](Config_Reference.md#host-temperature-sensor) objects: - `temperature`: The last read temperature from the sensor. - `humidity`, `pressure`, `gas`: The last read values from the sensor diff --git a/docs/TMC_Drivers.md b/docs/TMC_Drivers.md index 413f4ee1..cd705ae3 100644 --- a/docs/TMC_Drivers.md +++ b/docs/TMC_Drivers.md @@ -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 this document are not available. -In addition to this document, be sure to review the [TMC driver config -reference](Config_Reference.md#tmc-stepper-driver-configuration). +In addition to this document, be sure to review the +[TMC driver config reference](Config_Reference.md#tmc-stepper-driver-configuration). # Enabling "Stealthchop" mode @@ -161,9 +161,9 @@ homing_retract_dist: 0 ``` The examples above only show settings specific to sensorless -homing. See the [config -reference](Config_Reference.md#tmc-stepper-driver-configuration) for -all the available options. +homing. See the +[config reference](Config_Reference.md#tmc-stepper-driver-configuration) +for all the available options. ### Find highest sensitivity that successfully homes @@ -289,9 +289,9 @@ gcode: ``` -The resulting macro can be called from a [homing_override config -section](Config_Reference.md#homing_override) or from a [START_PRINT -macro](Slicers.md#klipper-gcode_macro). +The resulting macro can be called from a +[homing_override config section](Config_Reference.md#homing_override) +or from a [START_PRINT macro](Slicers.md#klipper-gcode_macro). Note that if the driver current during homing is changed, then the 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. All of the reported fields are defined in the Trinamic datasheet for -each driver. These datasheets can be found on the [Trinamic -website](https://www.trinamic.com/). Obtain and review the Trinamic -datasheet for the driver to interpret the results of DUMP_TMC. +each driver. These datasheets can be found on the +[Trinamic website](https://www.trinamic.com/). Obtain and review the +Trinamic datasheet for the driver to interpret the results of +DUMP_TMC. # Configuring driver_XXX settings Klipper supports configuring many low-level driver fields using -`driver_XXX` settings. The [TMC driver config -reference](Config_Reference.md#tmc-stepper-driver-configuration) has -the full list of fields available for each type of driver. +`driver_XXX` settings. The +[TMC driver config reference](Config_Reference.md#tmc-stepper-driver-configuration) +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 [SET_TMC_FIELD command](G-Codes.md#tmc-stepper-drivers). Each of these fields is defined in the Trinamic datasheet for each -driver. These datasheets can be found on the [Trinamic -website](https://www.trinamic.com/). +driver. These datasheets can be found on the +[Trinamic website](https://www.trinamic.com/). Note that the Trinamic datasheets sometime use wording that can 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? Many people successfully use "stealthchop" mode with Klipper's -pressure advance. Klipper implements [smooth pressure -advance](Kinematics.md#pressure-advance) which does not introduce any -instantaneous velocity changes. +pressure advance. Klipper implements +[smooth pressure advance](Kinematics.md#pressure-advance) which does +not introduce any instantaneous velocity changes. However, "stealthchop" mode may produce lower motor torque and/or 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 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 -[static_digital_output config -section](Config_Reference.md#static_digital_output) to set the CS pin -of the unused device high (so that it will not attempt to use the SPI -bus). The board's schematic is often a useful reference for finding -which devices are on an SPI bus and their associated pins. +[static_digital_output config section](Config_Reference.md#static_digital_output) +to set the CS pin of the unused device high (so that it will not +attempt to use the SPI bus). The board's schematic is often a useful +reference for finding which devices are on an SPI bus and their +associated pins. ## Why did I get a "TMC reports error: ..." error?