gnea\grbl-Mega  1.0f
Source Code Documentation ( Internal Workings )
report.h File Reference

Go to the source code of this file.

Macros

#define STATUS_OK   0
 Define Grbl status codes. Valid values (0-255) More...
 
#define STATUS_EXPECTED_COMMAND_LETTER   1
 
#define STATUS_BAD_NUMBER_FORMAT   2
 
#define STATUS_INVALID_STATEMENT   3
 
#define STATUS_NEGATIVE_VALUE   4
 
#define STATUS_SETTING_DISABLED   5
 
#define STATUS_SETTING_STEP_PULSE_MIN   6
 
#define STATUS_SETTING_READ_FAIL   7
 
#define STATUS_IDLE_ERROR   8
 
#define STATUS_SYSTEM_GC_LOCK   9
 
#define STATUS_SOFT_LIMIT_ERROR   10
 
#define STATUS_OVERFLOW   11
 
#define STATUS_MAX_STEP_RATE_EXCEEDED   12
 
#define STATUS_CHECK_DOOR   13
 
#define STATUS_LINE_LENGTH_EXCEEDED   14
 
#define STATUS_TRAVEL_EXCEEDED   15
 
#define STATUS_INVALID_JOG_COMMAND   16
 
#define STATUS_GCODE_UNSUPPORTED_COMMAND   20
 
#define STATUS_GCODE_MODAL_GROUP_VIOLATION   21
 
#define STATUS_GCODE_UNDEFINED_FEED_RATE   22
 
#define STATUS_GCODE_COMMAND_VALUE_NOT_INTEGER   23
 
#define STATUS_GCODE_AXIS_COMMAND_CONFLICT   24
 
#define STATUS_GCODE_WORD_REPEATED   25
 
#define STATUS_GCODE_NO_AXIS_WORDS   26
 
#define STATUS_GCODE_INVALID_LINE_NUMBER   27
 
#define STATUS_GCODE_VALUE_WORD_MISSING   28
 
#define STATUS_GCODE_UNSUPPORTED_COORD_SYS   29
 
#define STATUS_GCODE_G53_INVALID_MOTION_MODE   30
 
#define STATUS_GCODE_AXIS_WORDS_EXIST   31
 
#define STATUS_GCODE_NO_AXIS_WORDS_IN_PLANE   32
 
#define STATUS_GCODE_INVALID_TARGET   33
 
#define STATUS_GCODE_ARC_RADIUS_ERROR   34
 
#define STATUS_GCODE_NO_OFFSETS_IN_PLANE   35
 
#define STATUS_GCODE_UNUSED_WORDS   36
 
#define STATUS_GCODE_G43_DYNAMIC_AXIS_ERROR   37
 
#define STATUS_GCODE_MAX_VALUE_EXCEEDED   38
 
#define ALARM_HARD_LIMIT_ERROR   EXEC_ALARM_HARD_LIMIT
 Define Grbl alarm codes. Valid values (1-255). 0 is reserved. More...
 
#define ALARM_SOFT_LIMIT_ERROR   EXEC_ALARM_SOFT_LIMIT
 
#define ALARM_ABORT_CYCLE   EXEC_ALARM_ABORT_CYCLE
 
#define ALARM_PROBE_FAIL_INITIAL   EXEC_ALARM_PROBE_FAIL_INITIAL
 
#define ALARM_PROBE_FAIL_CONTACT   EXEC_ALARM_PROBE_FAIL_CONTACT
 
#define ALARM_HOMING_FAIL_RESET   EXEC_ALARM_HOMING_FAIL_RESET
 
#define ALARM_HOMING_FAIL_DOOR   EXEC_ALARM_HOMING_FAIL_DOOR
 
#define ALARM_HOMING_FAIL_PULLOFF   EXEC_ALARM_HOMING_FAIL_PULLOFF
 
#define ALARM_HOMING_FAIL_APPROACH   EXEC_ALARM_HOMING_FAIL_APPROACH
 
#define MESSAGE_CRITICAL_EVENT   1
 Define Grbl feedback message codes. Valid values (0-255). More...
 
#define MESSAGE_ALARM_LOCK   2
 
#define MESSAGE_ALARM_UNLOCK   3
 
#define MESSAGE_ENABLED   4
 
#define MESSAGE_DISABLED   5
 
#define MESSAGE_SAFETY_DOOR_AJAR   6
 
#define MESSAGE_CHECK_LIMITS   7
 
#define MESSAGE_PROGRAM_END   8
 
#define MESSAGE_RESTORE_DEFAULTS   9
 
#define MESSAGE_SPINDLE_RESTORE   10
 
#define MESSAGE_SLEEP_MODE   11
 

Functions

void report_status_message (uint8_t status_code)
 Prints system status messages. More...
 
void report_alarm_message (uint8_t alarm_code)
 Prints system alarm messages. More...
 
void report_feedback_message (uint8_t message_code)
 Prints miscellaneous feedback messages. More...
 
