grblHAL core  20241107
grbl_t Struct Reference

#include <core_handlers.h>

Data Fields

report_t report
 
tool_table_t tool_table
 
on_parser_init_ptr on_parser_init
 
on_state_change_ptr on_state_change
 
on_override_changed_ptr on_override_changed
 
on_report_handlers_init_ptr on_report_handlers_init
 
on_spindle_programmed_ptr on_spindle_programmed
 
on_wco_changed_ptr on_wco_changed
 
on_program_completed_ptr on_program_completed
 
on_execute_realtime_ptr on_execute_realtime
 
on_execute_realtime_ptr on_execute_delay
 
on_unknown_accessory_override_ptr on_unknown_accessory_override
 
on_report_options_ptr on_report_options
 
on_report_ngc_parameters_ptr on_report_ngc_parameters
 
on_report_command_help_ptr on_report_command_help
 Deprecated, use system_register_commands() to register new commands. More...
 
on_rt_reports_added_ptr on_rt_reports_added
 
on_global_settings_restore_ptr on_global_settings_restore
 
on_setting_get_description_ptr on_setting_get_description
 
on_get_alarms_ptr on_get_alarms
 
on_get_errors_ptr on_get_errors
 
on_get_settings_ptr on_get_settings
 
on_realtime_report_ptr on_realtime_report
 
on_unknown_feedback_message_ptr on_unknown_feedback_message
 
on_unknown_realtime_cmd_ptr on_unknown_realtime_cmd
 
on_unknown_sys_command_ptr on_unknown_sys_command
 return Status_Unhandled if not handled. More...
 
on_get_commands_ptr on_get_commands
 Deprecated, use system_register_commands() to register new commands. More...
 
on_user_command_ptr on_user_command
 
on_stream_changed_ptr on_stream_changed
 
on_homing_rate_set_ptr on_homing_rate_set
 
on_homing_completed_ptr on_homing_completed
 
on_probe_toolsetter_ptr on_probe_toolsetter
 
on_probe_start_ptr on_probe_start
 
on_probe_completed_ptr on_probe_completed
 
on_set_axis_setting_unit_ptr on_set_axis_setting_unit
 
on_gcode_message_ptr on_gcode_message
 Called on output of message parsed from gcode. NOTE: string pointed to is freed after this call. More...
 
on_gcode_message_ptr on_gcode_comment
 Called when a plain gcode comment has been parsed. More...
 
on_tool_selected_ptr on_tool_selected
 Called prior to executing M6 or after executing M61. More...
 
on_tool_changed_ptr on_tool_changed
 Called after executing M6 or M61. More...
 
on_toolchange_ack_ptr on_toolchange_ack
 Called from interrupt context. More...
 
on_jog_cancel_ptr on_jog_cancel
 Called from interrupt context. More...
 
on_laser_ppi_enable_ptr on_laser_ppi_enable
 
on_spindle_select_ptr on_spindle_select
 Called before spindle is selected, hook in HAL overrides here. More...
 
on_spindle_selected_ptr on_spindle_selected
 Called when spindle is selected, do not change HAL pointers here! More...
 
on_reset_ptr on_reset
 Called from interrupt context. More...
 
on_file_open_ptr on_file_open
 Called when a file is opened for streaming. More...
 
on_file_end_ptr on_file_end
 Called when a file opened for streaming reaches the end. More...
 
user_mcode_ptrs_t user_mcode
 Optional handlers for user defined M-codes. More...
 
home_machine_ptr home_machine
 
travel_limits_ptr check_travel_limits
 
arc_limits_ptr check_arc_travel_limits
 
jog_limits_ptr apply_jog_limits
 
enqueue_gcode_ptr enqueue_gcode
 
enqueue_realtime_command_ptr enqueue_realtime_command
 
on_macro_execute_ptr on_macro_execute
 
on_macro_return_ptr on_macro_return
 NOTE: will be cleared on a hal.driver_reset call. More...
 

Field Documentation

◆ apply_jog_limits

jog_limits_ptr apply_jog_limits

◆ check_arc_travel_limits

arc_limits_ptr check_arc_travel_limits

◆ check_travel_limits

travel_limits_ptr check_travel_limits

◆ enqueue_gcode

enqueue_gcode_ptr enqueue_gcode

◆ enqueue_realtime_command

enqueue_realtime_command_ptr enqueue_realtime_command

◆ home_machine

home_machine_ptr home_machine

◆ on_execute_delay

on_execute_realtime_ptr on_execute_delay

