grblHAL core  20241107
grbl.h File Reference
#include <stdint.h>
#include <stdbool.h>
#include "config.h"

Go to the source code of this file.

Macros

#define GRBL_VERSION   "1.1f"
 
#define GRBL_BUILD   20241107
 
#define GRBL_URL   "https://github.com/grblHAL"
 
#define ISR_CODE
 Used by some drivers to force a function to always stay in RAM to improve performance. More...
 
#define ISR_FUNC(fn)   fn
 
#define CMD_EXIT   0x03
 
#define CMD_REBOOT   0x14
 
#define CMD_RESET   0x18
 
#define CMD_STOP   0x19
 
#define CMD_STATUS_REPORT_LEGACY   '?'
 
#define CMD_CYCLE_START_LEGACY   '~'
 
#define CMD_FEED_HOLD_LEGACY   '!'
 
#define CMD_PROGRAM_DEMARCATION   '%'
 
#define CMD_STATUS_REPORT   0x80
 
#define CMD_CYCLE_START   0x81
 
#define CMD_FEED_HOLD   0x82
 
#define CMD_GCODE_REPORT   0x83
 
#define CMD_SAFETY_DOOR   0x84
 
#define CMD_JOG_CANCEL   0x85
 
#define CMD_STATUS_REPORT_ALL   0x87
 
#define CMD_OPTIONAL_STOP_TOGGLE   0x88
 
#define CMD_SINGLE_BLOCK_TOGGLE   0x89
 
#define CMD_OVERRIDE_FAN0_TOGGLE   0x8A
 
#define CMD_MPG_MODE_TOGGLE   0x8B
 
#define CMD_AUTO_REPORTING_TOGGLE   0x8C
 
#define CMD_OVERRIDE_FEED_RESET   0x90
 
#define CMD_OVERRIDE_FEED_COARSE_PLUS   0x91
 
#define CMD_OVERRIDE_FEED_COARSE_MINUS   0x92
 
#define CMD_OVERRIDE_FEED_FINE_PLUS   0x93
 
#define CMD_OVERRIDE_FEED_FINE_MINUS   0x94
 
#define CMD_OVERRIDE_RAPID_RESET   0x95
 
#define CMD_OVERRIDE_RAPID_MEDIUM   0x96
 
#define CMD_OVERRIDE_RAPID_LOW   0x97
 
#define CMD_OVERRIDE_SPINDLE_RESET   0x99
 
#define CMD_OVERRIDE_SPINDLE_COARSE_PLUS   0x9A
 
#define CMD_OVERRIDE_SPINDLE_COARSE_MINUS   0x9B
 
#define CMD_OVERRIDE_SPINDLE_FINE_PLUS   0x9C
 
#define CMD_OVERRIDE_SPINDLE_FINE_MINUS   0x9D
 
#define CMD_OVERRIDE_SPINDLE_STOP   0x9E
 
#define CMD_OVERRIDE_COOLANT_FLOOD_TOGGLE   0xA0
 
#define CMD_OVERRIDE_COOLANT_MIST_TOGGLE   0xA1
 
#define CMD_PID_REPORT   0xA2
 
#define CMD_TOOL_ACK   0xA3
 
#define CMD_PROBE_CONNECTED_TOGGLE   0xA4
 
#define JOG_LINE_NUMBER   0
 
#define N_STARTUP_LINE   2
 
#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_SETTINGVALUE   3
 
#define N_DECIMAL_RPMVALUE   0
 
#define N_DECIMAL_PIDVALUE   3
 
#define DEFAULT_FEED_OVERRIDE   100
 
#define FEED_OVERRIDE_COARSE_INCREMENT   10
 
#define FEED_OVERRIDE_FINE_INCREMENT   1
 
#define DEFAULT_RAPID_OVERRIDE   100
 
#define RAPID_OVERRIDE_MEDIUM   50
 
#define RAPID_OVERRIDE_LOW   25
 
#define DEFAULT_SPINDLE_RPM_OVERRIDE   100
 
#define SPINDLE_OVERRIDE_COARSE_INCREMENT   10
 
#define SPINDLE_OVERRIDE_FINE_INCREMENT   1
 
