 |
gnea\grbl-Mega
1.0f
Source Code Documentation ( Internal Workings )
|
|
|
gnea\grbl-Mega
1.0f
Source Code Documentation ( Internal Workings )
|
|
#include "grbl.h"Go to the source code of this file.
Macros | |
| #define | DEFAULTS_GENERIC |
| This file contains compile-time configurations for Grbl's internal system. For the most part,. More... | |
| #define | CPU_MAP_2560_INITIAL |
| #define | BAUD_RATE 115200 |
| Serial baud rate. More... | |
| #define | CMD_RESET 0x18 |
| Define realtime command special characters. These characters are 'picked-off' directly from the. More... | |
| #define | CMD_STATUS_REPORT '?' |
| #define | CMD_CYCLE_START '~' |
| #define | CMD_FEED_HOLD '!' |
| #define | CMD_SAFETY_DOOR 0x84 |
| NOTE: All override realtime commands must be in the extended ASCII character set, starting. More... | |
| #define | CMD_JOG_CANCEL 0x85 |
| #define | CMD_DEBUG_REPORT 0x86 |
| Only when DEBUG enabled, sends debug report in '{}' braces. More... | |
| #define | CMD_FEED_OVR_RESET 0x90 |
| Restores feed override value to 100%. More... | |
| #define | CMD_FEED_OVR_COARSE_PLUS 0x91 |
| #define | CMD_FEED_OVR_COARSE_MINUS 0x92 |
| #define | CMD_FEED_OVR_FINE_PLUS 0x93 |
| #define | CMD_FEED_OVR_FINE_MINUS 0x94 |
| #define | CMD_RAPID_OVR_RESET 0x95 |
| Restores rapid override value to 100%. More... | |
| #define | CMD_RAPID_OVR_MEDIUM 0x96 |
| #define | CMD_RAPID_OVR_LOW 0x97 |
| #define | CMD_SPINDLE_OVR_RESET 0x99 |
| Restores spindle override value to 100%. More... | |
| #define | CMD_SPINDLE_OVR_COARSE_PLUS 0x9A |
| #define | CMD_SPINDLE_OVR_COARSE_MINUS 0x9B |
| #define | CMD_SPINDLE_OVR_FINE_PLUS 0x9C |
| #define | CMD_SPINDLE_OVR_FINE_MINUS 0x9D |
| #define | CMD_SPINDLE_OVR_STOP 0x9E |
| #define | CMD_COOLANT_FLOOD_OVR_TOGGLE 0xA0 |
| #define | CMD_COOLANT_MIST_OVR_TOGGLE 0xA1 |
| #define | HOMING_INIT_LOCK |
| If homing is enabled, homing init lock sets Grbl into an alarm state upon power up. This forces. More... | |
| #define | HOMING_CYCLE_0 (1<<Z_AXIS) |
| Define the homing cycle patterns with bitmasks. The homing cycle first performs a search mode. More... | |
| #define | HOMING_CYCLE_1 ((1<<X_AXIS)|(1<<Y_AXIS)) |
| OPTIONAL: Then move X,Y at the same time. More... | |
| #define | N_HOMING_LOCATE_CYCLE 1 |
| NOTE: The following are two examples to setup homing for 2-axis machines. More... | |
| #define | N_STARTUP_LINE 2 |
| Enables single axis homing commands. $HX, $HY, and $HZ for X, Y, and Z-axis homing. The full homing. More... | |
| #define | N_DECIMAL_COORDVALUE_INCH 4 |
| Number of floating decimal points printed by Grbl for certain value types. These settings are. More... | |
| #define | N_DECIMAL_COORDVALUE_MM 3 |
| Coordinate or position value in mm. More... | |
| #define | N_DECIMAL_RATEVALUE_INCH 1 |
| Rate or velocity value in in/min. More... | |
| #define | N_DECIMAL_RATEVALUE_MM 0 |
| Rate or velocity value in mm/min. More... | |
| #define | N_DECIMAL_SETTINGVALUE 3 |
| Decimals for floating point setting values. More... | |
| #define | N_DECIMAL_RPMVALUE 0 |
| RPM value in rotations per min. More... | |
| #define | MESSAGE_PROBE_COORDINATES |
| If your machine has two limits switches wired in parallel to one axis, you will need to enable. More... | |
| #define | SAFETY_DOOR_SPINDLE_DELAY 4.0 |
| This option causes the feed hold input to act as a safety door switch. A safety door, when triggered,. More... | |
| #define | SAFETY_DOOR_COOLANT_DELAY 1.0 |
| Float (seconds) More... | |
| #define | CHECK_LIMITS_AT_INIT |
| Enable CoreXY kinematics. Use ONLY with CoreXY machines. More... | |
| #define | DEFAULT_FEED_OVERRIDE 100 |
More... | |
| #define | MAX_FEED_RATE_OVERRIDE 200 |
| Percent of programmed feed rate (100-255). Usually 120% or 200%. More... | |
| #define | MIN_FEED_RATE_OVERRIDE 10 |
| Percent of programmed feed rate (1-100). Usually 50% or 1%. More... | |
| #define | FEED_OVERRIDE_COARSE_INCREMENT 10 |
| (1-99). Usually 10%. More... | |
| #define | FEED_OVERRIDE_FINE_INCREMENT 1 |
| (1-99). Usually 1%. More... | |
| #define | DEFAULT_RAPID_OVERRIDE 100 |
| 100%. Don't change this value. More... | |
| #define | RAPID_OVERRIDE_MEDIUM 50 |
| Percent of rapid (1-99). Usually 50%. More... | |
| #define | RAPID_OVERRIDE_LOW 25 |
| Percent of rapid (1-99). Usually 25%. More... | |
| #define | DEFAULT_SPINDLE_SPEED_OVERRIDE 100 |
| 100%. Don't change this value. More... | |
| #define | MAX_SPINDLE_SPEED_OVERRIDE 200 |
| Percent of programmed spindle speed (100-255). Usually 200%. More... | |
| #define | MIN_SPINDLE_SPEED_OVERRIDE 10 |
| Percent of programmed spindle speed (1-100). Usually 10%. More... | |
| #define | SPINDLE_OVERRIDE_COARSE_INCREMENT 10 |
| (1-99). Usually 10%. More... | |
| #define | SPINDLE_OVERRIDE_FINE_INCREMENT 1 |
| (1-99). More... | |
| #define | RESTORE_OVERRIDES_AFTER_PROGRAM_END |
| When a M2 or M30 program end command is executed, most g-code states are restored to their defaults. More... | |
| #define | REPORT_FIELD_BUFFER_STATE |
| The status report change for Grbl v1.1 and after also removed the ability to disable/enable most data. More... | |
| #define | REPORT_FIELD_PIN_STATE |
| Default enabled. Comment to disable. More... | |
| #define | REPORT_FIELD_CURRENT_FEED_SPEED |
| Default enabled. Comment to disable. More... | |
| #define | REPORT_FIELD_WORK_COORD_OFFSET |
| Default enabled. Comment to disable. More... | |
| #define | REPORT_FIELD_OVERRIDES |
| Default enabled. Comment to disable. More... | |
| #define | REPORT_FIELD_LINE_NUMBERS |
| Default enabled. More... | |
| #define | REPORT_OVR_REFRESH_BUSY_COUNT 20 |
| Some status report data isn't necessary for realtime, only intermittently, because the values don't. More... | |
| #define | REPORT_OVR_REFRESH_IDLE_COUNT 10 |
| (1-255) Must be less than or equal to the busy count More... | |
| #define | REPORT_WCO_REFRESH_BUSY_COUNT 30 |
| (2-255) More... | |
| #define | REPORT_WCO_REFRESH_IDLE_COUNT 10 |
| (2-255) Must be less than or equal to the busy count More... | |
| #define | ACCELERATION_TICKS_PER_SECOND 100 |
| The temporal resolution of the acceleration management subsystem. A higher number gives smoother. More... | |
| #define | ADAPTIVE_MULTI_AXIS_STEP_SMOOTHING |
| Adaptive Multi-Axis Step Smoothing (AMASS) is an advanced feature that does what its name implies,. More... | |
| #define | TOOL_LENGTH_OFFSET_AXIS Z_AXIS |
| Sets the maximum step rate allowed to be written as a Grbl setting. This option enables an error. More... | |
| #define | MINIMUM_JUNCTION_SPEED 0.0 |
| Used by variable spindle output only. This forces the PWM output to a minimum duty cycle when enabled. More... | |
| #define | MINIMUM_FEED_RATE 1.0 |
| Sets the minimum feed rate the planner will allow. Any value below it will be set to this minimum. More... | |
| #define | N_ARC_CORRECTION 12 |
| Number of arc generation iterations by small angle approximation before exact arc trajectory. More... | |
| #define | ARC_ANGULAR_TRAVEL_EPSILON 5E-7 |
| The arc G2/3 g-code standard is problematic by definition. Radius-based arcs have horrible numerical. More... | |
| #define | DWELL_TIME_STEP 50 |
| Time delay increments performed during a dwell. The default value is set at 50ms, which provides. More... | |
| #define | ENABLE_RESTORE_EEPROM_WIPE_ALL |
| Creates a delay between the direction pin setting and corresponding step pulse by creating. More... | |
| #define | ENABLE_RESTORE_EEPROM_DEFAULT_SETTINGS |
| '$RST=$' Default enabled. Comment to disable. More... | |
| #define | ENABLE_RESTORE_EEPROM_CLEAR_PARAMETERS |
| '$RST=#' Default enabled. More... | |
| #define | ENABLE_BUILD_INFO_WRITE_COMMAND |
Defines the EEPROM data restored upon a settings version change and $RST=* command. Whenever the. More... | |
| #define | FORCE_BUFFER_SYNC_DURING_EEPROM_WRITE |
| AVR processors require all interrupts to be disabled during an EEPROM write. This includes both. More... | |
| #define | FORCE_BUFFER_SYNC_DURING_WCO_CHANGE |
In Grbl v0.9 and prior, there is an old outstanding bug where the WPos: work position reported. More... | |
| #define | PARKING_AXIS Z_AXIS |
| By default, Grbl disables feed rate overrides for all G38.x probe cycle commands. Although this. More... | |
| #define | PARKING_TARGET -5.0 |
| Parking axis target. In mm, as machine coordinate [-max_travel,0]. More... | |
| #define | PARKING_RATE 500.0 |
| Parking fast rate after pull-out in mm/min. More... | |
| #define | PARKING_PULLOUT_RATE 100.0 |
| Pull-out/plunge slow feed rate in mm/min. More... | |
| #define | PARKING_PULLOUT_INCREMENT 5.0 |
| Spindle pull-out and plunge distance in mm. Incremental distance. More... | |
| #define | SLEEP_DURATION 5.0 |
| Enables and configures Grbl's sleep mode feature. If the spindle or coolant are powered and Grbl. More... | |
| #define | DISABLE_LASER_DURING_HOLD |
| This option will automatically disable the laser during a feed hold by invoking a spindle stop. More... | |
| #define ACCELERATION_TICKS_PER_SECOND 100 |
| #define ADAPTIVE_MULTI_AXIS_STEP_SMOOTHING |
| #define ARC_ANGULAR_TRAVEL_EPSILON 5E-7 |
| #define CHECK_LIMITS_AT_INIT |
Enable CoreXY kinematics. Use ONLY with CoreXY machines.
NOTE: This configuration option alters the motion of the X and Y axes to principle of operation Inverts pin logic of the control command pins based on a mask. This essentially means you can use NOTE: The top option will mask and invert all control pins. The bottom option is an example of Inverts select limit pin states based on the following mask. This effects all limit pin functions, NOTE: PLEASE DO NOT USE THIS, unless you have a situation that needs it. Inverts the spindle enable pin from low-disabled/high-enabled to low-enabled/high-disabled. Useful Inverts the selected coolant pin from low-disabled/high-enabled to low-enabled/high-disabled. Useful When Grbl powers-cycles or is hard reset with the Arduino reset button, Grbl boots up with no ALARM At power-up or a reset, Grbl will check the limit switch states to ensure they are not active
| #define CMD_DEBUG_REPORT 0x86 |
| #define CMD_FEED_OVR_RESET 0x90 |
| #define CMD_RAPID_OVR_RESET 0x95 |
| #define CMD_RESET 0x18 |
| #define CMD_SAFETY_DOOR 0x84 |
| #define CMD_SPINDLE_OVR_RESET 0x99 |
| #define DEFAULT_FEED_OVERRIDE 100 |
| #define DEFAULT_RAPID_OVERRIDE 100 |
| #define DEFAULT_SPINDLE_SPEED_OVERRIDE 100 |
| #define DEFAULTS_GENERIC |
This file contains compile-time configurations for Grbl's internal system. For the most part,.
IMPORTANT: Any changes here requires a full re-compiling of the source code to propagate them. Define CPU pin map and default settings. NOTE: OEMs can avoid the need to maintain/update the defaults.h and cpu_map.h files and use only
| #define DISABLE_LASER_DURING_HOLD |
| #define DWELL_TIME_STEP 50 |
| #define ENABLE_BUILD_INFO_WRITE_COMMAND |
Defines the EEPROM data restored upon a settings version change and $RST=* command. Whenever the.
NOTE: Uncomment to override defaults in settings.h Enable the '$I=(string)' build info write command. If disabled, any existing build info data must NOTE: If disabled and to ensure Grbl can never alter the build info line, you'll also need to enable NOTE: See the included grblWrite_BuildInfo.ino example file to write this string seperately. '$I=' Default enabled. Comment to disable.
| #define ENABLE_RESTORE_EEPROM_CLEAR_PARAMETERS |
| #define ENABLE_RESTORE_EEPROM_DEFAULT_SETTINGS |
| #define ENABLE_RESTORE_EEPROM_WIPE_ALL |
Creates a delay between the direction pin setting and corresponding step pulse by creating.
NOTE: Uncomment to enable. The recommended delay must be > 3us, and, when added with the The number of linear motions in the planner buffer to be planned at any give time. The vast Governs the size of the intermediary step segment buffer between the step execution algorithm Line buffer size from the serial input stream to be executed. Also, governs the size of NOTE: 80 characters is not a problem except for extreme cases, but the line buffer size NOTE: Buffer size values must be greater than zero and less than 256. The maximum line length of a data string stored in EEPROM. Used by startup lines and build NOTE: Be very careful when changing this value. Check EEPROM address locations to make sure A simple software debouncing feature for hard limit switches. When enabled, the interrupt Configures the position after a probing cycle during Grbl's check mode. Disabled sets Force Grbl to check the state of the hard limit switches when the processor detects a pin NOTE: This option has no effect if SOFTWARE_DEBOUNCE is enabled. Adjusts homing cycle search and locate scalars. These are the multipliers used by Grbl's NOTE: Both of these values must be greater than 1.0 to ensure proper function. Enable the '$RST=*', '$RST=$', and '$RST=#' eeprom restore commands. There are cases where NOTE: See SETTINGS_RESTORE_ALL macro for customizing the $RST=* command. '$RST=*' Default enabled. Comment to disable.
| #define FEED_OVERRIDE_COARSE_INCREMENT 10 |
| #define FORCE_BUFFER_SYNC_DURING_EEPROM_WRITE |
| #define FORCE_BUFFER_SYNC_DURING_WCO_CHANGE |
| #define HOMING_CYCLE_0 (1<<Z_AXIS) |
Define the homing cycle patterns with bitmasks. The homing cycle first performs a search mode.
NOTE: The homing cycle is designed to allow sharing of limit pins, if the axes are not in the same NOTE: Defaults are set for a traditional 3-axis CNC machine. Z-axis first to clear, followed by X & Y. REQUIRED: First move Z to clear workspace.
| #define HOMING_INIT_LOCK |
| #define MAX_FEED_RATE_OVERRIDE 200 |
| #define MAX_SPINDLE_SPEED_OVERRIDE 200 |
| #define MESSAGE_PROBE_COORDINATES |
| #define MIN_FEED_RATE_OVERRIDE 10 |
| #define MIN_SPINDLE_SPEED_OVERRIDE 10 |
| #define MINIMUM_FEED_RATE 1.0 |
| #define MINIMUM_JUNCTION_SPEED 0.0 |
Used by variable spindle output only. This forces the PWM output to a minimum duty cycle when enabled.
NOTE: Compute duty cycle at the minimum PWM by this equation: (% duty cycle)=(SPINDLE_PWM_MIN_VALUE/255)*100 With this enabled, Grbl sends back an echo of the line it has received, which has been pre-parsed (spaces NOTE: Only use this for debugging purposes!! When echoing, this takes up valuable resources and can effect Minimum planner junction speed. Sets the default minimum junction speed the planner plans to at (mm/min)
| #define N_ARC_CORRECTION 12 |
| #define N_DECIMAL_COORDVALUE_INCH 4 |
| #define N_DECIMAL_COORDVALUE_MM 3 |
| #define N_DECIMAL_RATEVALUE_INCH 1 |
| #define N_DECIMAL_RATEVALUE_MM 0 |
| #define N_DECIMAL_RPMVALUE 0 |
| #define N_DECIMAL_SETTINGVALUE 3 |
| #define N_HOMING_LOCATE_CYCLE 1 |
| #define N_STARTUP_LINE 2 |
Enables single axis homing commands. $HX, $HY, and $HZ for X, Y, and Z-axis homing. The full homing.
After homing, Grbl will set by default the entire machine space into negative space, as is typical Number of blocks Grbl executes upon startup. These blocks are stored in EEPROM, where the size Integer (1-2)
| #define PARKING_AXIS Z_AXIS |
By default, Grbl disables feed rate overrides for all G38.x probe cycle commands. Although this.
Enables and configures parking motion methods upon a safety door state. Primarily for OEMs NOTE: Still a work-in-progress. Machine coordinates must be in all negative space and Configure options for the parking motion, if enabled. Define which axis that performs the parking motion
| #define PARKING_PULLOUT_INCREMENT 5.0 |
| #define PARKING_PULLOUT_RATE 100.0 |
| #define PARKING_RATE 500.0 |
| #define PARKING_TARGET -5.0 |
| #define RAPID_OVERRIDE_LOW 25 |
| #define RAPID_OVERRIDE_MEDIUM 50 |
| #define REPORT_FIELD_BUFFER_STATE |
| #define REPORT_FIELD_CURRENT_FEED_SPEED |
| #define REPORT_FIELD_LINE_NUMBERS |
| #define REPORT_FIELD_OVERRIDES |
| #define REPORT_FIELD_PIN_STATE |
| #define REPORT_FIELD_WORK_COORD_OFFSET |
| #define REPORT_OVR_REFRESH_BUSY_COUNT 20 |
| #define REPORT_OVR_REFRESH_IDLE_COUNT 10 |
| #define REPORT_WCO_REFRESH_IDLE_COUNT 10 |
| #define RESTORE_OVERRIDES_AFTER_PROGRAM_END |
| #define SAFETY_DOOR_SPINDLE_DELAY 4.0 |
| #define SLEEP_DURATION 5.0 |
| #define SPINDLE_OVERRIDE_COARSE_INCREMENT 10 |
| #define SPINDLE_OVERRIDE_FINE_INCREMENT 1 |
| #define TOOL_LENGTH_OFFSET_AXIS Z_AXIS |
Sets the maximum step rate allowed to be written as a Grbl setting. This option enables an error.
NOTE: For now disabled, will enable if flash space permits. By default, Grbl sets all input pins to normal-high operation with their internal pull-up resistors NOTE: All pins associated with the feature are disabled, i.e. XYZ limit pins, not individual axes. Sets which axis the tool length offset is applied. Assumes the spindle is always parallel with Default z-axis. Valid values are X_AXIS, Y_AXIS, or Z_AXIS.
1.8.10