diff options
| author | Kevin O'Connor <kevin@koconnor.net> | 2017-08-25 23:14:44 -0400 |
|---|---|---|
| committer | Kevin O'Connor <kevin@koconnor.net> | 2017-08-26 18:27:21 -0400 |
| commit | 80dc1dfcc16753802c80603f3f21b175dbe48608 (patch) | |
| tree | cb3c27b7dc01441e51237203bcda6c42a9223b8b /docs | |
| parent | 931811ab59d5aa1960a42e7a5a772e82111b17a2 (diff) | |
| download | kutter-80dc1dfcc16753802c80603f3f21b175dbe48608.tar.gz kutter-80dc1dfcc16753802c80603f3f21b175dbe48608.tar.xz kutter-80dc1dfcc16753802c80603f3f21b175dbe48608.zip | |
docs: Remove documentation for "custom" command blocks
It should no longer be necessary to configure "custom" commands during
mcu setup. The ad5206 and static_digital_output config sections
should provide similar functionality.
Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/MCU_Commands.md | 17 | ||||
| -rw-r--r-- | docs/Todo.md | 6 |
2 files changed, 3 insertions, 20 deletions
diff --git a/docs/MCU_Commands.md b/docs/MCU_Commands.md index 6cfadd89..c2f1e306 100644 --- a/docs/MCU_Commands.md +++ b/docs/MCU_Commands.md @@ -4,10 +4,8 @@ by the Klipper micro-controller software. This document is not an authoritative reference for these commands, nor is it an exclusive list of all available commands. -This document may be useful for users needing to configure a set of -hardware actions that their printer may require at startup (via the -"custom" field in the printer config file), and it may be useful for -developers wishing to obtain a high-level feel for low-level commands. +This document may be useful for developers interested in understanding +the low-level micro-controller commands. See the [protocol](Protocol.md) document for more information on the format of commands and their transmission. The commands here are @@ -25,22 +23,13 @@ commands available for that purpose. Unlike most micro-controller commands, these commands run as soon as they are received and they do not require any particular setup. -These commands are most useful in the "custom" block of the "mcu" -section of the printer configuration file. This feature is typically -used to configure the initial settings of LEDs, to configure -micro-stepping pins, to configure a digipot, etc. - Several of these commands will take a "pin=%u" parameter. The low-level micro-controller software uses integer encodings of the hardware pin numbers, but to make things more readable the host will translate human readable pin names (eg, "PA3") to their equivalent integer encodings. By convention, any parameter named "pin" or that has a "_pin" suffix will use pin name translation by the -host. Similarly, several commands take time parameters specified in -clock ticks. One can specify a value for these parameters in seconds -using the "TICKS()" macro - for example "cycle_ticks=TICKS(0.001)" -would result in "cycle_ticks=16000" on a micro-controller with a 16Mhz -clock. +host. Common startup commands: diff --git a/docs/Todo.md b/docs/Todo.md index b9621567..7e938c9f 100644 --- a/docs/Todo.md +++ b/docs/Todo.md @@ -19,12 +19,6 @@ Host user interaction can issue commands that potentially move the head past position_min/position_max. -* Remove the "custom" block from the mcu section of the config and add - support for config sections to define CPU cooling fans, default LED - settings, stepper micro-controller pins, and digipot settings. It is - more user friendly to configure the printer via additional config - sections than via low-level micro-controller commands. - * Improve logging: * Possibly collate and report the statistics messages in the log in a |