Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update steppers.md #536

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions docs/config/steppers.md
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,28 @@ Single value, type: `integer`. Default: `0`
Minimum possible position. Negative values are left of the home
position.

### relative_positions:

One or more sub-entries. Each in the format of `number` (will be
converted to floating point) : `string`

This is a sub-section mapping of relative stepper increments to MPF event names (as opposed to absolute rotational positions).
For example:

``` mpf-config
#! steppers:
#! my_stepper:
#! number: 1
relative_positions:
50: advance_50 # positive values move the stepper in the direction of the `homing_direction`
-50: move_back_50 # Negative positions move the stepper opposite of the `homing_direction`
```

The values in this `relative_positions:` list represent MPF events that,
when posted, tell this stepper to increment a certain number of "steps". So, in the
example above, when the *advance_50* event is posted, this stepper will
advance 50 steps or increments from where it is currently. Positive relative positions always advance in the direction that is defined in `homing_direction`. Negative relative positions move in the opposite direction.

### reset_events:

List of one (or more) device control events
Expand Down