Stepper Motor Controller Interface . More...

Enumerations
enum	micro_step_resolution { STEPPER_FULL_STEP = 1 , STEPPER_MICRO_STEP_2 = 2 , STEPPER_MICRO_STEP_4 = 4 , STEPPER_MICRO_STEP_8 = 8 , STEPPER_MICRO_STEP_16 = 16 , STEPPER_MICRO_STEP_32 = 32 , STEPPER_MICRO_STEP_64 = 64 , STEPPER_MICRO_STEP_128 = 128 , STEPPER_MICRO_STEP_256 = 256 }
	Stepper Motor micro step resolution options. More...

enum	stepper_direction { STEPPER_DIRECTION_POSITIVE = 0 , STEPPER_DIRECTION_NEGATIVE }
	Stepper Motor direction options. More...

enum	stepper_run_mode { STEPPER_HOLD_MODE = 0 , STEPPER_POSITION_MODE , STEPPER_VELOCITY_MODE }
	Stepper Motor run mode options. More...

enum	stepper_signal_result { STEPPER_SIGNAL_STEPS_COMPLETED = 0 }
	Stepper Motor signal results. More...

Functions
int	stepper_enable (const struct device *dev, const bool enable)
	Enable or Disable Motor Controller.

int	stepper_move (const struct device dev, int32_t micro_steps, struct k_poll_signal async)
	Set the micro_steps to be moved from the current position i.e.

int	stepper_set_max_velocity (const struct device *dev, uint32_t micro_steps_per_second)
	Set the target velocity to be reached by the motor.

int	stepper_set_micro_step_res (const struct device *dev, enum micro_step_resolution resolution)
	Set the microstep resolution in stepper motor controller.

int	stepper_get_micro_step_res (const struct device dev, enum micro_step_resolution resolution)
	Get the microstep resolution in stepper motor controller.

int	stepper_set_actual_position (const struct device *dev, int32_t value)
	Set the actual a.k.a reference position of the stepper.

int	stepper_get_actual_position (const struct device dev, int32_t value)
	Get the actual a.k.a reference position of the stepper.

int	stepper_set_target_position (const struct device dev, int32_t value, struct k_poll_signal async)
	Set the absolute target position of the stepper.

int	stepper_is_moving (const struct device dev, bool is_moving)
	Check if the stepper motor is currently moving.

int	stepper_enable_constant_velocity_mode (const struct device *dev, enum stepper_direction direction, uint32_t value)
	Enable constant velocity mode for the stepper with a given velocity.

Detailed Description

Stepper Motor Controller Interface .

Enumeration Type Documentation

◆ micro_step_resolution

enum micro_step_resolution

#include <zephyr/drivers/stepper.h>

Stepper Motor micro step resolution options.

Enumerator
STEPPER_FULL_STEP	Full step resolution.
STEPPER_MICRO_STEP_2	2 micro steps per full step
STEPPER_MICRO_STEP_4	4 micro steps per full step
STEPPER_MICRO_STEP_8	8 micro steps per full step
STEPPER_MICRO_STEP_16	16 micro steps per full step
STEPPER_MICRO_STEP_32	32 micro steps per full step
STEPPER_MICRO_STEP_64	64 micro steps per full step
STEPPER_MICRO_STEP_128	128 micro steps per full step
STEPPER_MICRO_STEP_256	256 micro steps per full step

◆ stepper_direction

enum stepper_direction

#include <zephyr/drivers/stepper.h>

Stepper Motor direction options.

Enumerator
STEPPER_DIRECTION_POSITIVE	Positive direction.
STEPPER_DIRECTION_NEGATIVE	Negative direction.

◆ stepper_run_mode

enum stepper_run_mode

#include <zephyr/drivers/stepper.h>

Stepper Motor run mode options.

Enumerator
STEPPER_HOLD_MODE	Hold Mode.
STEPPER_POSITION_MODE	Position Mode.
STEPPER_VELOCITY_MODE	Velocity Mode.

◆ stepper_signal_result

enum stepper_signal_result

#include <zephyr/drivers/stepper.h>

Stepper Motor signal results.

Enumerator
STEPPER_SIGNAL_STEPS_COMPLETED	Steps set using move or set_target_position have been executed.

Function Documentation

◆ stepper_enable()

int stepper_enable	(	const struct device *	dev,
		const bool	enable )

#include <zephyr/drivers/stepper.h>

Enable or Disable Motor Controller.

Parameters

dev	pointer to the stepper motor controller instance
enable	Input enable or disable motor controller

Return values

-EIO	Error during Enabling
0	Success

◆ stepper_enable_constant_velocity_mode()

int stepper_enable_constant_velocity_mode	(	const struct device *	dev,
		enum stepper_direction	direction,
		uint32_t	value )

#include <zephyr/drivers/stepper.h>

