Skip to content

Commit 7537a14

Browse files
faxe1008kartben
authored andcommitted
doc: migration-guide-4.1: Add section about step interval based API
Adds a two bullet points explaining the change of the velocity based API towards an step interval one. Signed-off-by: Fabian Blatz <[email protected]>
1 parent dfaca86 commit 7537a14

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

doc/releases/migration-guide-4.1.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -263,10 +263,17 @@ Stepper
263263
* Renamed the ``compatible`` from ``zephyr,gpio-steppers`` to :dtcompatible:`zephyr,gpio-stepper`.
264264
* Renamed the ``stepper_set_actual_position`` function to :c:func:`stepper_set_reference_position`.
265265
* Renamed the ``stepper_enable_constant_velocity_mode`` function to :c:func:`stepper_run`.
266+
The function does not take a velocity parameter anymore. Set the desired speed using the
267+
:c:func:`stepper_set_microstep_interval` function beforehand.
266268
* Renamed the ``stepper_move`` function to :c:func:`stepper_move_by`.
267269
* Renamed the ``stepper_set_target_position`` function to :c:func:`stepper_move_to`.
270+
* Renamed the ``stepper_set_max_velocity`` function to :c:func:`stepper_set_microstep_interval`.
271+
The function now takes the step interval in nanoseconds. This allows for a more precise control.
272+
* Deprecating setting max velocity via :c:func:`stepper_run`.
268273
* The :kconfig:option:`STEPPER_ADI_TMC_RAMP_GEN` is now deprecated and is replaced with the new
269274
:kconfig:option:`STEPPER_ADI_TMC5041_RAMP_GEN` option.
275+
* To control the velocity for :dtcompatible:`adi,tmc5041` stepper driver, use
276+
:c:func:`tmc5041_stepper_set_max_velocity` or :c:func:`tmc5041_stepper_set_ramp`.
270277

271278
SPI
272279
===

0 commit comments

Comments
 (0)