void report_init_message ()
 Prints welcome message. More...
 
void report_grbl_help ()
 Prints Grbl help and current global settings. More...
 
void report_grbl_settings ()
 Prints Grbl global settings. More...
 
void report_echo_line_received (char *line)
 Prints an echo of the pre-parsed line received right before execution. More...
 
void report_realtime_status ()
 Prints realtime status report. More...
 
void report_probe_parameters ()
 Prints recorded probe position. More...
 
void report_ngc_parameters ()
 Prints Grbl NGC parameters (coordinate offsets, probe) More...
 
void report_gcode_modes ()
 Prints current g-code parser mode state. More...
 
void report_startup_line (uint8_t n, char *line)
 Prints startup line when requested and executed. More...
 
void report_execute_startup_message (char *line, uint8_t status_code)
 
void report_build_info (char *line)
 Prints build info and user info. More...
 

Macro Definition Documentation

#define ALARM_ABORT_CYCLE   EXEC_ALARM_ABORT_CYCLE

Definition at line 63 of file report.h.

#define ALARM_HARD_LIMIT_ERROR   EXEC_ALARM_HARD_LIMIT

Define Grbl alarm codes. Valid values (1-255). 0 is reserved.

Definition at line 61 of file report.h.

#define ALARM_HOMING_FAIL_APPROACH   EXEC_ALARM_HOMING_FAIL_APPROACH

Definition at line 69 of file report.h.

#define ALARM_HOMING_FAIL_DOOR   EXEC_ALARM_HOMING_FAIL_DOOR

Definition at line 67 of file report.h.

#define ALARM_HOMING_FAIL_PULLOFF   EXEC_ALARM_HOMING_FAIL_PULLOFF

Definition at line 68 of file report.h.

#define ALARM_HOMING_FAIL_RESET   EXEC_ALARM_HOMING_FAIL_RESET

Definition at line 66 of file report.h.

#define ALARM_PROBE_FAIL_CONTACT   EXEC_ALARM_PROBE_FAIL_CONTACT

Definition at line 65 of file report.h.

#define ALARM_PROBE_FAIL_INITIAL   EXEC_ALARM_PROBE_FAIL_INITIAL

Definition at line 64 of file report.h.

#define ALARM_SOFT_LIMIT_ERROR   EXEC_ALARM_SOFT_LIMIT

Definition at line 62 of file report.h.

#define MESSAGE_ALARM_LOCK   2

Definition at line 72 of file report.h.

#define MESSAGE_ALARM_UNLOCK   3

Definition at line 73 of file report.h.

#define MESSAGE_CHECK_LIMITS   7

Definition at line 77 of file report.h.

#define MESSAGE_CRITICAL_EVENT   1

Define Grbl feedback message codes. Valid values (0-255).

Definition at line 71 of file report.h.

#define MESSAGE_DISABLED   5

Definition at line 75 of file report.h.

#define MESSAGE_ENABLED   4

Definition at line 74 of file report.h.

#define MESSAGE_PROGRAM_END   8

Definition at line 78 of file report.h.

#define MESSAGE_RESTORE_DEFAULTS   9

Definition at line 79 of file report.h.

#define MESSAGE_SAFETY_DOOR_AJAR   6

Definition at line 76 of file report.h.

#define MESSAGE_SLEEP_MODE   11

Definition at line 81 of file report.h.

#define MESSAGE_SPINDLE_RESTORE   10

Definition at line 80 of file report.h.

#define STATUS_BAD_NUMBER_FORMAT   2

Definition at line 25 of file report.h.

#define STATUS_CHECK_DOOR   13

Definition at line 36 of file report.h.

#define STATUS_EXPECTED_COMMAND_LETTER   1

Definition at line 24 of file report.h.

#define STATUS_GCODE_ARC_RADIUS_ERROR   34

Definition at line 55 of file report.h.

#define STATUS_GCODE_AXIS_COMMAND_CONFLICT   24

Definition at line 45 of file report.h.

#define STATUS_GCODE_AXIS_WORDS_EXIST   31

Definition at line 52 of file report.h.

#define STATUS_GCODE_COMMAND_VALUE_NOT_INTEGER   23

Definition at line 44 of file report.h.

#define STATUS_GCODE_G43_DYNAMIC_AXIS_ERROR   37

Definition at line 58 of file report.h.

#define STATUS_GCODE_G53_INVALID_MOTION_MODE   30

Definition at line 51 of file report.h.

#define STATUS_GCODE_INVALID_LINE_NUMBER   27

Definition at line 48 of file report.h.

#define STATUS_GCODE_INVALID_TARGET   33

Definition at line 54 of file report.h.

#define STATUS_GCODE_MAX_VALUE_EXCEEDED   38

Definition at line 59 of file report.h.

#define STATUS_GCODE_MODAL_GROUP_VIOLATION   21

Definition at line 42 of file report.h.

#define STATUS_GCODE_NO_AXIS_WORDS   26

Definition at line 47 of file report.h.

