ManuelW/grbl-LPC-CoreXY
1
0
Fork 0
Code Issues Pull Requests Releases 1 Wiki Activity
968e97f9ef
grbl-LPC-CoreXY/doc/markdown/error_codes.md

125 lines
6.0 KiB
Markdown
Raw Normal View History

Grbl v1.0e huge beta release. Overrides and new reporting. - Feature: Realtime feed, rapid, and spindle speed overrides. These alter the running machine state within tens of milliseconds! - Feed override: 100%, +/-10%, +/-1% commands with values 1-200% of programmed feed - Rapid override: 100%, 50%, 25% rapid rate commands - Spindle speed override: 100%, +/-10%, +/-1% commands with values 50-200% of programmed speed - Override values have configurable limits and increments in config.h. - Feature: Realtime toggle overrides for spindle stop, flood coolant, and optionally mist coolant - Spindle stop: Enables and disables spindle during a feed hold. Automatically restores last spindles state. - Flood and mist coolant: Immediately toggles coolant state until next toggle or g-code coolant command. - Feature: Jogging mode! Incremental and absolute modes supported. - Grbl accepts jogging-specific commands like $J=X100F50. An axis word and feed rate are required. G20/21 and G90/G91 commands are accepted. - Jog motions can be canceled at any time by a feed hold `!` command. The buffer is automatically flushed. (No resetting required). - Jog motions do not alter the g-code parser state so GUIs don’t have to track what they changed and correct it. - Feature: Laser mode setting. Allows Grbl to execute continuous motions with spindle speed and state changes. - Feature: Significantly improved status reports. Overhauled to cram in more meaningful data and still make it smaller on average. - All available data is now sent by default, but does not appear if it doesn’t change or is not active. - Machine position(MPos) or work position(WPos) is reported but not both at the same time. Instead, the work coordinate offsets (WCO)are sent intermittently whenever it changes or refreshes after 10-30 status reports. Position vectors are easily computed by WPos = MPos - WCO. - All data has changed in some way. Details of changes are in the markdown documents and wiki. - Feature: 16 new realtime commands to control overrides. All in extended-ASCII character space. - While they are not easily typeable and requires a GUI, they can’t be accidentally triggered by some latent character in the g-code program and have tons of room for expansion. - Feature: New substates for HOLD and SAFETY DOOR. A `:x` is appended to the state, where `x` is an integer and indicates a substate. - For example, each integer of a door state describes in what phase the machine is in during parking. Substates are detailed in the documentation. - Feature: With the alarm codes, homing and probe alarms have been expanded with more codes to provide more exact feedback on what caused the alarm. - Feature: New hard limit check upon power-up or reset. If detected, a feedback message to check the limit switches sent immediately after the welcome message. - May be disabled in config.h. - OEM feature: Enable/disable `$RST=` individual commands based on desired behavior in config.h. - OEM feature: Configurable EEPROM wipe to prevent certain data from being deleted during firmware upgrade to a new settings version or `RST=*` command. - OEM feature: Enable/disable the `$I=` build info write string with external EEPROM write example sketch. - This prevents a user from altering the build info string in EEPROM. This requires the vendor to write the string to EEPROM via external means. An Arduino example sketch is provided to accomplish this. This would be useful for contain product data that is retrievable. - Tweak: All feedback has been drastically trimmed to free up flash space for the v1.0 release. - The `$` help message is just one string, listing available commands. - The `$$` settings printout no longer includes descriptions. Only the setting values. (Sorry it’s this or remove overrides!) - Grbl `error:` and `ALARM:` responses now only contain codes. No descriptions. All codes are explained in documentation. - Grbl’s old feedback style may be restored via a config.h, but keep in mind that it will likely not fit into the Arduino’s flash space. - Tweak: Grbl now forces a buffer sync or stop motion whenever a g-code command needs to update and write a value to EEPROM or changes the work coordinate offset. - This addresses two old issues in all prior Grbl versions. First, an EEPROM write requires interrupts to be disabled, including stepper and serial comm. Steps can be lost and data can be corrupted. Second, the work position may not be correlated to the actual machine position, since machine position is derived from the actual current execution state, while work position is based on the g-code parser offset state. They are usually not in sync and the parser state is several motions behind. This forced sync ensures work and machine positions are always correct. - This behavior can be disabled through a config.h option, but it’s not recommended to do so. - Tweak: To make status reports standardized, users can no longer change what is reported via status report mask, except for only toggling machine or work positions. - All other data fields are included in the report and can only be disabled through the config.h file. It’s not recommended to alter this, because GUIs will be expecting this data to be present and may not be compatible. - Tweak: Homing cycle and parking motion no longer report a negative line number in a status report. These will now not report a line number at all. - Tweak: New `[Restoring spindle]` message when restoring from a spindle stop override. Provides feedback what Grbl is doing while the spindle is powering up and a 4.0 second delay is enforced. - Tweak: Override values are reset to 100% upon M2/30. This behavior can be disabled in config.h - Tweak: The planner buffer size has been reduced from 18 to 16 to free up RAM for tracking and controlling overrides. - Tweak: TX buffer size has been increased from 64 to 90 bytes to improve status reporting and overall performance. - Tweak: Removed the MOTION CANCEL state. It was redundant and didn’t affect Grbl’s overall operation by doing so. - Tweak: Grbl’s serial buffer increased by +1 internally, such that 128 bytes means 128, not 127 due to the ring buffer implementation. Long overdue. - Tweak: Altered sys.alarm variable to be set by alarm codes, rather than bit flags. Simplified how it worked overall. - Tweak: Planner buffer and serial RX buffer usage has been combined in the status reports. - Tweak: Pin state reporting has been refactored to report only the pins “triggered” and nothing when not “triggered”. - Tweak: Current machine rate or speed is now included in every report. - Tweak: The work coordinate offset (WCO) and override states only need to be refreshed intermittently or reported when they change. The refresh rates may be altered for each in the config.h file with different idle and busy rates to lessen Grbl’s load during a job. - Tweak: For temporary compatibility to existing GUIs until they are updated, an option to revert back to the old style status reports is available in config.h, but not recommended for long term use. - Tweak: Removed old limit pin state reporting option from config.h in lieu of new status report that includes them. - Tweak: Updated the defaults.h file to include laser mode, altered status report mask, and fix an issue with a missing invert probe pin default. - Refactor: Changed how planner line data is generated and passed to the planner and onto the step generator. By making it a struct variable, this saved significant flash space. - Refactor: Major re-factoring of the planner to incorporate override values and allow for re-calculations fast enough to immediately take effect during operation. No small feat. - Refactor: Re-factored the step segment generator for re-computing new override states. - Refactor: Re-factored spindle_control.c to accommodate the spindle speed overrides and laser mode. - Refactor: Re-factored parts of the codebase for a new jogging mode. Still under development though and slated to be part of the official v1.0 release. Hang tight. - Refactor: Created functions for computing a unit vector and value limiting based on axis maximums to free up more flash. - Refactor: The spindle PWM is now set directly inside of the stepper ISR as it loads new step segments. - Refactor: Moved machine travel checks out of soft limits function into its own since jogging uses this too. - Refactor: Removed coolant_stop() and combined with coolant_set_state(). - Refactor: The serial RX ISR forks off extended ASCII values to quickly assess the new override realtime commands. - Refactor: Altered some names of the step control flags. - Refactor: Improved efficiency of the serial RX get buffer count function. - Refactor: Saved significant flash by removing and combining print functions. Namely the uint8 base10 and base2 functions. - Refactor: Moved the probe state check in the main stepper ISR to improve its efficiency. - Refactor: Single character printPgmStrings() went converted to direct serial_write() commands to save significant flash space. - Documentation: Detailed Markdown documents on error codes, alarm codes, messages, new real-time commands, new status reports, and how jogging works. More to come later and will be posted on the Wiki as well. - Documentation: CSV files for quick importing of Grbl error and alarm codes. - Bug Fix: Applied v0.9 master fixes to CoreXY homing. - Bug Fix: The print float function would cause Grbl to crash if a value was 1e6 or greater. Increased the buffer by 3 bytes to help prevent this in the future. - Bug Fix: Build info and startup string EEPROM restoring was not writing the checksum value. - Bug Fix: Corrected an issue with safety door restoring the proper spindle and coolant state. It worked before, but breaks with laser mode that can continually change spindle state per planner block. - Bug Fix: Move system position and probe position arrays out of the system_t struct. Ran into some compiling errors that were hard to track down as to why. Moving them out fixed it.
2016-09-22 03:08:24 +02:00
## Meanings of Grbl messages and error/alarm codes
#### _'error:' Codes_
Format - `(v1.0)` `:` `(v0.9)` - `Description`
- `error:1` : `error: Expected command letter` - G-code words consist of a letter and a value. Letter was not found.
- `error:2` : `error: Bad number format` - Numeric value format is not valid or missing an expected value.
- `error:3` : `error: Invalid statement` - Grbl '$' system command was not recognized or supported
- `error:4` : `error: Value < 0` - Negative value received for an expected positive value.
- `error:5` : `error: Setting disabled` - Homing cycle is not enabled via settings.
- `error:6` : `error: Value < 3 usec` - Minimum step pulse time must be greater than 3usec
- `error:7` : `error: EEPROM read fail. Using defaults` - EEPROM read failed. Reset and restored to default values.
- `error:8` : `error: Not idle` - Grbl '$' command cannot be used unless Grbl is IDLE. Ensures smooth operation during a job.
- `error:9` : `error: G-code lock` - G-code locked out during alarm or jog state
- `error:10` : `error: Homing not enabled` - Soft limits cannot be enabled without homing also enabled.
- `error:11` : `error: Line overflow` - Max characters per line exceeded. Line was not processed and executed.
- `error:12` : `error: Step rate > 30kHz`* - Grbl '$' setting value exceeds the maximum step rate supported.
- `error:13` : `error: Check Door` - Safety door detected as opened and door state initiated.
- `error:14` : `error: Line length exceeded` - (Grbl-Mega Only) Build info or startup line exceeded EEPROM line length limit.
- `error:15` : `error: Travel exceeded` - Jog target exceeds machine travel. Command ignored.
- `error:16` : `error: Invalid jog command` - Jog command with no '=' or contains prohibited g-code.
- `error:20` : `error: Unsupported command` - Unsupported or invalid g-code command found in block.
- `error:21` : `error: Modal group violation` - More than one g-code command from same modal group found in block.
- `error:22` : `error: Undefined feed rate` - Feed rate has not yet been set or is undefined.
- `error:23` : `error: Invalid gcode ID:23` - G-code command in block requires an integer value.
- `error:24` : `error: Invalid gcode ID:24` - More than one g-code command that requires axis words found in block.
- `error:25` : `error: Invalid gcode ID:25` - Repeated g-code word found in block.
- `error:26` : `error: Invalid gcode ID:26` - No axis words found in block for g-code command or mode which requires them.
- `error:27` : `error: Invalid gcode ID:27` - Line number value is invalid
- `error:28` : `error: Invalid gcode ID:28` - G-code command is missing a required value word.
- `error:29` : `error: Invalid gcode ID:29` - Work coordinate system commanded not supported.
- `error:30` : `error: Invalid gcode ID:30` - G53 only allowed during G0 and G1 motion modes.
- `error:31` : `error: Invalid gcode ID:31` - Axis words found in block while no command uses them.
- `error:32` : `error: Invalid gcode ID:32` - G2/3 arcs require at least one in-plane axis word.
- `error:33` : `error: Invalid gcode ID:33` - Motion command target is invalid.
- `error:34` : `error: Invalid gcode ID:34` - Arc radius value is invalid.
- `error:35` : `error: Invalid gcode ID:35` - G2/3 arcs require at least one in-plane offset word.
- `error:36` : `error: Invalid gcode ID:36` - Unused value words found in block.
- `error:37` : `error: Invalid gcode ID:37` - G43.1 dynamic tool length offset assigned to wrong axis.
`*` indicates feedback enabled only by compile-time option.
-----
#### 'Alarm:' Codes
Format - `(v1.0)` `:` `(v0.9)` - `Description`
- `ALARM:1` : `ALARM: Hard limit` - Hard limit has been triggered. Machine position is likely lost due to sudden stop. Re-homing is highly recommended.
`
- `ALARM:2` : `ALARM: Soft limit` - G-code motion target exceeds machine travel. Machine position safely retained. Alarm may be unlocked.
- `ALARM:3` : `ALARM: Abort during cycle` - Reset while in motion. Grbl cannot guarantee position. Lost steps are likely. Re-homing is highly recommended.
- `ALARM:4` : `ALARM: Probe fail` - If probe is not in the expected initial state before starting probe cycle, where G38.2 and G38.3 is not triggered and G38.4 and G38.5 is triggered.
- `ALARM:5` : `ALARM: Probe fail` - If the probe fails to contact the workpiece within the programmed travel for G38.2 and G38.4.
- `ALARM:6` : `ALARM: Homing fail` - If the active homing cycle was reset.
- `ALARM:7` : `ALARM: Homing fail` - If the safety door was opened during homing cycle.
- `ALARM:8` : `ALARM: Homing fail` - Pull off travel failed to clear limit switch. Try increasing pull-off setting or check wiring.
- `ALARM:9` : `ALARM: Homing fail` - Failed to find limit switch within travel. Defined as `1.5 * max_travel` on search and `5 * pulloff` on locate phases.
-----
#### Message Descriptions
Format - `Message` - `Description`
- `[Reset to continue]` - Critical event message. Reset is required before Grbl accepts any other commands. This prevents ongoing command streaming and risking a motion before the alarm is acknowledged. Hard or soft limit errors will trigger this event.
- `[‘$H’|’$X’ to unlock]`- Alarm message at initialization. All g-code commands and some ‘$’ are blocked until unlocked via homing or $X.
- `[Caution: Unlocked]` - Alarm unlock $X acknowledgement.
- `[Enabled]` - Indicates Grbl’s check-mode is enabled.
- `[Disabled]` - Indicates Grbl’s check-mode is disabled. Grbl is automatically reset afterwards.
- `[Check Door]` - Safety door detected as open. This message appears either immediately upon a safety door ajar or if the safety is open when Grbl initializes after a power-up/reset.
- `[Check Limits]` - If Grbl detects a limit switch is triggered after power-up/reset and hard limits are enabled, this will appear as a courtesy message.
- `[Pgm End]` - M2/30 program end message to denote g-code modes have been restored to defaults according to the M2/30 g-code description.
- `[Restoring defaults]` - Acknowledgement message when restoring EEPROM defaults via a `$RST=` command.
Reference in New Issue Copy Permalink