Merge pull request #14 from bkp23/defaults_comments
Added a description to each option, including the option codes (ordered by $key).
This commit is contained in:
Claudio Prezzi
GitHub
commit
ac6817f7e2
121
grbl/defaults.h
121
grbl/defaults.h
@ -29,54 +29,57 @@
|
||||
|
||||
#ifdef DEFAULTS_GENERIC
|
||||
// Grbl generic default settings. Should work across different machines.
|
||||
#define DEFAULT_X_STEPS_PER_MM 250.0
|
||||
#define DEFAULT_Y_STEPS_PER_MM 250.0
|
||||
#define DEFAULT_Z_STEPS_PER_MM 250.0
|
||||
#define DEFAULT_A_STEPS_PER_MM 160.0
|
||||
#define DEFAULT_X_MAX_RATE 500.0 // mm/min
|
||||
#define DEFAULT_Y_MAX_RATE 500.0 // mm/min
|
||||
#define DEFAULT_Z_MAX_RATE 500.0 // mm/min
|
||||
#define DEFAULT_A_MAX_RATE 500.0 // mm/min
|
||||
#define DEFAULT_X_ACCELERATION (10.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
|
||||
#define DEFAULT_Y_ACCELERATION (10.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
|
||||
#define DEFAULT_Z_ACCELERATION (10.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
|
||||
#define DEFAULT_A_ACCELERATION (10.0*60*60) // 10*60*60 mm/min^2 = 10 mm/sec^2
|
||||
#define DEFAULT_X_CURRENT 0.6 // amps
|
||||
#define DEFAULT_Y_CURRENT 0.6 // amps
|
||||
#define DEFAULT_Z_CURRENT 0.0 // amps
|
||||
#define DEFAULT_A_CURRENT 0.0 // amps
|
||||
#define DEFAULT_X_MAX_TRAVEL 200.0 // mm NOTE: Must be a positive value.
|
||||
#define DEFAULT_Y_MAX_TRAVEL 200.0 // mm NOTE: Must be a positive value.
|
||||
#define DEFAULT_Z_MAX_TRAVEL 200.0 // mm NOTE: Must be a positive value.
|
||||
#define DEFAULT_A_MAX_TRAVEL 1.0 // mm NOTE: Must be a positive value.
|
||||
#define DEFAULT_SPINDLE_PWM_FREQ 5000 // Hz
|
||||
#define DEFAULT_SPINDLE_PWM_OFF_VALUE 0 // %
|
||||
#define DEFAULT_SPINDLE_PWM_MIN_VALUE 1 // %
|
||||
#define DEFAULT_SPINDLE_PWM_MAX_VALUE 100 // %
|
||||
#define DEFAULT_SPINDLE_RPM_MAX 1000.0 // rpm (S-value)
|
||||
#define DEFAULT_SPINDLE_RPM_MIN 0.0 // rpm (S-value)
|
||||
#define DEFAULT_STEP_PULSE_MICROSECONDS 10
|
||||
#define DEFAULT_STEPPING_INVERT_MASK 0
|
||||
#define DEFAULT_DIRECTION_INVERT_MASK 0
|
||||
#define DEFAULT_STEPPER_IDLE_LOCK_TIME 25 // msec (0-254, 255 keeps steppers enabled)
|
||||
#define DEFAULT_STATUS_REPORT_MASK 0 // WPos enabled
|
||||
#define DEFAULT_JUNCTION_DEVIATION 0.01 // mm
|
||||
#define DEFAULT_ARC_TOLERANCE 0.002 // mm
|
||||
#define DEFAULT_REPORT_INCHES 0 // false
|
||||
#define DEFAULT_INVERT_ST_ENABLE 0 // false
|
||||
#define DEFAULT_INVERT_LIMIT_PINS 0 // false
|
||||
#define DEFAULT_SOFT_LIMIT_ENABLE 0 // false
|
||||
#define DEFAULT_HARD_LIMIT_ENABLE 0 // false
|
||||
#define DEFAULT_INVERT_PROBE_PIN 0 // false
|
||||
#define DEFAULT_LASER_MODE 0 // false
|
||||
#define DEFAULT_HOMING_ENABLE 0 // false
|
||||
#define DEFAULT_HOMING_DIR_MASK 0 // move positive dir
|
||||
#define DEFAULT_HOMING_FEED_RATE 25.0 // mm/min
|
||||
#define DEFAULT_HOMING_SEEK_RATE 500.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
// See https://github.com/gnea/grbl/wiki/Grbl-v1.1-Configuration for setting descriptions.
|
||||
#define DEFAULT_X_STEPS_PER_MM 250.0 // $100 steps (X steps per mm)
|
||||
#define DEFAULT_Y_STEPS_PER_MM 250.0 // $101 steps (Y steps per mm)
|
||||
#define DEFAULT_Z_STEPS_PER_MM 250.0 // $102 steps (Z steps per mm)
|
||||
#define DEFAULT_A_STEPS_PER_MM 160.0 // $103 steps (A steps per mm)
|
||||
#define DEFAULT_X_MAX_RATE 500.0 // $110 mm/min (X max speed)
|
||||
#define DEFAULT_Y_MAX_RATE 500.0 // $111 mm/min (Y max speed)
|
||||
#define DEFAULT_Z_MAX_RATE 500.0 // $112 mm/min (Z max speed)
|
||||
#define DEFAULT_A_MAX_RATE 500.0 // $113 mm/min (A max speed)
|
||||
#define DEFAULT_X_ACCELERATION (10.0*60*60)// $120 mm/min^2 (X max acceleration)
|
||||
#define DEFAULT_Y_ACCELERATION (10.0*60*60)// $121 mm/min^2 (Y max acceleration)
|
||||
#define DEFAULT_Z_ACCELERATION (10.0*60*60)// $122 mm/min^2 (Z max acceleration)
|
||||
#define DEFAULT_A_ACCELERATION (10.0*60*60)// $123 mm/min^2 (A max acceleration)
|
||||
#define DEFAULT_X_MAX_TRAVEL 200.0 // $130 mm (X max travel; must be positive)
|
||||
#define DEFAULT_Y_MAX_TRAVEL 200.0 // $131 mm (Y max travel; must be positive)
|
||||
#define DEFAULT_Z_MAX_TRAVEL 200.0 // $132 mm (Z max travel; must be positive)
|
||||
#define DEFAULT_A_MAX_TRAVEL 1.0 // $133 mm (A max travel; must be positive)
|
||||
#define DEFAULT_X_CURRENT 0.6 // $140 amps (X stepper current [disabled])
|
||||
#define DEFAULT_Y_CURRENT 0.6 // $141 amps (Y stepper current [disabled])
|
||||
#define DEFAULT_Z_CURRENT 0.0 // $142 amps (Z stepper current [disabled])
|
||||
#define DEFAULT_A_CURRENT 0.0 // $143 amps (A stepper current [disabled])
|
||||
|
||||
#define DEFAULT_STEP_PULSE_MICROSECONDS 10 // $0 usec (stepper pulse time)
|
||||
#define DEFAULT_STEPPER_IDLE_LOCK_TIME 25 // $1 msec (0-254, 255 keeps steppers enabled)
|
||||
#define DEFAULT_STEPPING_INVERT_MASK 0 // $2 ZYX (e.g., 0x5 inverts Z and X stepper pulses)
|
||||
#define DEFAULT_DIRECTION_INVERT_MASK 0 // $3 ZYX (e.g., 0x2 inverts Y stepper direction)
|
||||
#define DEFAULT_INVERT_ST_ENABLE 0 // $4 bool (inverts stepper enable pin)
|
||||
#define DEFAULT_INVERT_LIMIT_PINS 0 // $5 bool (inverts limit switches to trigger on high)
|
||||
#define DEFAULT_INVERT_PROBE_PIN 0 // $6 bool (inverts probe to trigger on high)
|
||||
#define DEFAULT_STATUS_REPORT_MASK 0 // $10 bits (Reports: [0=WPos or 1=MPos] and [2=Buffer])
|
||||
#define DEFAULT_JUNCTION_DEVIATION 0.01 // $11 mm (determines machine speed through corners)
|
||||
#define DEFAULT_ARC_TOLERANCE 0.002 // $12 mm (error tolerance on arcs/cicles)
|
||||
#define DEFAULT_REPORT_INCHES 0 // $13 bool (sets position reporting to inches)
|
||||
#define DEFAULT_SOFT_LIMIT_ENABLE 0 // $20 bool (prevents moves outside *_MAX_TRAVEL; requires $23=1)
|
||||
#define DEFAULT_HARD_LIMIT_ENABLE 0 // $21 bool ([ignored] stops moving when limit switches triggered)
|
||||
#define DEFAULT_HOMING_ENABLE 0 // $22 bool (enables homing on startup)
|
||||
#define DEFAULT_HOMING_DIR_MASK 0 // $23 ZYX (e.g., 0x3 reverses XY homing to negative direction)
|
||||
#define DEFAULT_HOMING_FEED_RATE 25.0 // $24 mm/min (homing precision location speed)
|
||||
#define DEFAULT_HOMING_SEEK_RATE 500.0 // $25 mm/min (homing search speed)
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // $26 msec (homing switch debounce: 0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // $27 mm (retracts this far from homing switch)
|
||||
#define DEFAULT_SPINDLE_RPM_MAX 1000.0 // $30 RPM (spindle speed for max 5V PWM output)
|
||||
#define DEFAULT_SPINDLE_RPM_MIN 0.0 // $31 RPM (spindle speed for min 20mV PWM output)
|
||||
#define DEFAULT_LASER_MODE 0 // $32 bool (adjusts spindle power with speed for lasers)
|
||||
#define DEFAULT_SPINDLE_PWM_FREQ 5000 // $33 Hz (PWM frequency for spindle)
|
||||
#define DEFAULT_SPINDLE_PWM_OFF_VALUE 0 // $34 % (% of PWM when spindle is off)
|
||||
#define DEFAULT_SPINDLE_PWM_MIN_VALUE 1 // $35 % (% of PWM when spindle is at lowest setting)
|
||||
#define DEFAULT_SPINDLE_PWM_MAX_VALUE 100 // $36 % (% of PWM when spindle is at highest setting)
|
||||
// Up to 3 HOMING_CYCLE_x can be defined, specifying which axes are homed and in which order
|
||||
#define HOMING_CYCLE_0 ((1<<X_AXIS)|(1<<Y_AXIS))
|
||||
#endif
|
||||
#endif // end of DEFAULTS_GENERIC
|
||||
|
||||
#ifdef DEFAULTS_K40
|
||||
// Description: K40 Lasercutter (typical chinese 40W CO2 laser cutter/engraver)
|
||||
@ -127,7 +130,7 @@
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 2.0 // mm
|
||||
#define HOMING_CYCLE_0 ((1<<X_AXIS)|(1<<Y_AXIS))
|
||||
#endif
|
||||
#endif // end of DEFAULTS_K40
|
||||
|
||||
#ifdef DEFAULTS_FABKIT
|
||||
// Paste default settings definitions here.
|
||||
@ -179,7 +182,7 @@
|
||||
#define DEFAULT_HOMING_PULLOFF 2.0 // mm
|
||||
#define HOMING_CYCLE_0 (1<<Z_AXIS)
|
||||
#define HOMING_CYCLE_1 ((1<<X_AXIS)|(1<<Y_AXIS))
|
||||
#endif
|
||||
#endif // end of DEFAULTS_FABKIT
|
||||
|
||||
#ifdef DEFAULTS_SHERLINE_5400
|
||||
// Description: Sherline 5400 mill with three NEMA 23 Keling KL23H256-21-8B 185 oz-in stepper motors,
|
||||
@ -222,7 +225,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 635.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_SHERLINE_5400
|
||||
|
||||
#ifdef DEFAULTS_SHAPEOKO
|
||||
// Description: Shapeoko CNC mill with three NEMA 17 stepper motors, driven by Synthetos
|
||||
@ -268,7 +271,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 250.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_SHAPEOKO
|
||||
|
||||
#ifdef DEFAULTS_SHAPEOKO_2
|
||||
// Description: Shapeoko CNC mill with three NEMA 17 stepper motors, driven by Synthetos
|
||||
@ -314,7 +317,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 250.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_SHAPEOKO_2
|
||||
|
||||
#ifdef DEFAULTS_SHAPEOKO_3
|
||||
// Description: Shapeoko CNC mill with three NEMA 23 stepper motors, driven by CarbideMotion
|
||||
@ -359,7 +362,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 1000.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 25 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 5.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_SHAPEOKO_3
|
||||
|
||||
#ifdef DEFAULTS_X_CARVE_500MM
|
||||
// Description: X-Carve 3D Carver CNC mill with three 200 step/rev motors driven by Synthetos
|
||||
@ -405,7 +408,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 750.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_X_CARVE_500MM
|
||||
|
||||
#ifdef DEFAULTS_X_CARVE_1000MM
|
||||
// Description: X-Carve 3D Carver CNC mill with three 200 step/rev motors driven by Synthetos
|
||||
@ -451,7 +454,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 750.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_X_CARVE_1000MM
|
||||
|
||||
#ifdef DEFAULTS_ZEN_TOOLWORKS_7x7
|
||||
// Description: Zen Toolworks 7x7 mill with three Shinano SST43D2121 65oz-in NEMA 17 stepper motors.
|
||||
@ -495,7 +498,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 250.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_ZEN_TOOLWORKS_7x7
|
||||
|
||||
#ifdef DEFAULTS_OXCNC
|
||||
// Grbl settings for OpenBuilds OX CNC Machine
|
||||
@ -535,7 +538,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 500.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_OXCNC
|
||||
|
||||
#ifdef DEFAULTS_SIMULATOR
|
||||
// Settings only for Grbl Simulator (www.github.com/grbl/grbl-sim)
|
||||
@ -575,7 +578,7 @@
|
||||
#define DEFAULT_HOMING_SEEK_RATE 500.0 // mm/min
|
||||
#define DEFAULT_HOMING_DEBOUNCE_DELAY 250 // msec (0-65k)
|
||||
#define DEFAULT_HOMING_PULLOFF 1.0 // mm
|
||||
#endif
|
||||
#endif // end of DEFAULTS_SIMULATOR
|
||||
|
||||
#ifdef DEFAULTS_JONAS
|
||||
// Description: K40 Lasercutter (typical chinese 40W CO2 laser cutter/engraver)
|
||||
@ -628,6 +631,6 @@
|
||||
#define HOMING_CYCLE_0 (1<<Z_AXIS) // First home Z to clear workspace
|
||||
#define HOMING_CYCLE_1 (1<<X_AXIS) // Then home X
|
||||
#define HOMING_CYCLE_2 (1<<Y_AXIS) // Then home Y
|
||||
#endif
|
||||
#endif // end of DEFAULTS_JONAS
|
||||
|
||||
#endif
|
||||
|
||||
Loading…
Reference in New Issue
Block a user