zephyr/doc/hardware/peripherals/stepper.rst
Fabian Blatz 32390d55ab doc: stepper: Add Stepper motor controller documentation
Added stepper motor controller documentation entry to peripherals.

Signed-off-by: Fabian Blatz <fabianblatz@gmail.com>
Signed-off-by: Jilay Pandya <jilay.pandya@zeiss.com>
2024-08-27 12:43:39 +02:00

24 lines
571 B
ReStructuredText

.. _stepper_api:
Stepper API
###########
Overview
********
The Stepper API provides a set of functions for controlling and configuring stepper motors.
It supports a variety of operations, including enabling/disabling the controller, setting the
target position of the motor and thereby setting the motor in motion, setting/getting the actual
position of the motor and so on.
Configuration Options
*********************
Related configuration options:
* :kconfig:option:`CONFIG_STEPPER_INIT_PRIORITY`
API Reference
*************
.. doxygengroup:: stepper_interface