#define ADAPTIVE_MULTI_AXIS_STEP_SMOOTHING
 
#define MAX_STORED_LINE_LENGTH   70
 
#define N_SPINDLE_SELECTABLE   N_SPINDLE
 

Typedefs

typedef uint_fast16_t override_t
 

Macro Definition Documentation

◆ ADAPTIVE_MULTI_AXIS_STEP_SMOOTHING

#define ADAPTIVE_MULTI_AXIS_STEP_SMOOTHING

◆ CMD_AUTO_REPORTING_TOGGLE

#define CMD_AUTO_REPORTING_TOGGLE   0x8C

◆ CMD_CYCLE_START

#define CMD_CYCLE_START   0x81

◆ CMD_CYCLE_START_LEGACY

#define CMD_CYCLE_START_LEGACY   '~'

◆ CMD_EXIT

#define CMD_EXIT   0x03

◆ CMD_FEED_HOLD

#define CMD_FEED_HOLD   0x82

◆ CMD_FEED_HOLD_LEGACY

#define CMD_FEED_HOLD_LEGACY   '!'

◆ CMD_GCODE_REPORT

#define CMD_GCODE_REPORT   0x83

◆ CMD_JOG_CANCEL

#define CMD_JOG_CANCEL   0x85

◆ CMD_MPG_MODE_TOGGLE

#define CMD_MPG_MODE_TOGGLE   0x8B

◆ CMD_OPTIONAL_STOP_TOGGLE

#define CMD_OPTIONAL_STOP_TOGGLE   0x88

◆ CMD_OVERRIDE_COOLANT_FLOOD_TOGGLE

#define CMD_OVERRIDE_COOLANT_FLOOD_TOGGLE   0xA0

◆ CMD_OVERRIDE_COOLANT_MIST_TOGGLE

#define CMD_OVERRIDE_COOLANT_MIST_TOGGLE   0xA1

◆ CMD_OVERRIDE_FAN0_TOGGLE

#define CMD_OVERRIDE_FAN0_TOGGLE   0x8A

◆ CMD_OVERRIDE_FEED_COARSE_MINUS

#define CMD_OVERRIDE_FEED_COARSE_MINUS   0x92

◆ CMD_OVERRIDE_FEED_COARSE_PLUS

#define CMD_OVERRIDE_FEED_COARSE_PLUS   0x91

◆ CMD_OVERRIDE_FEED_FINE_MINUS

#define CMD_OVERRIDE_FEED_FINE_MINUS   0x94

◆ CMD_OVERRIDE_FEED_FINE_PLUS

#define CMD_OVERRIDE_FEED_FINE_PLUS   0x93

◆ CMD_OVERRIDE_FEED_RESET

#define CMD_OVERRIDE_FEED_RESET   0x90

◆ CMD_OVERRIDE_RAPID_LOW

#define CMD_OVERRIDE_RAPID_LOW   0x97

◆ CMD_OVERRIDE_RAPID_MEDIUM

#define CMD_OVERRIDE_RAPID_MEDIUM   0x96

◆ CMD_OVERRIDE_RAPID_RESET

#define CMD_OVERRIDE_RAPID_RESET   0x95

◆ CMD_OVERRIDE_SPINDLE_COARSE_MINUS

#define CMD_OVERRIDE_SPINDLE_COARSE_MINUS   0x9B

◆ CMD_OVERRIDE_SPINDLE_COARSE_PLUS

#define CMD_OVERRIDE_SPINDLE_COARSE_PLUS   0x9A

◆ CMD_OVERRIDE_SPINDLE_FINE_MINUS

#define CMD_OVERRIDE_SPINDLE_FINE_MINUS   0x9D

◆ CMD_OVERRIDE_SPINDLE_FINE_PLUS

#define CMD_OVERRIDE_SPINDLE_FINE_PLUS   0x9C

◆ CMD_OVERRIDE_SPINDLE_RESET

#define CMD_OVERRIDE_SPINDLE_RESET   0x99

◆ CMD_OVERRIDE_SPINDLE_STOP

#define CMD_OVERRIDE_SPINDLE_STOP   0x9E

