report.h File Reference

#include "system.h"
#include "ngc_params.h"

Go to the source code of this file.

Enumerations
enum	settings_format_t { SettingsFormat_MachineReadable = 0 , SettingsFormat_HumanReadable , SettingsFormat_Grbl , SettingsFormat_grblHAL }

Functions
void	report_init (void)
void	report_init_fns (void)
void	report_message (const char *msg, message_type_t type)
void	report_plain (void *message)
void	report_info (void *message)
void	report_warning (void *message)
status_code_t	report_help (char *args)
void	report_plugin (const char *name, const char *version)
void	report_grbl_settings (bool all, void *data)
status_code_t	report_grbl_setting (setting_id_t id, void *data)
void	report_echo_line_received (char *line)
void	report_realtime_status (void)
void	report_probe_parameters (void)
void	report_tool_offsets (void)
status_code_t	report_ngc_parameter (ngc_param_id_t id)
status_code_t	report_named_ngc_parameter (char *arg)
void	report_ngc_parameters (void)
void	report_gcode_modes (void)
void	report_startup_line (uint8_t n, char *line)
void	report_execute_startup_message (char *line, status_code_t status_code)
void	report_build_info (char *line, bool extended)
status_code_t	report_alarm_details (bool grbl_format)
status_code_t	report_error_details (bool grbl_format)
status_code_t	report_setting_group_details (bool by_id, char *prefix)
status_code_t	report_settings_details (settings_format_t format, setting_id_t setting, setting_group_t group)
status_code_t	report_setting_description (settings_format_t format, setting_id_t id)
status_code_t	report_last_signals_event (sys_state_t state, char *args)
status_code_t	report_current_limit_state (sys_state_t state, char *args)
status_code_t	report_current_home_signal_state (sys_state_t state, char *args)
status_code_t	report_spindle_data (sys_state_t state, char *args)
status_code_t	report_pins (sys_state_t state, char *args)
status_code_t	report_pin_states (sys_state_t state, char *args)
status_code_t	report_spindles (bool machine_readable)
status_code_t	report_time (void)
void	report_pid_log (void)

Enumeration Type Documentation

settings_format_t

enum settings_format_t

Enumerator
SettingsFormat_MachineReadable
SettingsFormat_HumanReadable
SettingsFormat_Grbl
SettingsFormat_grblHAL

Function Documentation

report_alarm_details()

status_code_t report_alarm_details

(

bool

grbl_format

)

report_build_info()

void report_build_info	(	char *	line,
		bool	extended
	)

report_current_home_signal_state()

status_code_t report_current_home_signal_state	(	sys_state_t	state,
		char *	args
	)

report_current_limit_state()

status_code_t report_current_limit_state	(	sys_state_t	state,
		char *	args
	)

report_echo_line_received()

void report_echo_line_received

(

char *

line

)

report_error_details()

status_code_t report_error_details

(

bool

grbl_format

)

report_execute_startup_message()

void report_execute_startup_message	(	char *	line,
		status_code_t	status_code
	)

report_gcode_modes()

void report_gcode_modes

(

void

)

report_grbl_setting()

status_code_t report_grbl_setting	(	setting_id_t	id,
		void *	data
	)

report_grbl_settings()

void report_grbl_settings	(	bool	all,
		void *	data
	)

report_help()

status_code_t report_help

(

char *

args

)

report_info()

void report_info

(

void *

message

)

report_init()

void report_init

(

void

)

report_init_fns()

void report_init_fns

(

void

)

report_last_signals_event()

status_code_t report_last_signals_event	(	sys_state_t	state,
		char *	args
	)

report_message()

void report_message	(	const char *	msg,
		message_type_t	type
	)

report_named_ngc_parameter()

status_code_t report_named_ngc_parameter

(

char *

arg

)

report_ngc_parameter()

status_code_t report_ngc_parameter

(

ngc_param_id_t

id

)

report_ngc_parameters()

void report_ngc_parameters

(

void

)

report_pid_log()

void report_pid_log

(

void

)

report_pin_states()

status_code_t report_pin_states	(	sys_state_t	state,
		char *	args
	)

report_pins()

status_code_t report_pins	(	sys_state_t	state,
		char *	args
	)

report_plain()

void report_plain

(

void *

message

)

report_plugin()

void report_plugin	(	const char *	name,
		const char *	version
	)

report_probe_parameters()

void report_probe_parameters

(

void

)

report_realtime_status()

void report_realtime_status

(

void

)

report_setting_description()

status_code_t report_setting_description	(	settings_format_t	format,
		setting_id_t	id
	)

report_setting_group_details()

status_code_t report_setting_group_details	(	bool	by_id,
		char *	prefix
	)

report_settings_details()

status_code_t report_settings_details	(	settings_format_t	format,
		setting_id_t	setting,
		setting_group_t	group
	)

report_spindle_data()

status_code_t report_spindle_data	(	sys_state_t	state,
		char *	args
	)

report_spindles()

status_code_t report_spindles

(

bool

machine_readable

)

report_startup_line()

void report_startup_line	(	uint8_t	n,
		char *	line
	)

report_time()

status_code_t report_time

(

void

)

report_tool_offsets()

void report_tool_offsets

(

void

)

report_warning()

void report_warning

(

void *

message

)