#define STATUS_GCODE_NO_AXIS_WORDS_IN_PLANE   32

Definition at line 53 of file report.h.

#define STATUS_GCODE_NO_OFFSETS_IN_PLANE   35

Definition at line 56 of file report.h.

#define STATUS_GCODE_UNDEFINED_FEED_RATE   22

Definition at line 43 of file report.h.

#define STATUS_GCODE_UNSUPPORTED_COMMAND   20

Definition at line 41 of file report.h.

#define STATUS_GCODE_UNSUPPORTED_COORD_SYS   29

Definition at line 50 of file report.h.

#define STATUS_GCODE_UNUSED_WORDS   36

Definition at line 57 of file report.h.

#define STATUS_GCODE_VALUE_WORD_MISSING   28

Definition at line 49 of file report.h.

#define STATUS_GCODE_WORD_REPEATED   25

Definition at line 46 of file report.h.

#define STATUS_IDLE_ERROR   8

Definition at line 31 of file report.h.

#define STATUS_INVALID_JOG_COMMAND   16

Definition at line 39 of file report.h.

#define STATUS_INVALID_STATEMENT   3

Definition at line 26 of file report.h.

#define STATUS_LINE_LENGTH_EXCEEDED   14

Definition at line 37 of file report.h.

#define STATUS_MAX_STEP_RATE_EXCEEDED   12

Definition at line 35 of file report.h.

#define STATUS_NEGATIVE_VALUE   4

Definition at line 27 of file report.h.

#define STATUS_OK   0

Define Grbl status codes. Valid values (0-255)

Definition at line 23 of file report.h.

#define STATUS_OVERFLOW   11

Definition at line 34 of file report.h.

#define STATUS_SETTING_DISABLED   5

Definition at line 28 of file report.h.

#define STATUS_SETTING_READ_FAIL   7

Definition at line 30 of file report.h.

#define STATUS_SETTING_STEP_PULSE_MIN   6

Definition at line 29 of file report.h.

#define STATUS_SOFT_LIMIT_ERROR   10

Definition at line 33 of file report.h.

#define STATUS_SYSTEM_GC_LOCK   9

Definition at line 32 of file report.h.

#define STATUS_TRAVEL_EXCEEDED   15

Definition at line 38 of file report.h.

Function Documentation

void report_alarm_message ( uint8_t  alarm_code)

Prints system alarm messages.

Prints system alarm messages.

< Force delay to ensure message clears serial write buffer.

Definition at line 122 of file report.c.

void report_build_info ( char *  line)

Prints build info and user info.

Prints build info and user info.

< Generate compile-time build option list

<

<

<

<

<

<

NOTE: Compiled values, like override increments/max/min values, may be added at some point later.

Definition at line 342 of file report.c.

void report_echo_line_received ( char *  line)

Prints an echo of the pre-parsed line received right before execution.

Prints an echo of the pre-parsed line received right before execution.

Definition at line 402 of file report.c.

void report_execute_startup_message ( char *  line,
uint8_t  status_code 
)

Definition at line 334 of file report.c.

void report_feedback_message ( uint8_t  message_code)

Prints miscellaneous feedback messages.

Prints miscellaneous feedback messages.

NOTE: For interfaces, messages are always placed within brackets. And if silent mode

Definition at line 135 of file report.c.

void report_gcode_modes ( )

Prints current g-code parser mode state.

Prints current g-code parser mode state.

< Note: Multiple coolant states may be active at the same time.

Definition at line 263 of file report.c.

void report_grbl_help ( )

Prints Grbl help and current global settings.

Prints Grbl help and current global settings.

Definition at line 171 of file report.c.

void report_grbl_settings ( )

Prints Grbl global settings.

Prints Grbl global settings.

NOTE: The numbering scheme here must correlate to storing in settings.c

Definition at line 178 of file report.c.

void report_init_message ( )

Prints welcome message.

Prints welcome message.

Definition at line 166 of file report.c.

void report_ngc_parameters ( )

Prints Grbl NGC parameters (coordinate offsets, probe)

Prints Grbl NGC parameters (coordinate offsets, probe)

< G54-G59

< Print G92,G92.1 which are not persistent in memory

< Print tool length offset value

< Print probe parameters. Not persistent in memory.

Definition at line 234 of file report.c.

void report_probe_parameters ( )

Prints recorded probe position.

Prints recorded probe position.

Definition at line 221 of file report.c.

void report_realtime_status ( )

Prints realtime status report.

< Copy current state of the system position variable

< Restoring

< Door ajar

< Retracting

< Reset counter for slow refresh

< Reset counter for slow refresh

< != SPINDLE_STATE_DISABLE

Definition at line 414 of file report.c.

void report_startup_line ( uint8_t  n,
char *  line 
)

Prints startup line when requested and executed.

Prints startup line when requested and executed.

Definition at line 325 of file report.c.

void report_status_message ( uint8_t  status_code)

Prints system status messages.

Prints system status messages.

< STATUS_OK

Definition at line 110 of file report.c.