Serial RX count bug fix. Settings codes CSV. More documentation.

- Reverted back the serial RX count function to how it was. The
variable type was unsigned and cause an integer underflow whenever the
calculation produced a negative number. The old way was the correct way.

- Lots of minor edits to the code CSVs and markdown documents.

- Expanded on explaining feedback messages and startup line execution
feedback.

- Created a new settings codes CSV to help GUIs import the values and
meanings.
This commit is contained in:
Sonny Jeon 2016-09-24 14:41:41 -06:00
parent e51e691eeb
commit c0f61e4aac
9 changed files with 207 additions and 201 deletions

View file

@ -1,34 +1,35 @@
(KEY: Error Code in v1.1+ ,Error Message in v1.0-, Error Description)
1,Expected command letter,G-code words consist of a letter and a value. Letter was not found.
2,Bad number format,Numeric value format is not valid or missing an expected value.
2,Bad number format,Missing the expected G-code word value or numeric value format is not valid.
3,Invalid statement,Grbl '$' system command was not recognized or supported.
4,Value < 0`,Negative value received for an expected positive value.
5,Setting disabled,Homing cycle is not enabled via settings.
4,Value < 0,Negative value received for an expected positive value.
5,Setting disabled,Homing cycle failure. Homing is not enabled via settings.
6,Value < 3 usec,Minimum step pulse time must be greater than 3usec.
7,EEPROM read fail. Using defaults,EEPROM read failed. Reset and restored to default values.
7,EEPROM read fail. Using defaults,An EEPROM read failed. Auto-restoring affected EEPROM to default values.
8,Not idle,Grbl '$' command cannot be used unless Grbl is IDLE. Ensures smooth operation during a job.
9,G-code lock,G-code locked out during alarm or jog state.
9,G-code lock,G-code commands are locked out during alarm or jog state.
10,Homing not enabled,Soft limits cannot be enabled without homing also enabled.
11,Line overflow,Max characters per line exceeded. Line was not processed and executed.
12,Step rate > 30kHz,Grbl '$' setting value exceeds the maximum step rate supported.
11,Line overflow,Max characters per line exceeded. Received command line was not executed.
12,Step rate > 30kHz,Grbl '$' setting value cause the step rate to exceed the maximum supported.
13,Check Door,Safety door detected as opened and door state initiated.
14,Line length exceeded,Build info or startup line exceeded EEPROM line length limit.
15,Travel exceeded,Jog target exceeds machine travel. Command ignored.
16,Invalid jog command,Jog command with no '=' or contains prohibited g-code.
14,Line length exceeded,Build info or startup line exceeded EEPROM line length limit. Line not stored.
15,Travel exceeded,Jog target exceeds machine travel. Jog command has been ignored.
16,Invalid jog command,Jog command has no '=' or contains prohibited g-code.
20,Unsupported command,Unsupported or invalid g-code command found in block.
21,Modal group violation,More than one g-code command from same modal group found in block.
22,Undefined feed rate,Feed rate has not yet been set or is undefined.
23,Invalid gcode ID:23,G-code command in block requires an integer value.
24,Invalid gcode ID:24,More than one g-code command that requires axis words found in block.
25,Invalid gcode ID:25,Repeated g-code word found in block.
26,Invalid gcode ID:26,No axis words found in block for g-code command or mode which requires them.
26,Invalid gcode ID:26,No axis words found in block for g-code command or current modal state which requires them.
27,Invalid gcode ID:27,Line number value is invalid.
28,Invalid gcode ID:28,G-code command is missing a required value word.
29,Invalid gcode ID:29,Work coordinate system commanded not supported.
30,Invalid gcode ID:30,G53 only allowed during G0 and G1 motion modes.
31,Invalid gcode ID:31,Axis words found in block while no command uses them.
32,Invalid gcode ID:32,G2/3 arcs require at least one in-plane axis word.
29,Invalid gcode ID:29,G59.x work coordinate systems are not supported.
30,Invalid gcode ID:30,G53 only allowed with G0 and G1 motion modes.
31,Invalid gcode ID:31,Axis words found in block when no command or current modal state uses them.
32,Invalid gcode ID:32,G2 and G3 arcs require at least one in-plane axis word.
33,Invalid gcode ID:33,Motion command target is invalid.
34,Invalid gcode ID:34,Arc radius value is invalid.
35,Invalid gcode ID:35,G2/3 arcs require at least one in-plane offset word.
35,Invalid gcode ID:35,G2 and G3 arcs require at least one in-plane offset word.
36,Invalid gcode ID:36,Unused value words found in block.
37,Invalid gcode ID:37,G43.1 dynamic tool length offset assigned to wrong axis.
37,Invalid gcode ID:37,G43.1 dynamic tool length offset is not assigned to configured tool length axis.

1 1 (KEY: Error Code in v1.1+ Expected command letter Error Message in v1.0- G-code words consist of a letter and a value. Letter was not found. Error Description)
1 (KEY: Error Code in v1.1+ Error Message in v1.0- Error Description)
2 1 1 Expected command letter Expected command letter G-code words consist of a letter and a value. Letter was not found. G-code words consist of a letter and a value. Letter was not found.
3 2 2 Bad number format Bad number format Numeric value format is not valid or missing an expected value. Missing the expected G-code word value or numeric value format is not valid.
4 3 3 Invalid statement Invalid statement Grbl '$' system command was not recognized or supported. Grbl '$' system command was not recognized or supported.
5 4 4 Value < 0` Value < 0 Negative value received for an expected positive value. Negative value received for an expected positive value.
6 5 5 Setting disabled Setting disabled Homing cycle is not enabled via settings. Homing cycle failure. Homing is not enabled via settings.
7 6 6 Value < 3 usec Value < 3 usec Minimum step pulse time must be greater than 3usec. Minimum step pulse time must be greater than 3usec.
8 7 7 EEPROM read fail. Using defaults EEPROM read fail. Using defaults EEPROM read failed. Reset and restored to default values. An EEPROM read failed. Auto-restoring affected EEPROM to default values.
9 8 8 Not idle Not idle Grbl '$' command cannot be used unless Grbl is IDLE. Ensures smooth operation during a job. Grbl '$' command cannot be used unless Grbl is IDLE. Ensures smooth operation during a job.
10 9 9 G-code lock G-code lock G-code locked out during alarm or jog state. G-code commands are locked out during alarm or jog state.
11 10 10 Homing not enabled Homing not enabled Soft limits cannot be enabled without homing also enabled. Soft limits cannot be enabled without homing also enabled.
12 11 11 Line overflow Line overflow Max characters per line exceeded. Line was not processed and executed. Max characters per line exceeded. Received command line was not executed.
13 12 12 Step rate > 30kHz Step rate > 30kHz Grbl '$' setting value exceeds the maximum step rate supported. Grbl '$' setting value cause the step rate to exceed the maximum supported.
14 13 13 Check Door Check Door Safety door detected as opened and door state initiated. Safety door detected as opened and door state initiated.
15 14 14 Line length exceeded Line length exceeded Build info or startup line exceeded EEPROM line length limit. Build info or startup line exceeded EEPROM line length limit. Line not stored.
16 15 15 Travel exceeded Travel exceeded Jog target exceeds machine travel. Command ignored. Jog target exceeds machine travel. Jog command has been ignored.
17 16 16 Invalid jog command Invalid jog command Jog command with no '=' or contains prohibited g-code. Jog command has no '=' or contains prohibited g-code.
18 20 20 Unsupported command Unsupported command Unsupported or invalid g-code command found in block. Unsupported or invalid g-code command found in block.
19 21 21 Modal group violation Modal group violation More than one g-code command from same modal group found in block. More than one g-code command from same modal group found in block.
20 22 22 Undefined feed rate Undefined feed rate Feed rate has not yet been set or is undefined. Feed rate has not yet been set or is undefined.
21 23 23 Invalid gcode ID:23 Invalid gcode ID:23 G-code command in block requires an integer value. G-code command in block requires an integer value.
22 24 24 Invalid gcode ID:24 Invalid gcode ID:24 More than one g-code command that requires axis words found in block. More than one g-code command that requires axis words found in block.
23 25 25 Invalid gcode ID:25 Invalid gcode ID:25 Repeated g-code word found in block. Repeated g-code word found in block.
24 26 26 Invalid gcode ID:26 Invalid gcode ID:26 No axis words found in block for g-code command or mode which requires them. No axis words found in block for g-code command or current modal state which requires them.
25 27 27 Invalid gcode ID:27 Invalid gcode ID:27 Line number value is invalid. Line number value is invalid.
26 28 28 Invalid gcode ID:28 Invalid gcode ID:28 G-code command is missing a required value word. G-code command is missing a required value word.
27 29 29 Invalid gcode ID:29 Invalid gcode ID:29 Work coordinate system commanded not supported. G59.x work coordinate systems are not supported.
28 30 30 Invalid gcode ID:30 Invalid gcode ID:30 G53 only allowed during G0 and G1 motion modes. G53 only allowed with G0 and G1 motion modes.
29 31 31 Invalid gcode ID:31 Invalid gcode ID:31 Axis words found in block while no command uses them. Axis words found in block when no command or current modal state uses them.
30 32 32 Invalid gcode ID:32 Invalid gcode ID:32 G2/3 arcs require at least one in-plane axis word. G2 and G3 arcs require at least one in-plane axis word.
31 33 33 Invalid gcode ID:33 Invalid gcode ID:33 Motion command target is invalid. Motion command target is invalid.
32 34 34 Invalid gcode ID:34 Invalid gcode ID:34 Arc radius value is invalid. Arc radius value is invalid.
33 35 35 Invalid gcode ID:35 Invalid gcode ID:35 G2/3 arcs require at least one in-plane offset word. G2 and G3 arcs require at least one in-plane offset word.
34 36 36 Invalid gcode ID:36 Invalid gcode ID:36 Unused value words found in block. Unused value words found in block.
35 37 37 Invalid gcode ID:37 Invalid gcode ID:37 G43.1 dynamic tool length offset assigned to wrong axis. G43.1 dynamic tool length offset is not assigned to configured tool length axis.