GRBL Pocket Reference
GRBL Pocket Reference
1 Quick Reference
This is designed as an Aide Memoir for when I cannot Grbl Alarm Codes Grbl Settings
remember if $110 or $120 is the maximum rate or acceleration Code Alarm Description Setting Description
setting, what error 31 means….. If you are changing the Grbl 1 Hard limit triggered. Position Lost. $0 Step pulse, microseconds
settings please refer to other sources as well. 2 Soft limit alarm, position kept. Unlock is Safe. $1 Step idle delay, milliseconds
3 Reset while in motion. Position lost. $2 Step port invert, XYZmask*
Grbl Error Codes 4 Probe fail. Probe not in expected initial state. $3 Direction port invert, XYZmask*
Code Description 5 Probe fail. Probe did not contact the work. The direction each axis moves.
1 GCode Command letter was not found. 6 Homing fail. The active homing cycle was reset. $4 Step enable invert, (0=Disable, 1=Invert)
2 GCode Command value invalid or missing. 7 Homing fail. Door opened during homing cycle. $5 Limit pins invert, (0=N-Open. 1=N-Close)
3 Grbl '$' not recognized or supported. 8 Homing fail. Pull off failed to clear limit switch. $6 Probe pin invert, (0=N-Open. 1=N-Close)
4 Negative value for an expected positive value. 9 Homing fail. Could not find limit switch. $10 Status report, ‘?’ status. 0=WCS position, 1=Machine
5 Homing fail. Homing not enabled in settings. position, 2= plan/buffer and WCS position,
6 Min step pulse must be greater than 3usec. 3=plan/buffer and Machine position.
7 EEPROM read failed. Default values used. $11 Junction deviation, mm
Grbl Non Gcode Commands
8 Grbl '$' command Only valid when Idle. $12 Arc tolerance, mm
Command Description $13 Report in inches, (0=mm. 1=Inches)**
9 GCode commands invalid in alarm or jog state.
$$ Display Grbl Settings. $20 Soft limits, (0=Disable. 1=Enable, Homing must be
10 Soft limits require homing to be enabled.
$x=val Change Grbl Setting x to val. enabled)
11 Max characters per line exceeded. Ignored.
$# View GCode Parameters. $21 Hard limits, (0=Disable. 1=Enable)
12 Grbl '$' setting exceeds the maximum step rate.
$G View GCode parser state. $22 Homing cycle, (0=Disable. 1=Enable)
13 Safety door opened and door state initiated.
$C Toggle Check Gcode Mode $23 Homing direction invert, XYZmask* Sets which
14 Build info or start-up line > EEPROM line length
$H Run Homing Cycle corner it homes to.
15 Jog target exceeds machine travel, ignored.
$J=gcode Run Jogging Motion. $24 Homing feed, mm/min
16 Jog Cmd missing '=' or has prohibited GCode.
$X Kill Alarm Lock state. $25 Homing seek, mm/min
17 Laser mode requires PWM output.
$I View Build Info $26 Homing debounce, milliseconds
20 Unsupported or invalid GCode command.
$N View saved start up code $27 Homing pull-off, mm
21 > 1 GCode command in a modal group in block.
$Nx=line Save Start-up GCode line (x=0 or 1) There are $30 Max spindle speed, RPM
22 Feed rate has not yet been set or is undefined.
executed on a reset. $31 Min spindle speed, RPM
23 GCode command requires an integer value.
$RST=$ Restores the Grbl settings to defaults. $32 Laser mode, (0=Off, 1=On)
24 > 1 GCode command using axis words found.
$RST=# Erases G54-G59 WCS offsets and G28/30 $100 Number of X steps to move 1mm
25 Repeated GCode word found in block.
positions stored in EEPROM. $101 Number of Y steps to move 1mm
26 No axis words found in command block.
$RST=* Clear and Load all data from EEPROM. $102 Number of Z steps to move 1mm
27 Line number value is invalid.
$SLP Enable Sleep mode. $110 X Max rate, mm/min
28 GCode Cmd missing a required value word.
Ctrl-x Soft Reset $111 Y Max rate, mm/min
29 G59.x WCS are not supported.
? Status report query. $112 Z Max rate, mm/min
30 G53 only valid with G0 and G1 motion modes.
~ Cycle Start/Resume from Feed Hold, Door or $120 X Acceleration, mm/sec^2
31 Unneeded Axis words found in block.
Program pause. $121 Y Acceleration, mm/sec^2
32 G2/G3 arcs need >= 1 in-plane axis word.
! Feed Hold – Stop all motion. $122 Z Acceleration, mm/sec^2
33 Motion command target is invalid.
NOTE: There are a number of other real time commands using non $130 X Max travel, mm Only for Homing and Soft Limits.
34 Arc radius value is invalid. typeable characters. These are for developers and are not normally
35 G2/G3 arcs need >= 1 in-plane offset word. $131 Y Max travel, mm Only for Homing and Soft Limits.
used outside from the console. These control things such as feed
36 Unused value words found in block. overrides. And are not covered here. $132 Z Max travel, mm Only for Homing and Soft Limits.
37 G43.1 offset not assigned to tool length axis. * XYZmask is a value setting for the X Y and Z axes. Change if an axis is
38 Tool number greater than max value. moving in the wrong direction. Value will be 0-7.
** Reporting units are independent of the units set in the Gcode!