settings.c File Reference

#include "grbl.h"

Go to the source code of this file.

Functions
void	settings_store_startup_line (uint8_t n, char *line)
	Method to store startup lines into EEPROM. More...
void	settings_store_build_info (char *line)
	Method to store build info into EEPROM. More...
void	settings_write_coord_data (uint8_t coord_select, float *coord_data)
	Method to store coord data parameters into EEPROM. More...
void	write_global_settings ()
	Method to store Grbl global settings struct and version number into EEPROM. More...
void	settings_restore (uint8_t restore_flag)
	Method to restore EEPROM-saved Grbl global settings back to defaults. More...
uint8_t	settings_read_startup_line (uint8_t n, char *line)
	Reads startup line from EEPROM. Updated pointed line string data. More...
uint8_t	settings_read_build_info (char *line)
	Reads startup line from EEPROM. Updated pointed line string data. More...
uint8_t	settings_read_coord_data (uint8_t coord_select, float *coord_data)
	Read selected coordinate data from EEPROM. Updates pointed coord_data value. More...
uint8_t	read_global_settings ()
	Reads Grbl global settings struct from EEPROM. More...
uint8_t	settings_store_global_setting (uint8_t parameter, float value)
	A helper method to set settings from command line. More...
void	settings_init ()
	Initialize the config subsystem. More...
uint8_t	get_step_pin_mask (uint8_t axis_idx)
	Returns step pin mask according to Grbl internal axis indexing. More...
uint8_t	get_direction_pin_mask (uint8_t axis_idx)
	Returns direction pin mask according to Grbl internal axis indexing. More...
uint8_t	get_limit_pin_mask (uint8_t axis_idx)
	Returns limit pin mask according to Grbl internal axis indexing. More...

Variables
settings_t	settings

Function Documentation

uint8_t get_direction_pin_mask

(

uint8_t

axis_idx

)

Returns direction pin mask according to Grbl internal axis indexing.

Returns the direction pin mask according to Grbl's internal axis numbering.

Definition at line 316 of file settings.c.

uint8_t get_limit_pin_mask

(

uint8_t

axis_idx

)

Returns limit pin mask according to Grbl internal axis indexing.

Returns the limit pin mask according to Grbl's internal axis numbering.

Definition at line 324 of file settings.c.

uint8_t get_step_pin_mask

(

uint8_t

axis_idx

)

Returns step pin mask according to Grbl internal axis indexing.

Returns the step pin mask according to Grbl's internal axis numbering.

Definition at line 308 of file settings.c.

uint8_t read_global_settings

(

)

Reads Grbl global settings struct from EEPROM.

Definition at line 173 of file settings.c.

void settings_init

(

)

Initialize the config subsystem.

Initialize the configuration subsystem (load settings from EEPROM)

< Force restore all EEPROM data.

Definition at line 299 of file settings.c.

uint8_t settings_read_build_info

(

char *

line

)

Reads startup line from EEPROM. Updated pointed line string data.

Reads build info user-defined string.

< Empty line

Definition at line 148 of file settings.c.

uint8_t settings_read_coord_data	(	uint8_t	coord_select,
		float *	coord_data
	)

Read selected coordinate data from EEPROM. Updates pointed coord_data value.

Reads selected coordinate data from EEPROM.

Definition at line 160 of file settings.c.

uint8_t settings_read_startup_line	(	uint8_t	n,
		char *	line
	)

Reads startup line from EEPROM. Updated pointed line string data.

Reads an EEPROM startup line to the protocol line variable.

< Empty line

Definition at line 135 of file settings.c.

void settings_restore

(

uint8_t

restore_flag

)

Method to restore EEPROM-saved Grbl global settings back to defaults.

Helper function to clear and restore EEPROM defaults.

< Checksum

< Checksum

< Checksum

Definition at line 65 of file settings.c.

void settings_store_build_info

(

char *

line

)

Method to store build info into EEPROM.

Stores build info user-defined string.

NOTE: This function can only be called in IDLE state.

Definition at line 39 of file settings.c.

uint8_t settings_store_global_setting	(	uint8_t	parameter,
		float	value
	)

A helper method to set settings from command line.

A helper method to set new settings from command line.

NOTE: Ensure the setting index corresponds to the report.c settings printout.

< Convert to mm/min^2 for grbl internal use.

< Store as negative for grbl internal use.

< Exit while-loop after setting has been configured and proceed to the EEPROM write call.

< Regenerate step and direction port invert masks.

< Regenerate step and direction port invert masks.

< Reset to ensure change. Immediate re-init may cause problems.

< Reset to ensure change. Immediate re-init may cause problems.

< Reset to ensure change. Immediate re-init may cause problems.

< Make sure WCO is immediately updated.

< Re-init to immediately change.

NOTE: Nice to have but could be problematic later.

< Force disable soft-limits.

< Re-initialize spindle rpm calibration

< Re-initialize spindle rpm calibration

Definition at line 188 of file settings.c.

void settings_store_startup_line	(	uint8_t	n,
		char *	line
	)

Method to store startup lines into EEPROM.

Stores the protocol line variable as a startup line in EEPROM.

< A startup line may contain a motion and be executing.

Definition at line 27 of file settings.c.

void settings_write_coord_data	(	uint8_t	coord_select,
		float *	coord_data
	)

Method to store coord data parameters into EEPROM.

Writes selected coordinate data to EEPROM.

Definition at line 46 of file settings.c.

void write_global_settings

(

)

Method to store Grbl global settings struct and version number into EEPROM.

NOTE: This function can only be called in IDLE state.

Definition at line 58 of file settings.c.

Variable Documentation

settings_t settings

Definition at line 24 of file settings.c.