michaelh/zephyr
1
0
Fork 0
Code Releases Activity

doc: stepper: Add Stepper motor controller documentation

Browse source 
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>
This commit is contained in:
Fabian Blatz 2024-08-07 09:49:47 +02:00 • committed by Carles Cufí
commit 32390d55ab
2 changed files with 25 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

1
doc/hardware/peripherals/index.rst
View file

@ -55,6 +55,7 @@ Peripherals
sdhc.rst sdhc.rst
sensor/index.rst sensor/index.rst
spi.rst spi.rst
stepper.rst
smbus.rst smbus.rst
uart.rst uart.rst
usbc_vbus.rst usbc_vbus.rst

24
doc/hardware/peripherals/stepper.rst Normal file
View file

@ -0,0 +1,24 @@
.. _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