stepper.h File Reference

#include "planner.h"

Go to the source code of this file.

Data Structures
struct	st_block
	Holds the planner block Bresenham algorithm execution data for the segments in the segment buffer. More...
struct	st_segment
struct	stepper
	Stepper ISR data struct. Contains the running data for the main stepper ISR. More...

Typedefs
typedef struct st_block	st_block_t
	Holds the planner block Bresenham algorithm execution data for the segments in the segment buffer. More...
typedef struct st_segment	segment_t
typedef struct stepper	stepper_t
	Stepper ISR data struct. Contains the running data for the main stepper ISR. More...

Enumerations
enum	squaring_mode_t { SquaringMode_Both = 0 , SquaringMode_A , SquaringMode_B }

Functions
void	stepper_init (void)
void	st_wake_up (void)
void	st_go_idle (void)
void	st_reset (void)
void	st_rpm_changed (float rpm)
void	st_parking_setup_buffer ()
void	st_parking_restore_buffer (void)
void	st_prep_buffer (void)
void	st_update_plan_block_parameters (void)
float	st_get_realtime_rate (void)
void	stepper_driver_interrupt_handler (void)
offset_id_t	st_get_offset_id (void)

Typedef Documentation

segment_t

typedef struct st_segment segment_t

st_block_t

typedef struct st_block st_block_t

Holds the planner block Bresenham algorithm execution data for the segments in the segment buffer.

NOTE: This data is copied from the prepped planner blocks so that the planner blocks may be discarded when entirely consumed and completed by the segment buffer. Also, AMASS alters this data for its own use.

stepper_t

typedef struct stepper stepper_t

Stepper ISR data struct. Contains the running data for the main stepper ISR.

Enumeration Type Documentation

squaring_mode_t

enum squaring_mode_t

Enumerator
SquaringMode_Both	0
SquaringMode_A	1
SquaringMode_B	2

Function Documentation

st_get_offset_id()

offset_id_t st_get_offset_id

(

void

)

st_get_realtime_rate()

float st_get_realtime_rate

(

void

)

st_go_idle()

void st_go_idle

(

void

)

st_parking_restore_buffer()

void st_parking_restore_buffer

(

void

)

st_parking_setup_buffer()

void st_parking_setup_buffer

(

)

st_prep_buffer()

void st_prep_buffer

(

void

)

st_reset()

void st_reset

(

void

)

st_rpm_changed()

void st_rpm_changed

(

float

rpm

)

st_update_plan_block_parameters()

void st_update_plan_block_parameters

(

void

)

st_wake_up()

void st_wake_up

(

void

)

stepper_driver_interrupt_handler()

void stepper_driver_interrupt_handler

(

void

)

stepper_init()

void stepper_init

(

void

)