stepper_driver_api Struct Reference

@driver_ops{Stepper Hardware Driver} More...

#include <stepper.h>

Data Fields
stepper_enable_t	enable
	@driver_ops_mandatory Enable stepper hardware driver.
stepper_disable_t	disable
	@driver_ops_mandatory Disable stepper hardware driver.
stepper_set_micro_step_res_t	set_micro_step_res
	@driver_ops_mandatory Set the micro-step resolution in stepper hardware driver.
stepper_get_micro_step_res_t	get_micro_step_res
	@driver_ops_mandatory Get the micro-step resolution in stepper hardware driver.
stepper_set_event_cb_t	set_event_cb
	@driver_ops_optional Set the callback function to be called when a stepper_event occurs.

Detailed Description

@driver_ops{Stepper Hardware Driver}

Field Documentation

disable

stepper_disable_t stepper_driver_api::disable

@driver_ops_mandatory Disable stepper hardware driver.

enable

stepper_enable_t stepper_driver_api::enable

@driver_ops_mandatory Enable stepper hardware driver.

get_micro_step_res

stepper_get_micro_step_res_t stepper_driver_api::get_micro_step_res

@driver_ops_mandatory Get the micro-step resolution in stepper hardware driver.

set_event_cb

stepper_set_event_cb_t stepper_driver_api::set_event_cb

@driver_ops_optional Set the callback function to be called when a stepper_event occurs.

set_micro_step_res

stepper_set_micro_step_res_t stepper_driver_api::set_micro_step_res

@driver_ops_mandatory Set the micro-step resolution in stepper hardware driver.

---

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

• include/zephyr/drivers/stepper/stepper.h