◆ CMD_PID_REPORT

#define CMD_PID_REPORT   0xA2

◆ CMD_PROBE_CONNECTED_TOGGLE

#define CMD_PROBE_CONNECTED_TOGGLE   0xA4

◆ CMD_PROGRAM_DEMARCATION

#define CMD_PROGRAM_DEMARCATION   '%'

◆ CMD_REBOOT

#define CMD_REBOOT   0x14

◆ CMD_RESET

#define CMD_RESET   0x18

◆ CMD_SAFETY_DOOR

#define CMD_SAFETY_DOOR   0x84

◆ CMD_SINGLE_BLOCK_TOGGLE

#define CMD_SINGLE_BLOCK_TOGGLE   0x89

◆ CMD_STATUS_REPORT

#define CMD_STATUS_REPORT   0x80

◆ CMD_STATUS_REPORT_ALL

#define CMD_STATUS_REPORT_ALL   0x87

◆ CMD_STATUS_REPORT_LEGACY

#define CMD_STATUS_REPORT_LEGACY   '?'

◆ CMD_STOP

#define CMD_STOP   0x19

◆ CMD_TOOL_ACK

#define CMD_TOOL_ACK   0xA3

◆ DEFAULT_FEED_OVERRIDE

#define DEFAULT_FEED_OVERRIDE   100

◆ DEFAULT_RAPID_OVERRIDE

#define DEFAULT_RAPID_OVERRIDE   100

◆ DEFAULT_SPINDLE_RPM_OVERRIDE

#define DEFAULT_SPINDLE_RPM_OVERRIDE   100

◆ FEED_OVERRIDE_COARSE_INCREMENT

#define FEED_OVERRIDE_COARSE_INCREMENT   10

◆ FEED_OVERRIDE_FINE_INCREMENT

#define FEED_OVERRIDE_FINE_INCREMENT   1

◆ GRBL_BUILD

#define GRBL_BUILD   20241107

◆ GRBL_URL

#define GRBL_URL   "https://github.com/grblHAL"

◆ GRBL_VERSION

#define GRBL_VERSION   "1.1f"

◆ ISR_CODE

#define ISR_CODE

Used by some drivers to force a function to always stay in RAM to improve performance.

◆ ISR_FUNC

#define ISR_FUNC (   fn)    fn

◆ JOG_LINE_NUMBER

#define JOG_LINE_NUMBER   0

◆ MAX_STORED_LINE_LENGTH

#define MAX_STORED_LINE_LENGTH   70

◆ N_DECIMAL_COORDVALUE_INCH

#define N_DECIMAL_COORDVALUE_INCH   4

◆ N_DECIMAL_COORDVALUE_MM

#define N_DECIMAL_COORDVALUE_MM   3

◆ N_DECIMAL_PIDVALUE

#define N_DECIMAL_PIDVALUE   3

◆ N_DECIMAL_RATEVALUE_INCH

#define N_DECIMAL_RATEVALUE_INCH   1

◆ N_DECIMAL_RATEVALUE_MM

#define N_DECIMAL_RATEVALUE_MM   0

◆ N_DECIMAL_RPMVALUE

#define N_DECIMAL_RPMVALUE   0

◆ N_DECIMAL_SETTINGVALUE

#define N_DECIMAL_SETTINGVALUE   3

◆ N_SPINDLE_SELECTABLE

#define N_SPINDLE_SELECTABLE   N_SPINDLE

◆ N_STARTUP_LINE

#define N_STARTUP_LINE   2

◆ RAPID_OVERRIDE_LOW

#define RAPID_OVERRIDE_LOW   25

◆ RAPID_OVERRIDE_MEDIUM

#define RAPID_OVERRIDE_MEDIUM   50

◆ SPINDLE_OVERRIDE_COARSE_INCREMENT

#define SPINDLE_OVERRIDE_COARSE_INCREMENT   10

◆ SPINDLE_OVERRIDE_FINE_INCREMENT

#define SPINDLE_OVERRIDE_FINE_INCREMENT   1

Typedef Documentation

◆ override_t

typedef uint_fast16_t override_t