From 37b475815e07a6877ff2f99aa559a593fd050915 Mon Sep 17 00:00:00 2001 From: Kevin O'Connor Date: Fri, 20 Nov 2020 11:57:18 -0500 Subject: [PATCH] docs: Move replicape reference from generic-replicate.cfg to Config_Reference.md Signed-off-by: Kevin O'Connor --- config/generic-replicape.cfg | 31 -------------------- docs/Config_Reference.md | 57 +++++++++++++++++++++++++++++++++++- 2 files changed, 56 insertions(+), 32 deletions(-) diff --git a/config/generic-replicape.cfg b/config/generic-replicape.cfg index fe361dea..f8e3063e 100644 --- a/config/generic-replicape.cfg +++ b/config/generic-replicape.cfg @@ -20,42 +20,11 @@ pin_map: beaglebone [mcu host] serial: /tmp/klipper_host_mcu -# The "replicape" config section adds "replicape:stepper_x_enable" -# virtual stepper enable pins (for steppers x, y, z, e, and h) and -# "replicape:power_x" PWM output pins (for hotbed, e, h, fan0, fan1, -# fan2, and fan3) that may then be used elsewhere in the config file. [replicape] revision: B3 -# The replicape hardware revision. Currently only revision "B3" is -# supported. This parameter must be provided. -#enable_pin: !P9_41 -# The replicape global enable pin. The default is !P9_41. host_mcu: host -# The name of the mcu config section that communicates with the -# Klipper "linux process" mcu instance. This parameter must be -# provided. -#standstill_power_down: False -# This parameter controls the CFG6_ENN line on all stepper -# motors. True sets the enable lines to "open". The default is -# False. stepper_x_microstep_mode: spread16 -# This parameter controls the CFG1 and CFG2 pins of the given -# stepper motor driver. Available options are: disable, 1, 2, -# spread2, 4, 16, spread4, spread16, stealth4, and stealth16. The -# default is disable. stepper_x_current: 0.5 -# The configured maximum current (in Amps) of the stepper motor -# driver. This parameter must be provided if the stepper is not in a -# disable mode. -#stepper_x_chopper_off_time_high: False -# This parameter controls the CFG0 pin of the stepper motor driver -# (True sets CFG0 high, False sets it low). The default is False. -#stepper_x_chopper_hysteresis_high: False -# This parameter controls the CFG4 pin of the stepper motor driver -# (True sets CFG4 high, False sets it low). The default is False. -#stepper_x_chopper_blank_time_high: True -# This parameter controls the CFG5 pin of the stepper motor driver -# (True sets CFG5 high, False sets it low). The default is True. stepper_y_microstep_mode: spread16 stepper_y_current: 0.5 stepper_z_microstep_mode: spread16 diff --git a/docs/Config_Reference.md b/docs/Config_Reference.md index 4ef71833..d507d81a 100644 --- a/docs/Config_Reference.md +++ b/docs/Config_Reference.md @@ -3393,8 +3393,63 @@ vssa_pin: Replicape support - see the [generic-replicape.cfg](https://github.com/KevinOConnor/klipper/tree/master/config/generic-replicape.cfg) -file for further details. +file for an example. ``` +# The "replicape" config section adds "replicape:stepper_x_enable" +# virtual stepper enable pins (for steppers x, y, z, e, and h) and +# "replicape:power_x" PWM output pins (for hotbed, e, h, fan0, fan1, +# fan2, and fan3) that may then be used elsewhere in the config file. [replicape] +revision: B3 +# The replicape hardware revision. Currently only revision "B3" is +# supported. This parameter must be provided. +#enable_pin: !P9_41 +# The replicape global enable pin. The default is !P9_41. +host_mcu: host +# The name of the mcu config section that communicates with the +# Klipper "linux process" mcu instance. This parameter must be +# provided. +#standstill_power_down: False +# This parameter controls the CFG6_ENN line on all stepper +# motors. True sets the enable lines to "open". The default is +# False. +#stepper_x_microstep_mode: +#stepper_y_microstep_mode: +#stepper_z_microstep_mode: +#stepper_e_microstep_mode: +#stepper_h_microstep_mode: +# This parameter controls the CFG1 and CFG2 pins of the given +# stepper motor driver. Available options are: disable, 1, 2, +# spread2, 4, 16, spread4, spread16, stealth4, and stealth16. The +# default is disable. +#stepper_x_current: +#stepper_y_current: +#stepper_z_current: +#stepper_e_current: +#stepper_h_current: +# The configured maximum current (in Amps) of the stepper motor +# driver. This parameter must be provided if the stepper is not in a +# disable mode. +#stepper_x_chopper_off_time_high: +#stepper_y_chopper_off_time_high: +#stepper_z_chopper_off_time_high: +#stepper_e_chopper_off_time_high: +#stepper_h_chopper_off_time_high: +# This parameter controls the CFG0 pin of the stepper motor driver +# (True sets CFG0 high, False sets it low). The default is False. +#stepper_x_chopper_hysteresis_high: +#stepper_y_chopper_hysteresis_high: +#stepper_z_chopper_hysteresis_high: +#stepper_e_chopper_hysteresis_high: +#stepper_h_chopper_hysteresis_high: +# This parameter controls the CFG4 pin of the stepper motor driver +# (True sets CFG4 high, False sets it low). The default is False. +#stepper_x_chopper_blank_time_high: +#stepper_y_chopper_blank_time_high: +#stepper_z_chopper_blank_time_high: +#stepper_e_chopper_blank_time_high: +#stepper_h_chopper_blank_time_high: +# This parameter controls the CFG5 pin of the stepper motor driver +# (True sets CFG5 high, False sets it low). The default is True. ```