endstop_phase: Obtain phases directly from stepper microsteps config

Signed-off-by: Kevin O'Connor <kevin@koconnor.net>
This commit is contained in:
Kevin O'Connor 2020-01-05 20:42:34 -05:00
parent 7dcc778b6c
commit 96eba9f2df
6 changed files with 62 additions and 54 deletions

View file

@ -6,6 +6,11 @@ All dates in this document are approximate.
# Changes
20201218: The `endstop_phase` setting in the endstop_phase module has
been replaced with `trigger_phase`. If using the endstop phases module
then it will be necessary to recalibrate any endstop phases by running
the ENDSTOP_PHASE_CALIBRATE command.
20201218: Rotary delta and polar printers must now specify a
`gear_ratio` for their rotary steppers, and they may no longer specify
a `step_distance` parameter. See the

View file

@ -1112,21 +1112,17 @@ for additional information.
```
[endstop_phase stepper_z]
#phases:
# This specifies the number of phases of the given stepper motor
# driver (which is the number of micro-steps multiplied by four).
# This setting is automatically determined if one uses a TMC driver
# with run-time configuration. Otherwise, this parameter must be
# provided.
#endstop_accuracy:
# Sets the expected accuracy (in mm) of the endstop. This represents
# the maximum error distance the endstop may trigger (eg, if an
# endstop may occasionally trigger 100um early or up to 100um late
# then set this to 0.200 for 200um). The default is
# phases*step_distance.
#endstop_phase:
# 4*rotation_distance/full_steps_per_rotation.
#trigger_phase:
# This specifies the phase of the stepper motor driver to expect
# when hitting the endstop. Only set this value if one is sure the
# when hitting the endstop. It is composed of two numbers separated
# by a forward slash character - the phase and the total number of
# phases (eg, "7/64"). Only set this value if one is sure the
# stepper motor driver is reset every time the mcu is reset. If this
# is not set, then the stepper phase will be detected on the first
# home and that phase will be used on all subsequent homes.

View file

@ -121,6 +121,6 @@ Additional notes
will arrange for the micro-controller to always be reset via a USB
power reset, which would arrange for both the micro-controller and
stepper motor drivers to be reset together. If using this mechanism,
one would then need to manually configure the "endstop_phase" config
one would then need to manually configure the "trigger_phase" config
sections (see [config reference](Config_Reference.md#endstop_phase)
for the details).