core_handlers.h

Go to the documentation of this file.

/*
  core_handlers.h - core event handler entry points and some reporting entry points
 
  Part of grblHAL
 
  Copyright (c) 2020-2026 Terje Io
 
  grblHAL is free software: you can redistribute it and/or modify
  it under the terms of the GNU General Public License as published by
  the Free Software Foundation, either version 3 of the License, or
  (at your option) any later version.
 
  grblHAL is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  GNU General Public License for more details.
 
  You should have received a copy of the GNU General Public License
  along with grblHAL. If not, see <http://www.gnu.org/licenses/>.
*/
 
#pragma once
 
#include "system.h"
#include "stream.h"
#include "alarms.h"
#include "errors.h"
#include "settings.h"
#include "report.h"
#include "ioports.h"
#include "planner.h"
#include "machine_limits.h"
#include "vfs.h"
 
typedef enum {
    OverrideChanged_FeedRate = 0,
    OverrideChanged_RapidRate = 0,
    OverrideChanged_SpindleRPM = 0,
    OverrideChanged_SpindleState = 0,
    OverrideChanged_CoolantState = 0,
    OverrideChanged_FanState = 0
} override_changed_t;
 
/* TODO: add to grblHAL pointers so that a different formatting (xml, json etc) of reports may be implemented by a plugin?
typedef struct {
    void (*report_echo_line_received)(char *line);
    void (*report_realtime_status)(stream_write_ptr stream_write, );
    void (*report_probe_parameters)(void);
    void (*report_ngc_parameters)(void);
    void (*report_gcode_modes)(stream_write_ptr stream_write);
    void (*report_startup_line)(uint8_t n, char *line);
    void (*report_execute_startup_message)(char *line, status_code_t status_code);
} grbl_report_t;
*/
 
// Report entry points set by core at startup and reset.
 
typedef void (*init_message_ptr)(stream_write_ptr write);
typedef void (*help_message_ptr)(void);
typedef status_code_t (*status_message_ptr)(status_code_t status_code);
typedef message_code_t (*feedback_message_ptr)(message_code_t message_code);
typedef alarm_code_t (*alarm_message_ptr)(alarm_code_t alarm_code);
 
typedef struct {
    init_message_ptr init_message;          
    help_message_ptr help_message;          
    status_message_ptr status_message;      
    feedback_message_ptr feedback_message;  
    alarm_message_ptr alarm_message;        
    setting_output_ptr setting;
} report_t;
 
// Core event handler and other entry points.
// Most of the event handlers defaults to NULL, a few is set up to call a dummy handler for simpler code.
 
typedef bool (*enqueue_gcode_ptr)(char *data);
typedef bool (*protocol_enqueue_realtime_command_ptr)(char c);
typedef bool (*travel_limits_ptr)(float *target, axes_signals_t axes, bool is_cartesian, work_envelope_t *envelope);
typedef bool (*arc_limits_ptr)(coord_data_t *target, coord_data_t *position, point_2d_t center, float radius, plane_t plane, int32_t turns, work_envelope_t *envelope);
 
typedef void (*apply_travel_limits_ptr)(float *target, float *position, work_envelope_t *envelope);
typedef bool (*home_machine_ptr)(axes_signals_t cycle, axes_signals_t auto_square);
 
typedef void (*on_parser_init_ptr)(parser_state_t *gc_state);
typedef void (*on_state_change_ptr)(sys_state_t state);
typedef void (*on_override_changed_ptr)(override_changed_t override);
typedef void (*on_spindle_programmed_ptr)(spindle_ptrs_t *spindle, spindle_state_t state, float rpm, spindle_rpm_mode_t mode);
typedef void (*on_spindle_at_speed_ptr)(spindle_ptrs_t *spindle, spindle_state_t state);
typedef void (*on_port_out_ptr)(uint8_t port, io_port_type_t type, float value);
typedef void (*on_gcode_mode_changed_ptr)(void);
typedef void (*on_wco_changed_ptr)(void);
typedef void (*on_wco_saved_ptr)(coord_system_id_t id, coord_system_data_t *data);
typedef void (*on_program_completed_ptr)(program_flow_t program_flow, bool check_mode);
typedef void (*on_execute_realtime_ptr)(sys_state_t state);
typedef void (*on_unknown_accessory_override_ptr)(uint8_t cmd);
typedef void (*on_cycle_start_ptr)(void);
typedef void (*on_control_signals_changed_ptr)(control_signals_t signals);
typedef bool (*on_unknown_realtime_cmd_ptr)(char c);
typedef void (*on_report_handlers_init_ptr)(void);
typedef void (*on_report_options_ptr)(bool newopt);
typedef void (*on_report_ngc_parameters_ptr)(void);
typedef void (*on_report_command_help_ptr)(void);
typedef const char *(*on_setting_get_description_ptr)(setting_id_t id);
typedef void (*on_global_settings_restore_ptr)(void);
typedef void (*on_realtime_report_ptr)(stream_write_ptr stream_write, report_tracking_flags_t report);
typedef void (*on_unknown_feedback_message_ptr)(stream_write_ptr stream_write);
typedef void (*on_stream_changed_ptr)(stream_type_t type);
typedef void (*on_mpg_registered_ptr)(io_stream_t *stream, bool tx_capable);
typedef bool (*on_laser_ppi_enable_ptr)(uint_fast16_t ppi, uint_fast16_t pulse_length);
typedef void (*on_homing_rate_set_ptr)(axes_signals_t axes, float rate, homing_mode_t mode);
 
// NOTE: cycle contains the axis flags of the executed homing cycle, success will be true when all the configured cycles are completed.
typedef void (*on_homing_completed_ptr)(axes_signals_t cycle, bool success);
 
