grblHAL core
20240704
Data Structures
Here are the data structures with brief descriptions:
C
alarm_detail_t
C
alarm_details
C
aux_ctrl_out_t
C
aux_ctrl_t
C
axes_signals_t
C
axis_settings_t
C
bluetooth_settings_t
C
canbus_message_t
C
canbus_rx_buffer_t
C
canbus_rx_message
C
canbus_tx_buffer_t
C
canbus_tx_message
C
control_signals_ptrs_t
Control switches handlers
C
control_signals_t
C
coolant_ptrs_t
Handlers for coolant support
C
coolant_state_t
C
coord_data_t
Coordinate data
C
coord_system_t
Coordinate data including id
C
core_task
C
delay_t
Delay struct, currently not used by core - may be used by drivers
C
delayed_task_t
C
driver_cap_t
Bitmap flags for driver capabilities, to be set by driver in
driver_init()
, flags may be cleared after to switch off option
C
driver_irq_handler
C
driver_startup_t
C
emap_t
C
embedded_file_t
C
encoder_event_t
C
encoder_flags_t
C
encoder_ptrs_t
C
encoder_settings_t
C
encoder_t
C
error_details
C
fg_task_ptr
C
fs_options_t
C
gc_canned_t
Data for canned cycles
C
gc_modal_t
C
gc_override_flags_t
Override flags
C
gc_parser_flags_t
Parser flags for special cases
C
gc_thread_data
C
gc_value_ptr_t
C
gc_values_t
G- and M-code parameter values
C
gpio_in_config_t
/a cfg_data argument to /a xbar_config_ptr for gpio input pins
C
gpio_out_config_t
/a cfg_data argument to /a xbar_config_ptr for gpio output pins
C
grbl_hal_t
HAL structure used for the driver interface
C
grbl_t
C
home_signals_t
Home switches struct, consists of two packed
axes_signals_t
structs
C
homing_dual_axis_t
C
homing_flags_t
C
homing_ptrs_t
Limit switches handler for homing cycle
C
homing_settings_flags_t
C
homing_settings_t
C
ijk_words_t
C
io_port_t
Properties and handlers for auxiliary digital and analog I/O
C
io_ports_cfg_t
C
io_ports_data
C
io_ports_detail_t
C
io_ports_private_t
C
io_stream_details
C
io_stream_flags_t
C
io_stream_properties_t
C
io_stream_state_t
C
io_stream_t
Properties and handlers for stream I/O
C
ioport_bus_t
C
ioport_signals_t
C
ioports_pwm_t
Precalculated values that may be set/used by HAL driver to speed up analog input to PWM conversions. */
C
jog_settings_t
C
kinematics_t
C
limit_settings_flags_t
C
limit_settings_t
C
limit_signals_t
Limit switches struct, consists of four packed
axes_signals_t
structs in 32 bits
C
limits_ptrs_t
Limit switches handlers
C
line_flags_t
C
message_t
C
modal_groups_t
C
modbus_api_t
C
modbus_callbacks_t
C
modbus_message_t
C
modbus_settings_t
C
modbus_silence_timeout_t
C
modbus_tcp_settings_t
C
motor_map_t
Motor vs. axis mapping
NOTE:
id and axis values are equal for primary motors, unequal for secondary (ganged) motors
C
mqtt_settings_t
C
neopixel_cfg_t
C
network_info_t
C
network_services_t
C
network_settings_t
C
ngc_named_ro_param_t
C
ngc_named_rw_param
C
ngc_param_context_t
C
ngc_param_t
C
ngc_ro_param_t
C
ngc_rw_param
C
nvs_driver_area_t
Structure for keeping track of NVS area used by driver and/or plugin code
C
nvs_io_t
Handler functions and variables for NVS storage of settings and data
C
nvs_transfer_t
C
offset_lock_t
C
output_command
Data for M62, M63 and M67 commands when executed synchronized with motion
C
override_queue_t
C
overrides_t
C
parameter_words_t
Parameter words found by parser - do not change order!
C
parking_data_t
C
parking_flags_t
C
parking_setting_flags_t
C
parking_settings_t
C
parser_block_t
Parser block structure
C
parser_state_t
Parser state
C
periph_pin_t
C
periph_port_t
C
periph_signal
C
pid_values_t
C
pidf_t
C
pin_cap_t
C
pin_data_t
C
pin_debounce_t
C
pin_info_t
C
pin_mode_t
C
pin_name_t
C
plan_block
C
plan_line_data_t
C
plane_t
Axis index to plane assignment
C
planner_cond_t
C
planner_t
C
point_2d_t
C
position_pid_t
C
probe_ptrs_t
Handlers for probe input(s)
C
probe_state_t
C
probeflags_t
C
pwm_config_t
/a cfg_data argument to /a xbar_config_ptr for PWM pins
C
pwm_piece_t
C
realtime_queue_t
C
report_args_t
C
report_t
C
report_tracking_flags_t
C
reportmask_t
C
restore_condition_t
C
rgb_color_mask_t
C
rgb_color_t
C
rgb_ptr_t
C
rtc_ptrs_t
C
safety_door_setting_flags_t
C
safety_door_settings_t
C
scale_factor_t
C
setting_descr_t
C
setting_detail
C
setting_detail_flags_t
C
setting_details
C
setting_group_detail
C
setting_limit_t
C
settingflags_t
C
settings_changed_flags_t
C
settings_dirty_t
C
settings_restore_t
C
settings_t
C
signal_event_t
C
spindle1_settings_t
C
spindle_cap_t
Bitmap flags for spindle capabilities
C
spindle_context_ptr_t
C
spindle_css_data_t
Data used for Constant Surface Speed (CSS) mode calculations
C
spindle_data_ptrs_t
C
spindle_data_t
Used when HAL driver supports spindle synchronization
C
spindle_encoder_counter_t
C
spindle_encoder_t
C
spindle_encoder_timer_t
C
spindle_info_t
Structure holding data passed to the callback function called by
spindle_enumerate_spindles()
C
spindle_mode_t
C
spindle_param
Structure used for holding the current state of an enabled spindle
C
spindle_ptrs
Handlers and data for spindle support
C
spindle_pwm
Precalculated values that may be set/used by HAL driver to speed up RPM to PWM conversions if variable spindle is supported. */
C
spindle_pwm_flags_t
C
spindle_reg_t
Structure for holding spindle registration data
C
spindle_settings_flags_t
C
spindle_settings_t
C
spindle_state_t
C
spindle_stop_t
C
spindle_sync_t
C
spindle_sys_t
Structure for holding data about an enabled spindle
C
spindle_t
C
st2_motor
Internal structure for holding motor configuration and keeping track of its status
C
st_block
Holds the planner block Bresenham algorithm execution data for the segments in the segment buffer
C
st_segment
C
status_detail_t
C
step_control_t
C
stepper
Stepper ISR data struct. Contains the running data for the main stepper ISR
C
stepper_ptrs_t
Stepper motor handlers
C
stepper_settings_t
C
stream_block_tx_buffer2_t
C
stream_block_tx_buffer_t
C
stream_connection
C
stream_connection_flags_t
C
stream_rx_buffer_t
C
stream_state_t
C
stream_tx_buffer_t
C
sys_command_flags_t
C
sys_command_t
C
sys_commands_str
C
system
Global system variables struct
C
system_flags_t
C
system_override_delay_t
C
time_t
C
tm
C
tool_change_settings_t
C
tool_data_t
Tool data
C
tool_ptrs_t
Handlers for tool changes
C
tool_table_t
C
user_mcode_ptrs_t
Optional handlers for user defined M-codes
C
vfs_dir
C
vfs_dirent_t
C
vfs_drive_t
C
vfs_drives_t
C
vfs_events_t
C
vfs_file_t
C
vfs_free_t
C
vfs_mount
C
vfs_mount_ll_entry
C
vfs_st_mode_t
C
vfs_stat_t
C
vfs_t
C
wifi_ap_settings_t
C
wifi_sta_settings_t
C
word_bit_t
C
work_envelope_t
C
xbar
C
xbar_cfg_ptr_t
Generated by
1.9.1
1.9.1