michaelh/zephyr
1
0
Fork 0
Code Releases Activity

drivers: stepper: refactor set_actual_position to set_reference_position

Browse source 
This commit refactos set_actual_position to set_reference_position.
stepper_set_reference_position is more apt in regards to what this func
actually does

Signed-off-by: Jilay Pandya <jilay.pandya@outlook.com>
This commit is contained in:
Jilay Pandya 2024-11-24 17:14:38 +01:00 • committed by Benjamin Cabé
commit 719cd2639c
10 changed files with 35 additions and 32 deletions
Download patch file Download diff file Expand all files Collapse all files

2
doc/hardware/peripherals/stepper.rst
View file

@ -10,7 +10,7 @@ Configure Stepper Driver
- Configure **micro-stepping resolution** using :c:func:`stepper_set_micro_step_res`
and :c:func:`stepper_get_micro_step_res`.
- Configure **actual position a.k.a step count** in microsteps using :c:func:`stepper_set_actual_position`
- Configure **reference position** in microsteps using :c:func:`stepper_set_reference_position`
and :c:func:`stepper_get_actual_position`.
- Set **max velocity** in micro-steps per second using :c:func:`stepper_set_max_velocity`
- **Enable** the stepper driver using :c:func:`stepper_enable`.

1
doc/releases/migration-guide-4.1.rst
View file

@ -117,6 +117,7 @@ Stepper
=======
* Renamed the ``compatible`` from ``zephyr,gpio-steppers`` to :dtcompatible:`zephyr,gpio-stepper`.
* Renamed the ``stepper_set_actual_position`` function to :c:func:`stepper_set_reference_position`.
Regulator
=========