stepper.h File Reference

Main header file for stepper driver API. More...

#include <zephyr/kernel.h>
#include <zephyr/device.h>
#include <errno.h>
#include <zephyr/syscalls/stepper.h>

Go to the source code of this file.

Macros
#define	MICRO_STEP_RES_INDEX(res)
	Macro to calculate the index of the microstep resolution.
#define	VALID_MICRO_STEP_RES(res)

Enumerations
enum	stepper_micro_step_resolution {   STEPPER_MICRO_STEP_1 = 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_NEGATIVE = 0 , STEPPER_DIRECTION_POSITIVE = 1 }
	Stepper Motor direction options. More...
enum	stepper_run_mode { STEPPER_RUN_MODE_HOLD = 0 , STEPPER_RUN_MODE_POSITION = 1 , STEPPER_RUN_MODE_VELOCITY = 2 }
	Stepper Motor run mode options. More...
enum	stepper_event {   STEPPER_EVENT_STEPS_COMPLETED = 0 , STEPPER_EVENT_STALL_DETECTED = 1 , STEPPER_EVENT_LEFT_END_STOP_DETECTED = 2 , STEPPER_EVENT_RIGHT_END_STOP_DETECTED = 3 ,   STEPPER_EVENT_STOPPED = 4 , STEPPER_EVENT_FAULT_DETECTED = 5 }
	Stepper Events. More...

Functions
int	stepper_enable (const struct device *dev)
	Enable stepper driver.
int	stepper_disable (const struct device *dev)
	Disable stepper driver.
int	stepper_set_micro_step_res (const struct device *dev, enum stepper_micro_step_resolution resolution)
	Set the micro-step resolution in stepper driver.
int	stepper_get_micro_step_res (const struct device *dev, enum stepper_micro_step_resolution *resolution)
	Get the micro-step resolution in stepper driver.
int	stepper_set_reference_position (const struct device *dev, int32_t value)
	Set the reference position of the stepper.
int	stepper_get_actual_position (const struct device *dev, int32_t *value)
	Get the actual step count for a given stepper.
int	stepper_set_event_callback (const struct device *dev, stepper_event_callback_t callback, void *user_data)
	Set the callback function to be called when a stepper event occurs.
int	stepper_set_microstep_interval (const struct device *dev, uint64_t microstep_interval_ns)
	Set the time interval between steps in nanoseconds with immediate effect.
int	stepper_move_by (const struct device *dev, int32_t micro_steps)
	Set the micro-steps to be moved from the current position i.e.
int	stepper_move_to (const struct device *dev, int32_t micro_steps)
	Set the absolute target position of the stepper.
int	stepper_run (const struct device *dev, enum stepper_direction direction)
	Run the stepper with a given step interval in a given direction.
int	stepper_stop (const struct device *dev)
	Stop the stepper.
int	stepper_is_moving (const struct device *dev, bool *is_moving)
	Check if the stepper is currently moving.

Detailed Description

Main header file for stepper driver API.