typedef bool (*on_probe_toolsetter_ptr)(tool_data_t *tool, coord_data_t *position, bool at_g59_3, bool on);
typedef bool (*on_probe_start_ptr)(axes_signals_t axes, float *target, plan_line_data_t *pl_data);
typedef void (*on_probe_completed_ptr)(void);
typedef void (*on_tool_selected_ptr)(tool_data_t *tool);
typedef void (*on_tool_changed_ptr)(tool_data_t *tool);
typedef void (*on_toolchange_ack_ptr)(void);
typedef void (*on_reset_ptr)(void);
typedef void (*on_jog_cancel_ptr)(sys_state_t state);
typedef bool (*on_spindle_select_ptr)(spindle_ptrs_t *spindle);
typedef void (*on_spindle_selected_ptr)(spindle_ptrs_t *spindle);
typedef char *(*on_process_gcode_comment_ptr)(char *msg);
typedef status_code_t (*on_gcode_message_ptr)(char *msg);
typedef void (*on_rt_reports_added_ptr)(report_tracking_flags_t report);
typedef const char *(*on_set_axis_setting_unit_ptr)(setting_id_t setting_id, uint_fast8_t axis_idx);
typedef status_code_t (*on_file_open_ptr)(const char *fname, vfs_file_t *handle, bool stream);
typedef status_code_t (*on_file_end_ptr)(vfs_file_t *handle, status_code_t status);
typedef status_code_t (*on_unknown_sys_command_ptr)(sys_state_t state, char *line); // return Status_Unhandled.
typedef status_code_t (*on_user_command_ptr)(char *line);
typedef sys_commands_t *(*on_get_commands_ptr)(void);
typedef status_code_t (*on_macro_execute_ptr)(macro_id_t macro, parameter_words_t args, uint32_t repeats); // macro implementations _must_ claim hal.stream.read to stream macros!
typedef void (*on_macro_return_ptr)(void);
typedef void (*on_file_demarcate_ptr)(bool start);
 
typedef tool_table_entry_t *(*get_tool_ptr)(tool_id_t tool_id);
typedef tool_table_entry_t *(*get_tool_by_idx_ptr)(uint32_t idx);
typedef bool (*set_tool_data_ptr)(tool_data_t *tool_data);
typedef bool (*clear_tool_data_ptr)(void);
 
typedef struct {
    uint32_t n_tools;
    get_tool_ptr get_tool;
    get_tool_by_idx_ptr get_tool_by_idx;
    set_tool_data_ptr set_tool;
    clear_tool_data_ptr clear;
} tool_table_t;
 
/*****************
 *  User M-code  *
 *****************/
 
typedef enum {
    UserMCode_Unsupported = 0,  
    UserMCode_Normal,           
    UserMCode_NoValueWords      
} user_mcode_type_t;
 
typedef user_mcode_type_t (*user_mcode_check_ptr)(user_mcode_t mcode);
 
typedef status_code_t (*user_mcode_validate_ptr)(parser_block_t *gc_block);
 
typedef void (*user_mcode_execute_ptr)(sys_state_t state, parser_block_t *gc_block);
 
typedef struct {
    user_mcode_check_ptr check;         
    user_mcode_validate_ptr validate;   
    user_mcode_execute_ptr execute;     
} user_mcode_ptrs_t;
 
typedef settings_changed_ptr on_settings_changed_ptr;
 
typedef struct {
    // report entry points set by core at reset.
    report_t report;
    //
    tool_table_t tool_table;
    // grbl core events - may be subscribed to by drivers or by the core.
    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_spindle_at_speed_ptr on_spindle_at_speed;
    on_port_out_ptr on_port_out;                                
    on_gcode_mode_changed_ptr on_gcode_mode_changed;            
    on_wco_changed_ptr on_wco_changed;
    on_wco_saved_ptr on_wco_saved;
    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;          
    on_rt_reports_added_ptr on_rt_reports_added;
    on_settings_changed_ptr on_settings_changed;                
    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_cycle_start_ptr on_cycle_start;                          
    on_control_signals_changed_ptr on_control_signals_changed;  
    on_unknown_realtime_cmd_ptr on_unknown_realtime_cmd;        
    on_unknown_sys_command_ptr on_unknown_sys_command;          
    on_user_command_ptr on_user_command;
    on_stream_changed_ptr on_stream_changed;
    on_mpg_registered_ptr on_mpg_registered;
    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_process_gcode_comment_ptr on_process_gcode_comment;
    on_gcode_message_ptr on_gcode_message;                      
    on_gcode_message_ptr on_gcode_comment;                      
    on_tool_selected_ptr on_tool_selected;                      
    on_tool_changed_ptr on_tool_changed;                        
    on_toolchange_ack_ptr on_toolchange_ack;                    
    on_jog_cancel_ptr on_jog_cancel;                            
    on_laser_ppi_enable_ptr on_laser_ppi_enable;
    on_spindle_select_ptr on_spindle_select;                    
    on_spindle_selected_ptr on_spindle_selected;                
    on_reset_ptr on_reset;                                      
    on_file_demarcate_ptr on_file_demarcate;                    
    on_file_open_ptr on_file_open;                              
    on_file_end_ptr on_file_end;                                
    user_mcode_ptrs_t user_mcode;                               
    // core entry points - set up by core before driver_init() is called.
    home_machine_ptr home_machine;
    travel_limits_ptr check_travel_limits;
    arc_limits_ptr check_arc_travel_limits;
    apply_travel_limits_ptr apply_travel_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;                
} grbl_t;
 
extern grbl_t grbl;
 
/*EOF*/