aboutsummaryrefslogtreecommitdiffstats
path: root/docs
Commit message (Collapse)AuthorAgeFilesLines
* docs: Note the release of v0.12.0Kevin O'Connor2023-11-101-0/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Features.mdKevin O'Connor2023-11-101-11/+13
| | | | | | Note additional features that have been added recently. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Contact.md to note other common ways to obtain Klipper log fileKevin O'Connor2023-11-011-13/+18
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update the Contact documentKevin O'Connor2023-11-012-49/+21
| | | | | | | | | | | | | | | | | | Try to make it more clear that Discord is not Discourse, as the two similarly sounding services are often confused by users unfamiliar with them. The Klipper Discourse and Klipper Discord are available for many topics related to Klipper - reword some sections to make their use more open. Avoid referring to the Klipper github repo in this Contact document as we no longer use Klipper github issues at all. Remove the table of contents as it is largely redundant for the document. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Config_checks: Missing ! in pin inversion example in Verify endstopsTom Dunn2023-10-191-1/+1
| | | | | | | | | In the "Verify endstops" section there is an example of adding an exclamation point to the pin definition to invert its logic. I believe the intention in the example is to keep the hardware pull-up ^ and follow it with ! to invert the pin logic, but the ! is missing. Signed-off-by: Tom Dunn <thomas.dunn@gmail.com>
* docs: Fix a typo in serial bootloader entry docsAaron B. Haun2023-10-191-1/+1
| | | | Signed-off-by: Aaron B. Haun <aaron@haun.guru>
* docs: add info about requesting bootloadersAaron B. Haun2023-10-123-0/+127
| | | | Signed-off-by: Aaron B. Haun <aaron@haun.guru>
* docs: fix typo in RPi_microcontroller.mdIkko Eltociear Ashimine2023-09-291-1/+1
| | | | | | additionaly -> additionally Signed-off-by: Ikko Eltociear Ashimine <eltociear@gmail.com>
* idex_modes: Fixed the case when carriages home in the same direction (#6310)Dmitry Butyugin2023-09-292-0/+17
| | | | | | | | | | | | | | | | | | | | | Previous version of the code assumed that dual carriages home away from each other, which is not true on some machines, which have the second dual carriage homing on the first carriage. The new code correctly identifies the relative order of the carriages now. This fixes discrepancies between the documentation and the actual implementation of the carriages kinematic ranges calculation. Notes about dual_carriage homing and proximity checks changes Fixed clearing of homing state after homing in certain modes In case of multi-MCU homing it is possible that the carriage position will end up outside of the allowed motion range due to latencies in data transmission between MCUs. Selecting certain modes after homing could result in home state clearing instead of blocking the motion of the active carriage. This commit fixes this undesired behavior. Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* docs: Add Peopoly to Sponsors.mdKevin O'Connor2023-09-262-2/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* tmc2240: Adding UART interface support to tmc2240 (#6305)FrY Sennberg2023-09-101-1/+4
| | | Signed-off-by: Christoph Frei <fryakatkop@gmail.com>
* docs: Add how to configure LIS2DW instructionsbigtreetech2023-08-212-4/+45
| | | | Signed-off-by: Alan.Ma from BigTreeTech tech@biqu3d.com
* config: Add 1LC example configuration and docsWulfsta2023-08-131-0/+44
| | | | Signed-off-by: Luke Vuksta <wulfstawulfsta@gmail.com>
* docs: Update RPi_microcontroller.md (pwm-2chan) (#6304)FatalBulletHit2023-08-131-8/+26
| | | | | Added a more detailed explanation for pwm-2chan. Signed-off-by: Alfie Batthullt <FatalBulletHit@gmail.com>
* docs: Update Config_Changes.md to reflect new SKR-3 flash-sdcard naming.Donna Whisnant2023-08-111-0/+4
| | | | Signed-off-by: Donna Whisnant <dewhisna@dewtronics.com>
* heaters: adds temperature monitorsPedro Lamas2023-08-011-0/+5
| | | | Signed-off-by: Pedro Lamas <pedrolamas@gmail.com>
* temperature_combined: A class that can combine several other temperature ↵Michael Jäger2023-08-012-1/+20
| | | | | sensors (#6230) Signed-off-by: Michael Jäger <michael@mjaeger.eu>
* axis_twist_compensation: Add X twist compensation module (#6149)Philippe Daouadi2023-08-015-0/+93
| | | | | | | | | | | | Implements AxisTwistCompensation, and Calibrater Supports calibration of z-offsets caused by x gantry twist Modify PrinterProbe._probe function to check if the probed z value should be adjusted based on axis_twist_compensation's configuration Add documentation for [axis_twist_compensation] module Signed-off-by: Jeremy Tan <jeremytkw98@gmail.com>
* idex_modes: COPY and MIRROR mode implementation (#6297)Dmitry Butyugin2023-08-015-24/+89
| | | | | | | | | | | COPY and MIRROR mode implementation Correctly apply input shaper params to new dual_carriage Added SAVE_/RESTORE_IDEX_STATE commands Documentation updates for the new IDEX modes Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* screws_tilt_adjust: add max_deviation to report statusStefan Dej2023-08-011-0/+2
| | | | Signed-off-by: Stefan Dej <meteyou@gmail.com>
* docs: Update Config_checks.md (#6278)JamesH19782023-07-301-42/+36
| | | | | I am endeavoring to rewrite some of the docs to be more front end agnostic to reflect the different front ends available since these docs were written. I am starting with this one, as it quite often used. Signed-off-by: James Hartley <james@hartleyns.com>
* docs: Update Config_Reference.md - heater_fan wording (#6273)JamesH19782023-06-281-1/+1
| | | | | The reference to my_nozzle_fan is misleading and could cause people to skip over the [fan] definition and assume this is the parts/print cooling fan. Alias changed to reflect heatbreak_cooling_fan as used in most configs that have a controllable hotend fan. Signed-off-by: James Hartley <james@hartleyns.com>
* docs: Update Measuring_Resonances.md (#6234)Adam2023-06-281-4/+5
| | | | | Clarifying the ADXL345 on pi instructions. Previously, the instructions on installing the linux klipper instance were in a confusing place. Signed-off-by: Adam Kramer <akramer@gmail.com>
* docs: Improve documentation of i2c_software_scl_pin/i2c_software_sda_pinKevin O'Connor2023-06-201-8/+7
| | | | | | Reported by @rootiest Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: note rri deprecation in config_changesEric Callahan2023-06-201-0/+7
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* docs: update Bed Mesh documentationEric Callahan2023-06-202-23/+58
| | | | Signed-off-by: Eric Callahan <arksine.code@gmail.com>
* tmc: Configurable `multistep_filt`Alex Voinea2023-06-162-0/+7
| | | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>
* i2c_software: Implementation of software i2c (#6141)BIGTREETECH2023-06-071-0/+24
| | | Signed-off-by: Alan.Ma from BigTreeTech <tech@biqu3d.com>
* docs: Fix link in Sponsors.mdKevin O'Connor2023-06-051-1/+1
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update Sponsors.mdKevin O'Connor2023-06-052-0/+4
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* parsecandump: New utility to parse Klipper messages in a candump captureKevin O'Connor2023-05-301-0/+26
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Add new CANBUS_Troubleshooting.md documentKevin O'Connor2023-05-305-0/+121
| | | | | | Add information on troubleshooting canbus connections. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* Kconfig: Change default CANbus frequency to 1000000Kevin O'Connor2023-05-301-0/+6
| | | | | | | | Change the default CANbus frequency from 500000 to 1000000. A higher frequency allows for greater data transfer rates, lower latency of messages, and should overall be more robust. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Update CANBUS.mdKevin O'Connor2023-05-301-37/+44
| | | | | | | | | | | | | Recommend USB to CAN adapter and no longer recommend using the waveshare rpi hat. Recommend using allow-hotplug for all USB adapters. Note bandwidth limitations when using USB to CAN bridge mode. Note that a USB to CAN mcu is not a USB serial device. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Minor update to Config_Changes.md datesKevin O'Connor2023-05-251-2/+2
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* resonance_tester: Apply input shaper params on SHAPER_CALIBRATEDmitry Butyugin2023-05-252-1/+6
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* resonance_tester: Support CHIPS= parameter in SHAPER_CALIBRATE commandDmitry Butyugin2023-05-251-1/+1
| | | | Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
* docs: Add gcode_button to the Status Reference docs (#6201)Chris2023-05-141-0/+6
| | | | | Add gcode_button to the Status Reference docs Signed-off-by: Chris Laprade <chris@rootiest.com>
* aht10: update comments and docs for AHT20/AHT21 supportScott Mudge2023-04-241-2/+3
| | | | | The control bytes for the AHT20 and AHT21 are identical to the AHT10, but I had not been able to test just yet to ensure the sensor code supported the other sensors. I've wrapped up testing and updated the comments/docs to reflect this additional support. Signed-off-by: Scott Mudge <mail@scottmudge.com>
* docs: Update Measuring_Resonances.md (#6177)crazyroses2023-04-241-2/+2
| | | | | | Correction for table "Recommended connection scheme for I2C (i2c0a) on the RP2040", line 160, to match the correct writing in the Fritzing image shown above, RP2040 pin 36 in place of 39; Correction of typo in line 346, "pins" in place of "pin" Signed-off-by: Adrian Rose <adrian@crazyroses.net>
* docs: Update Bed_Mesh.md (#6143)jdonagher2023-04-241-1/+1
| | | | | Fix typo. Signed-off-by: John Donagher <jdonagher@gmail.com>
* docs: Fix nested list in Measuring_Resonances (#6157)Dr. Matthew Swabey2023-04-191-10/+10
| | | Signed-off-by: Matthew Swabey <matthew@swabey.org>
* docs: Add AHT10 temperature sensor doc section in Config_Reference.md ↵Scott Mudge2023-04-151-0/+23
| | | | | | | (followup #6138) (#6167) Followed general outline used by HTU21D and BME280. Signed-off-by: Scott Mudge <mail@scottmudge.com>
* docs: Fix duplicate section in Measuring_Resonaces.md (#6160)Nathan2023-04-111-27/+2
| | | | | | Removed a duplicated section in Measuring_Resonances.md. Also fixed its header level. Signed-off-by: Nathan Chiu <nhchiu2009@gmail.com>
* tmc5160: add DRV_CONF Register for TMC5160 (#6154)vcore852023-04-111-0/+4
| | | | | | | In some condition ,“drvstrength 2” does not work. According to page 17, some mosfets need “drvstrength” set to 0 . From datasheet rev1.15, the DRVSTRENGTH reset default is 0 . (instead of 2) Signed-off-by: Albert Lin <vcore85@gmail.com>
* docs: Add missing code block indicators to Slicers.md(#6161)flowerysong2023-04-111-0/+2
| | | Signed-off-by: Paul Arthur <paul.arthur@flowerysong.com>
* tmc: Support reporting tmc2240 temperature in driver get_status()Kevin O'Connor2023-04-071-0/+3
| | | | Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* serialqueue: Rename stalled_bytes stat to upcoming_bytesKevin O'Connor2023-04-071-0/+3
| | | | | | | | | The stalled_bytes counter refers to the number of bytes that are not yet eligible for transmission. However, the naming leads to confusion as it could be interpretted as an inability to transmit data. Rename to upcoming_bytes to try to avoid that confusion. Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
* docs: Measuring_Resonances.md improved information on I2C accelerometers and ↵Dr. Matthew Swabey2023-04-071-38/+161
| | | | | | | | | AVR support (#6132) More information on I2C accelerometers. Added in table of MCUs with 400kbit/s I2C support Signed-off-by: Matthew Swabey <matthew@swabey.org>
* docs: Fix typo in docs (#6147)Alex Voinea2023-03-301-1/+1
| | | Signed-off-by: Alex Voinea <voinea.dragos.alexandru@gmail.com>