◆ on_execute_realtime

on_execute_realtime_ptr on_execute_realtime

◆ on_file_end

on_file_end_ptr on_file_end

Called when a file opened for streaming reaches the end.

◆ on_file_open

on_file_open_ptr on_file_open

Called when a file is opened for streaming.

◆ on_gcode_comment

on_gcode_message_ptr on_gcode_comment

Called when a plain gcode comment has been parsed.

◆ on_gcode_message

on_gcode_message_ptr on_gcode_message

Called on output of message parsed from gcode. NOTE: string pointed to is freed after this call.

◆ on_get_alarms

on_get_alarms_ptr on_get_alarms

◆ on_get_commands

on_get_commands_ptr on_get_commands

Deprecated, use system_register_commands() to register new commands.

◆ on_get_errors

on_get_errors_ptr on_get_errors

◆ on_get_settings

on_get_settings_ptr on_get_settings

◆ on_global_settings_restore

on_global_settings_restore_ptr on_global_settings_restore

◆ on_homing_completed

on_homing_completed_ptr on_homing_completed

◆ on_homing_rate_set

on_homing_rate_set_ptr on_homing_rate_set

◆ on_jog_cancel

on_jog_cancel_ptr on_jog_cancel

Called from interrupt context.

◆ on_laser_ppi_enable

on_laser_ppi_enable_ptr on_laser_ppi_enable

◆ on_macro_execute

on_macro_execute_ptr on_macro_execute

◆ on_macro_return

on_macro_return_ptr on_macro_return

NOTE: will be cleared on a hal.driver_reset call.

◆ on_override_changed

on_override_changed_ptr on_override_changed

◆ on_parser_init

on_parser_init_ptr on_parser_init

◆ on_probe_completed

on_probe_completed_ptr on_probe_completed

◆ on_probe_start

on_probe_start_ptr on_probe_start

◆ on_probe_toolsetter

on_probe_toolsetter_ptr on_probe_toolsetter

◆ on_program_completed

on_program_completed_ptr on_program_completed

◆ on_realtime_report

on_realtime_report_ptr on_realtime_report

◆ on_report_command_help

on_report_command_help_ptr on_report_command_help

Deprecated, use system_register_commands() to register new commands.

◆ on_report_handlers_init

on_report_handlers_init_ptr on_report_handlers_init

◆ on_report_ngc_parameters

on_report_ngc_parameters_ptr on_report_ngc_parameters

◆ on_report_options

on_report_options_ptr on_report_options

◆ on_reset

on_reset_ptr on_reset

Called from interrupt context.

◆ on_rt_reports_added

on_rt_reports_added_ptr on_rt_reports_added

◆ on_set_axis_setting_unit

on_set_axis_setting_unit_ptr on_set_axis_setting_unit

◆ on_setting_get_description

on_setting_get_description_ptr on_setting_get_description

◆ on_spindle_programmed

on_spindle_programmed_ptr on_spindle_programmed

◆ on_spindle_select

on_spindle_select_ptr on_spindle_select

Called before spindle is selected, hook in HAL overrides here.

◆ on_spindle_selected

on_spindle_selected_ptr on_spindle_selected

Called when spindle is selected, do not change HAL pointers here!

◆ on_state_change

on_state_change_ptr on_state_change

◆ on_stream_changed

on_stream_changed_ptr on_stream_changed

◆ on_tool_changed

on_tool_changed_ptr on_tool_changed

Called after executing M6 or M61.

◆ on_tool_selected

on_tool_selected_ptr on_tool_selected

Called prior to executing M6 or after executing M61.

◆ on_toolchange_ack

on_toolchange_ack_ptr on_toolchange_ack

Called from interrupt context.

◆ on_unknown_accessory_override

on_unknown_accessory_override_ptr on_unknown_accessory_override

◆ on_unknown_feedback_message

on_unknown_feedback_message_ptr on_unknown_feedback_message

◆ on_unknown_realtime_cmd

on_unknown_realtime_cmd_ptr on_unknown_realtime_cmd

◆ on_unknown_sys_command

on_unknown_sys_command_ptr on_unknown_sys_command

return Status_Unhandled if not handled.

◆ on_user_command

on_user_command_ptr on_user_command

◆ on_wco_changed

on_wco_changed_ptr on_wco_changed

◆ report

report_t report

◆ tool_table

tool_table_t tool_table

◆ user_mcode

user_mcode_ptrs_t user_mcode

Optional handlers for user defined M-codes.


The documentation for this struct was generated from the following file: