grblHAL core  20241107
st_segment Struct Reference

#include <stepper.h>

Data Fields

uint_fast8_t id
 Id may be used by driver to track changes. More...
 
struct st_segmentnext
 Pointer to next element in cirular list of segments. More...
 
st_block_texec_block
 Pointer to the block data for the segment. More...
 
uint32_t cycles_per_tick
 Step distance traveled per ISR tick, aka step rate. More...
 
float current_rate
 
float target_position
 Target position of segment relative to block start, used by spindle sync code. More...
 
uint_fast16_t n_step
 Number of step events to be executed for this segment. More...
 
uint_fast16_t spindle_pwm
 Spindle PWM to be set at the start of segment execution. More...
 
float spindle_rpm
 Spindle RPM to be set at the start of the segment execution. More...
 
bool spindle_sync
 True if block is spindle synchronized. More...
 
bool cruising
 True when in cruising part of profile, only set for spindle synced moves. More...
 
uint_fast8_t amass_level
 Indicates AMASS level for the ISR to execute this segment. More...
 
spindle_update_pwm_ptr update_pwm
 Valid pointer to spindle.update_pwm() if set spindle speed at the start of the segment execution. More...
 
spindle_update_rpm_ptr update_rpm
 Valid pointer to spindle.update_rpm() if set spindle speed at the start of the segment execution. More...
 

Field Documentation

◆ amass_level

uint_fast8_t amass_level

Indicates AMASS level for the ISR to execute this segment.

◆ cruising

bool cruising

True when in cruising part of profile, only set for spindle synced moves.

◆ current_rate

float current_rate

◆ cycles_per_tick

uint32_t cycles_per_tick

Step distance traveled per ISR tick, aka step rate.

◆ exec_block

st_block_t* exec_block

Pointer to the block data for the segment.

◆ id

uint_fast8_t id

Id may be used by driver to track changes.

◆ n_step

uint_fast16_t n_step

Number of step events to be executed for this segment.

◆ next

struct st_segment* next

Pointer to next element in cirular list of segments.

◆ spindle_pwm

uint_fast16_t spindle_pwm

Spindle PWM to be set at the start of segment execution.

◆ spindle_rpm

float spindle_rpm

Spindle RPM to be set at the start of the segment execution.

◆ spindle_sync

bool spindle_sync

True if block is spindle synchronized.

◆ target_position

float target_position

Target position of segment relative to block start, used by spindle sync code.

◆ update_pwm

Valid pointer to spindle.update_pwm() if set spindle speed at the start of the segment execution.

◆ update_rpm

Valid pointer to spindle.update_rpm() if set spindle speed at the start of the segment execution.


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