Druk-3D/klipper
1
0
Fork 0
mirror of https://github.com/Klipper3d/klipper.git synced 2025-10-31 10:25:57 +01:00
Code Issues Packages Projects Releases Wiki Activity
5,378 Commits 7 Branches 14 Tags
cb15d0fec69317ed2023dd8aad19f749f527fe77
Commit Graph

56 Commits

Author SHA1 Message Date
Kevin O'Connor
b09897245e docs: Add a new Eddy_Probe.md document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2024-04-09 16:32:43 -04:00
Aaron B. Haun
ecc9bbf52a docs: add info about requesting bootloaders 
Signed-off-by: Aaron B. Haun <aaron@haun.guru>
 2023-10-12 20:53:31 -04:00
Philippe Daouadi
039daecb4f axis_twist_compensation: Add X twist compensation module (#6149) 
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>
 2023-08-01 13:08:53 -04:00
Kevin O'Connor
14ff50c94d docs: Add new CANBUS_Troubleshooting.md document 
Add information on troubleshooting canbus connections.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2023-05-30 20:16:28 -04:00
Thijs Triemstra
848a78d1a5 docs: Fix typos (#6032) 
Signed-off-by: Thijs Triemstra <info@collab.nl>
 2023-02-20 11:06:25 -05:00
Frank Tackitt
638cd4d781 docs: add exclude_object documentation 
Also include sample macros to add M486 compatibility.

Signed-off-by: Franklyn Tackitt <git@frank.af>
Co-authored-by: Troy Jacobson <troy.d.jacobson@gmail.com>
 2022-06-03 14:12:04 -04:00
Yifei Ding
a1af78cb83 docs: Rename Documents 
Signed-off-by: Yifei Ding <yifeiding@protonmail.com>
 2021-11-22 21:03:32 -05:00
Kevin O'Connor
950477849d mcu: Support multi-mcu homing 
Support endstops and probes attached to a different micro-controller
than their associated steppers.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-28 16:08:57 -04:00
Kevin O'Connor
bd0185cf75 docs: Don't use section-index plugin during klipper3d.org site generation 
The section-index plugin can cause some confusing navigation.  Use the
simpler site navigation for now.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-08-17 19:39:23 -04:00
Damien
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
Kevin O'Connor
af7f27542f docs: Move status field reference to new Status_Reference.md file 
Move the reference of "printer" status fields from
Command_Templates.md to a new Status_Reference.md file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-04-28 20:32:00 -04:00
Pascal P
88f6061cd7 output_pin: Support setting max_duration (#3995) 
Also added documentation for using powered tools.

Signed-off-by: Pascal Pieper <accounts@pascalpieper.de>
 2021-03-26 11:25:09 -04:00
Kevin O'Connor
905e49cc05 docs: Move Example_Configs.md reference in Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-03-22 22:12:26 -04:00
Kevin O'Connor
8524188203 docs: Add Example_Configs.md - info on adding new config files to Klipper 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-03-22 21:21:56 -04:00
Kevin O'Connor
c7dc3e78bf docs: Update CAN bus documents 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-03-13 11:33:56 -05:00
Kevin O'Connor
6cb419a90a canbus: Rework CAN command protocol 
Rework the micro-controller command protocol so that it supports
direct communication with the serialqueue.c code.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-03-13 11:29:41 -05:00
Kevin O'Connor
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
03b62ca04f docs: Add SDCard_Updates.md to Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-02-10 13:00:57 -05:00
Kevin O'Connor
c9420ee3c0 docs: Add a link in Overview.md to Bed_Mesh.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2021-01-24 10:47:15 -05:00
Kevin O'Connor
5b31080e77 docs: Add a Rotation_Distance.md document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2020-12-18 10:30:32 -05:00
Kevin O'Connor
15b5dbaf8f docs: Move config reference information to new Config_Reference.md 
Move all the config reference information from files in the config/
directory to a new Config_Reference.md document.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2020-11-18 20:10:21 -05:00
Kevin O'Connor
bfcd5536fc docs: Add initial API_Server.md document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2020-10-17 10:41:14 -04:00
Kevin O'Connor
a87e5616a0 docs: Add Measuring_Resonances.md to Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2020-10-16 21:32:33 -04:00
Kevin O'Connor
605c32fc98 docs: Move and reword the Resonance_Compensation.md link in Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2020-08-05 23:28:54 -04:00
Kevin O'Connor
d33a34614f docs: Add RPi_microcontroller.md link in Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2020-08-01 13:09:09 -04:00
Dmitry Butyugin
f3b980c1b2 docs: Suggested improvements to Input Shaper tuning guide 
Signed-off-by: Dmitry Butyugin <dmbutyugin@google.com>
 2020-07-29 21:28:18 -04:00
test3210-d
9a65a4569b hall_filament_width_sensor: Add new filament sensor 
Signed-off-by: Denis Ignatenko <deniss979@gmail.com>
 2020-02-14 13:14:34 -05:00
Kevin O'Connor
f07292084b docs: Remove outdated stm32f1.md document 
The stm32f103 has become popular in the "skr mini" series of boards.
As a result, the stm32f1.md document is no longer relevant.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-10-23 18:53:11 -04:00
Kevin O'Connor
d9d94c858a docs: Add skew_correction.md to Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-06-27 09:50:17 -04:00
Kevin O'Connor
94c1ad7241 docs: Add an initial Command_Templates.md document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-06-04 09:50:30 -04:00
Kevin O'Connor
64e7235e48 docs: Rewrite the Overview.md - just list documents by category 
Replace the Overview.md document description with a list of documents
and a brief description of their contents.  The goal is to make it
easier for users to find information.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-04-16 20:45:00 -04:00
Kevin O'Connor
8bc9f39c58 docs: Avoid using .. in markdown links 
Using .. in the markdown link can confuse some document processors.
Use an absolute link to github instead.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-04-14 21:12:21 -04:00
Kevin O'Connor
312cabc3f7 docs: Move benchmark information from Debugging.md to new Benchmarks.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-03-28 09:52:06 -04:00
Kevin O'Connor
31987c7bcd docs: Add a Manual_Probe.md document 
Add information on calibrating the bed on traditional printers with a
Z endstop and bed screws.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-02-24 00:49:47 -05:00
Kevin O'Connor
57e6acbc5c docs: Add Bed_Level.md and Probe_Calibrate.md documents 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-02-12 13:20:32 -05:00
Kevin O'Connor
f2f54290e8 docs: Add a new Config_Changes.md document 
Add a document to track non-backwards compatible changes to the
printer config file.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2019-01-07 20:00:44 -05:00
Kevin O'Connor
057acb07b7 docs: Add a Slicers.md document 
Add some information on configuring a slicer for use with Klipper.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-10-28 10:47:32 -04:00
Kevin O'Connor
0079311b0b docs: Add an Endstop_Phase.md document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-10-16 13:09:49 -04:00
Kevin O'Connor
4b5db04f78 docs: Add Delta_Calibrate.md guide with "enhanced delta calibration" 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-09-25 13:48:46 -04:00
Kevin O'Connor
3d4ee9e962 docs: Add stm32f1.md link to Overview.md 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-09-20 20:11:04 -04:00
Kevin O'Connor
3f59c3dd48 docs: Add a Bootloaders.md document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-08-08 20:47:04 -04:00
Kevin O'Connor
09a64d24f1 docs: Remove the Todo.md file 
The Todo.md file has gotten stale, and it is no longer an effective
mechanism for tracking changes.  Remove it.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-07-26 12:51:01 -04:00
Kevin O'Connor
05ec7ca7ff docs: Add a G-Codes.md file with the list of available commands 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2018-03-08 14:11:20 -05:00
Kevin O'Connor
1bdebeaebf docs: Add an initial configuration checklist document 
Provide a document with basic steps that a user can run to verify that
the pins in the configuration file are set correctly.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-12-26 20:54:37 -05:00
Kevin O'Connor
37788c1e55 docs: Add a FAQ document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-11-30 15:19:40 -05:00
Kevin O'Connor
ce7cc798dc docs: Add Contact.md file with developer contact information 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-10-10 12:43:44 -04:00
Kevin O'Connor
a7f339ad1c docs: Improve documentation for those starting in docs/ 
Those that reach Klipper via github may jump directly to the docs/
directory in search of documentation.  Add README.md and rework
Overview.md with that in mind.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-04-27 16:05:26 -04:00
Kevin O'Connor
c1c0b2dd38 docs: Avoid using "firmware" in the documentation 
The term "firmware" is ambiguous - it could refer to the entire
project (host and micro-controller software) or to just the
micro-controller software.  Avoid the term in the documentation.

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-04-27 15:59:33 -04:00
Kevin O'Connor
db5b5f121c docs: Add initial Pressure Advance tuning document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-04-19 16:02:11 -04:00
Kevin O'Connor
2cce67ad84 docs: Add initial Kinematics document 
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
 2017-04-15 22:26:03 -04:00