grblHAL core  20241107
spindle_pwm Struct Reference

Precalculated values that may be set/used by HAL driver to speed up RPM to PWM conversions if variable spindle is supported. *‍/. More...

#include <spindle_control.h>

Data Fields

uint32_t f_clock
 
spindle_settings_tsettings
 
uint_fast16_t period
 
uint_fast16_t off_value
 NOTE: this value holds the inverted version if software PWM inversion is enabled by the driver. More...
 
uint_fast16_t min_value
 
uint_fast16_t max_value
 
float rpm_min
 Minimum spindle RPM. More...
 
float pwm_gradient
 
bool invert_pwm
 deprecated, use bit in flags instead More...
 
bool always_on
 deprecated, use bit in flags instead More...
 
bool cloned
 deprecated, use bit in flags instead More...
 
spindle_pwm_flags_t flags
 
int_fast16_t offset
 
uint_fast16_t n_pieces
 
pwm_piece_t piece [SPINDLE_NPWM_PIECES]
 
uint_fast16_t(* compute_value )(struct spindle_pwm *pwm_data, float rpm, bool pid_limit)
 

Detailed Description

Precalculated values that may be set/used by HAL driver to speed up RPM to PWM conversions if variable spindle is supported. *‍/.

Field Documentation

◆ always_on

bool always_on

deprecated, use bit in flags instead

◆ cloned

bool cloned

deprecated, use bit in flags instead

◆ compute_value

uint_fast16_t(* compute_value) (struct spindle_pwm *pwm_data, float rpm, bool pid_limit)

◆ f_clock

uint32_t f_clock

◆ flags

◆ invert_pwm

bool invert_pwm

deprecated, use bit in flags instead

◆ max_value

uint_fast16_t max_value

◆ min_value

uint_fast16_t min_value

◆ n_pieces

uint_fast16_t n_pieces

◆ off_value

uint_fast16_t off_value

NOTE: this value holds the inverted version if software PWM inversion is enabled by the driver.

◆ offset

int_fast16_t offset

◆ period

uint_fast16_t period

◆ piece

◆ pwm_gradient

float pwm_gradient

◆ rpm_min

float rpm_min

Minimum spindle RPM.

◆ settings

spindle_settings_t* settings

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