Enable constant velocity mode for the stepper with a given velocity.

activate constant velocity mode with the given velocity in micro_steps_per_second. If velocity > 0, motor shall be set into motion and run incessantly until and unless stalled or stopped using some other command, for instance, motor_enable(false).

Parameters

dev	pointer to the stepper motor controller instance
direction	The direction to set
value	The velocity to set in steps per second where one step is dependent on the current microstepping resolution: ‍0: Enable constant velocity mode with the given velocity in a given direction 0: Disable constant velocity mode

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
0	Success

◆ stepper_get_actual_position()

int stepper_get_actual_position	(	const struct device *	dev,
		int32_t *	value )

#include <zephyr/drivers/stepper.h>

Get the actual a.k.a reference position of the stepper.

Parameters

dev	pointer to the stepper motor controller instance
value	The actual position to get in micro_steps

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
0	Success

◆ stepper_get_micro_step_res()

int stepper_get_micro_step_res	(	const struct device *	dev,
		enum micro_step_resolution *	resolution )

#include <zephyr/drivers/stepper.h>

Get the microstep resolution in stepper motor controller.

Parameters

dev	pointer to the stepper motor controller instance
resolution	microstep resolution

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
0	Success

◆ stepper_is_moving()

int stepper_is_moving	(	const struct device *	dev,
		bool *	is_moving )

#include <zephyr/drivers/stepper.h>

Check if the stepper motor is currently moving.

Parameters

dev	pointer to the stepper motor controller instance
is_moving	Pointer to a boolean to store the moving status of the stepper motor

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
0	Success

◆ stepper_move()

int stepper_move	(	const struct device *	dev,
		int32_t	micro_steps,
		struct k_poll_signal *	async )

#include <zephyr/drivers/stepper.h>

Set the micro_steps to be moved from the current position i.e.

relative movement

Parameters

dev	pointer to the stepper motor controller instance
micro_steps	target micro_steps to be moved from the current position
async	Pointer to a valid and ready to be signaled struct k_poll_signal. (Note: if NULL this function will not notify the end of the transaction, and whether it went successfully or not).

Return values

-EIO	General input / output error
0	Success

◆ stepper_set_actual_position()

int stepper_set_actual_position	(	const struct device *	dev,
		int32_t	value )

#include <zephyr/drivers/stepper.h>

Set the actual a.k.a reference position of the stepper.

Parameters

dev	Pointer to the stepper motor controller instance.
value	The reference position to set in micro-steps.

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
0	Success

◆ stepper_set_max_velocity()

int stepper_set_max_velocity	(	const struct device *	dev,
		uint32_t	micro_steps_per_second )

#include <zephyr/drivers/stepper.h>

Set the target velocity to be reached by the motor.

For controllers such as DRV8825 where you toggle the STEP Pin, the pulse_length would have to be calculated based on this parameter in the driver. For controllers where velocity can be set, this parameter corresponds to max_velocity

Note: Setting max velocity does not set the motor into motion, a combination of set_max_velocity and move is required to set the motor into motion.

Parameters

dev	pointer to the stepper motor controller instance
micro_steps_per_second	speed in micro_steps per second

Return values

-EIO	General input / output error
-EINVAL	If the requested velocity is not supported
0	Success

◆ stepper_set_micro_step_res()

int stepper_set_micro_step_res	(	const struct device *	dev,
		enum micro_step_resolution	resolution )

#include <zephyr/drivers/stepper.h>

Set the microstep resolution in stepper motor controller.

Parameters

dev	pointer to the stepper motor controller instance
resolution	microstep resolution

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
-ENOTSUP	If the requested resolution is not supported
0	Success

◆ stepper_set_target_position()

int stepper_set_target_position	(	const struct device *	dev,
		int32_t	value,
		struct k_poll_signal *	async )

#include <zephyr/drivers/stepper.h>

Set the absolute target position of the stepper.

Parameters

dev	pointer to the stepper motor controller instance
value	target position to set in micro_steps
async	Pointer to a valid and ready to be signaled struct k_poll_signal. If changing the target position triggers stepper movement, this can be used to await the end of the transaction. (Note: can be left NULL)

Return values

-EIO	General input / output error
-ENOSYS	If not implemented by device driver
0	Success

Enumerations

Functions

Detailed Description

Enumeration Type Documentation

◆ micro_step_resolution

◆ stepper_direction

◆ stepper_run_mode

◆ stepper_signal_result

Function Documentation

◆ stepper_enable()

◆ stepper_enable_constant_velocity_mode()

◆ stepper_get_actual_position()

◆ stepper_get_micro_step_res()

◆ stepper_is_moving()

◆ stepper_move()

◆ stepper_set_actual_position()

◆ stepper_set_max_velocity()

◆ stepper_set_micro_step_res()

◆ stepper_set_target_position()