Commit 32390d55 authored by Fabian Blatz's avatar Fabian Blatz Committed by Carles Cufi
Browse files

doc: stepper: Add Stepper motor controller documentation 



Added stepper motor controller documentation entry to peripherals.

Signed-off-by: default avatarFabian Blatz <fabianblatz@gmail.com>
Signed-off-by: default avatarJilay Pandya <jilay.pandya@zeiss.com>
parent 4f36fa80

doc/hardware/peripherals/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -55,6 +55,7 @@ Peripherals 
   sdhc.rst

   sensor/index.rst

   spi.rst

   stepper.rst

   smbus.rst

   uart.rst

   usbc_vbus.rst

doc/hardware/peripherals/stepper.rst

0 → 100644
+24 −0
Original line number Diff line number Diff line 
.. _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

CRA Git | Maintained and supported by SUSTech CRA and CCSE