Driver Operations Stepper Motion Controller driver operations More...

#include <zephyr/drivers/stepper/stepper_ctrl.h>

Data Fields
stepper_ctrl_set_reference_position_t	set_reference_position
	OPT Set the reference position.
stepper_ctrl_get_actual_position_t	get_actual_position
	OPT Get the actual step count.
stepper_ctrl_set_event_cb_t	set_event_cb
	OPT Set the callback function to be called when a stepper motion controller event occurs.
stepper_ctrl_set_microstep_interval_t	set_microstep_interval
	OPT Set the time interval between steps in nanoseconds with immediate effect.
stepper_ctrl_configure_ramp_t	configure_ramp
	OPT Configure the ramp for the stepper motion controller.
stepper_ctrl_move_by_t	move_by
	REQ Set the micro-steps to be moved from the current position i.e.
stepper_ctrl_move_to_t	move_to
	REQ Set the absolute target position of the stepper.
stepper_ctrl_run_t	run
	OPT Run the stepper with a given step interval in a given direction.
stepper_ctrl_stop_t	stop
	OPT Stop the stepper.
stepper_ctrl_is_moving_t	is_moving
	OPT Check if the stepper is currently moving.

Detailed Description

Driver Operations Stepper Motion Controller driver operations

This is the driver API structure any Stepper Motion Controller driver needs to define. It contains function pointers to the operations the driver implements, as well as any other driver-specific constant data.

Members marked with REQ MUST be set by the driver, whereas those marked with OPT are optional.

See also: DEVICE_DT_INST_DEFINE(); DEVICE_DT_DEFINE(); DEVICE_API()

Field Documentation

◆ configure_ramp

stepper_ctrl_configure_ramp_t stepper_ctrl_driver_api::configure_ramp

OPT Configure the ramp for the stepper motion controller.

◆ get_actual_position

stepper_ctrl_get_actual_position_t stepper_ctrl_driver_api::get_actual_position

OPT Get the actual step count.

◆ is_moving

stepper_ctrl_is_moving_t stepper_ctrl_driver_api::is_moving

OPT Check if the stepper is currently moving.

◆ move_by

stepper_ctrl_move_by_t stepper_ctrl_driver_api::move_by

REQ Set the micro-steps to be moved from the current position i.e.

◆ move_to

stepper_ctrl_move_to_t stepper_ctrl_driver_api::move_to

REQ Set the absolute target position of the stepper.

◆ run

stepper_ctrl_run_t stepper_ctrl_driver_api::run

OPT Run the stepper with a given step interval in a given direction.

◆ set_event_cb

stepper_ctrl_set_event_cb_t stepper_ctrl_driver_api::set_event_cb

OPT Set the callback function to be called when a stepper motion controller event occurs.

◆ set_microstep_interval

stepper_ctrl_set_microstep_interval_t stepper_ctrl_driver_api::set_microstep_interval

OPT Set the time interval between steps in nanoseconds with immediate effect.

◆ set_reference_position

stepper_ctrl_set_reference_position_t stepper_ctrl_driver_api::set_reference_position

OPT Set the reference position.

◆ stop

stepper_ctrl_stop_t stepper_ctrl_driver_api::stop

OPT Stop the stepper.

The documentation for this struct was generated from the following file:

zephyr/drivers/stepper/stepper_ctrl.h

Data Fields