Skip to content

Commit dfaca86

Browse files
faxe1008kartben
authored andcommitted
doc: hardware: peripherals: stepper: Migrate to step interval API
Migrates the peripherals documentation to the new step interval based APi instead of the velocity one. Signed-off-by: Fabian Blatz <[email protected]>
1 parent 705365c commit dfaca86

File tree

1 file changed

+2
-2
lines changed

1 file changed

+2
-2
lines changed

doc/hardware/peripherals/stepper.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,15 +12,15 @@ Configure Stepper Driver
1212
and :c:func:`stepper_get_micro_step_res`.
1313
- Configure **reference position** in microsteps using :c:func:`stepper_set_reference_position`
1414
and :c:func:`stepper_get_actual_position`.
15-
- Set **max velocity** in micro-steps per second using :c:func:`stepper_set_max_velocity`
15+
- Set **step interval** in nanoseconds between steps using :c:func:`stepper_set_microstep_interval`
1616
- **Enable** the stepper driver using :c:func:`stepper_enable`.
1717

1818
Control Stepper
1919
===============
2020

2121
- **Move by** +/- micro-steps also known as **relative movement** using :c:func:`stepper_move_by`.
2222
- **Move to** a specific position also known as **absolute movement** using :c:func:`stepper_move_to`.
23-
- Run continuously with a **constant velocity** in a specific direction until
23+
- Run continuously with a **constant step interval** in a specific direction until
2424
a stop is detected using :c:func:`stepper_run`.
2525
- Check if the stepper is **moving** using :c:func:`stepper_is_moving`.
2626
- Register an **event callback** using :c:func:`stepper_set_event_callback`.

0 commit comments

Comments
 (0)