grblHAL core  20241107
spindle_ptrs Struct Reference

Handlers and data for spindle support. More...

#include <spindle_control.h>

Data Fields

spindle_id_t id
 Spindle id, assigned on spindle registration. More...
 
uint8_t ref_id
 Spindle id, assigned on spindle registration. More...
 
struct spindle_paramparam
 Pointer to current spindle parameters, assigned when spindle is enabled. More...
 
spindle_type_t type
 Spindle type. More...
 
spindle_cap_t cap
 Spindle capabilities. More...
 
spindle_context_ptr_t context
 Optional pointer to spindle specific context. More...
 
uint_fast16_t pwm_off_value
 Value for switching PWM signal off. More...
 
float rpm_min
 Minimum spindle RPM. More...
 
float rpm_max
 Maximum spindle RPM. More...
 
float at_speed_tolerance
 Tolerance in percent of programmed speed. More...
 
spindle_config_ptr config
 Optional handler for configuring the spindle. More...
 
spindle_set_state_ptr set_state
 Handler for setting spindle state. More...
 
spindle_get_state_ptr get_state
 Handler for getting spindle state. More...
 
spindle_get_pwm_ptr get_pwm
 Handler for calculating spindle PWM value from RPM. More...
 
spindle_update_pwm_ptr update_pwm
 Handler for updating spindle PWM output. More...
 
spindle_update_rpm_ptr update_rpm
 Handler for updating spindle RPM. More...
 
spindle_pulse_on_ptr pulse_on
 Optional handler for Pulses Per Inch (PPI) mode. Required for the laser PPI plugin. More...
 
spindle_get_data_ptr get_data
 Optional handler for getting spindle data. Required for spindle sync, copied from hal.spindle_data.get on selection. More...
 
spindle_reset_data_ptr reset_data
 Optional handler for resetting spindle data. Required for spindle sync, copied from hal.spindle_data.reset on selection. More...
 

Detailed Description

Handlers and data for spindle support.

Field Documentation

◆ at_speed_tolerance

float at_speed_tolerance

Tolerance in percent of programmed speed.

◆ cap

Spindle capabilities.

◆ config

Optional handler for configuring the spindle.

◆ context

Optional pointer to spindle specific context.

◆ get_data

Optional handler for getting spindle data. Required for spindle sync, copied from hal.spindle_data.get on selection.

◆ get_pwm

Handler for calculating spindle PWM value from RPM.

◆ get_state

Handler for getting spindle state.

◆ id

Spindle id, assigned on spindle registration.

◆ param

struct spindle_param* param

Pointer to current spindle parameters, assigned when spindle is enabled.

◆ pulse_on

Optional handler for Pulses Per Inch (PPI) mode. Required for the laser PPI plugin.

◆ pwm_off_value

uint_fast16_t pwm_off_value

Value for switching PWM signal off.

◆ ref_id

uint8_t ref_id

Spindle id, assigned on spindle registration.

◆ reset_data

Optional handler for resetting spindle data. Required for spindle sync, copied from hal.spindle_data.reset on selection.

◆ rpm_max

float rpm_max

Maximum spindle RPM.

◆ rpm_min

float rpm_min

Minimum spindle RPM.

◆ set_state

Handler for setting spindle state.

◆ type

Spindle type.

◆ update_pwm

Handler for updating spindle PWM output.

◆ update_rpm

Handler for updating spindle RPM.


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