108 lines
4.2 KiB
C
108 lines
4.2 KiB
C
/*
|
|
settings.h - eeprom configuration handling
|
|
Part of Grbl
|
|
|
|
The MIT License (MIT)
|
|
|
|
GRBL(tm) - Embedded CNC g-code interpreter and motion-controller
|
|
Copyright (c) 2009-2011 Simen Svale Skogsrud
|
|
Copyright (c) 2011-2012 Sungeun K. Jeon
|
|
|
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
of this software and associated documentation files (the "Software"), to deal
|
|
in the Software without restriction, including without limitation the rights
|
|
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
copies of the Software, and to permit persons to whom the Software is
|
|
furnished to do so, subject to the following conditions:
|
|
|
|
The above copyright notice and this permission notice shall be included in
|
|
all copies or substantial portions of the Software.
|
|
|
|
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
THE SOFTWARE.
|
|
*/
|
|
|
|
#ifndef settings_h
|
|
#define settings_h
|
|
|
|
#include <math.h>
|
|
#include "nuts_bolts.h"
|
|
|
|
#define GRBL_VERSION "0.8c"
|
|
|
|
// Version of the EEPROM data. Will be used to migrate existing data from older versions of Grbl
|
|
// when firmware is upgraded. Always stored in byte 0 of eeprom
|
|
#define SETTINGS_VERSION 5
|
|
|
|
// Define bit flag masks for the boolean settings in settings.flag.
|
|
#define BITFLAG_REPORT_INCHES bit(0)
|
|
#define BITFLAG_AUTO_START bit(1)
|
|
#define BITFLAG_INVERT_ST_ENABLE bit(2)
|
|
#define BITFLAG_HARD_LIMIT_ENABLE bit(3)
|
|
#define BITFLAG_HOMING_ENABLE bit(4)
|
|
|
|
// Define EEPROM memory address location values for Grbl settings and parameters
|
|
// NOTE: The Atmega328p has 1KB EEPROM. The upper half is reserved for parameters and
|
|
// the startup script. The lower half contains the global settings and space for future
|
|
// developments.
|
|
#define EEPROM_ADDR_GLOBAL 1
|
|
#define EEPROM_ADDR_PARAMETERS 512
|
|
#define EEPROM_ADDR_STARTUP_BLOCK 768
|
|
|
|
// Define EEPROM address indexing for coordinate parameters
|
|
#define N_COORDINATE_SYSTEM 6 // Number of supported work coordinate systems (from index 1)
|
|
#define SETTING_INDEX_NCOORD N_COORDINATE_SYSTEM+1 // Total number of system stored (from index 0)
|
|
// NOTE: Work coordinate indices are (0=G54, 1=G55, ... , 6=G59)
|
|
#define SETTING_INDEX_G28 N_COORDINATE_SYSTEM // Home position 1
|
|
#define SETTING_INDEX_G30 N_COORDINATE_SYSTEM+1 // Home position 2
|
|
// #define SETTING_INDEX_G92 N_COORDINATE_SYSTEM+2 // Coordinate offset (G92.2,G92.3 not supported)
|
|
|
|
// Global persistent settings (Stored from byte EEPROM_ADDR_GLOBAL onwards)
|
|
typedef struct {
|
|
float steps_per_mm[3];
|
|
uint8_t microsteps;
|
|
uint8_t pulse_microseconds;
|
|
float default_feed_rate;
|
|
float default_seek_rate;
|
|
uint8_t invert_mask;
|
|
float mm_per_arc_segment;
|
|
float acceleration;
|
|
float junction_deviation;
|
|
uint8_t flags; // Contains default boolean settings
|
|
uint8_t homing_dir_mask;
|
|
float homing_feed_rate;
|
|
float homing_seek_rate;
|
|
uint16_t homing_debounce_delay;
|
|
float homing_pulloff;
|
|
uint8_t stepper_idle_lock_time; // If max value 255, steppers do not disable.
|
|
uint8_t decimal_places;
|
|
uint8_t n_arc_correction;
|
|
// uint8_t status_report_mask; // Mask to indicate desired report data.
|
|
} settings_t;
|
|
extern settings_t settings;
|
|
|
|
// Initialize the configuration subsystem (load settings from EEPROM)
|
|
void settings_init();
|
|
|
|
// A helper method to set new settings from command line
|
|
uint8_t settings_store_global_setting(int parameter, float value);
|
|
|
|
// Stores the protocol line variable as a startup line in EEPROM
|
|
void settings_store_startup_line(uint8_t n, char *line);
|
|
|
|
// Reads an EEPROM startup line to the protocol line variable
|
|
uint8_t settings_read_startup_line(uint8_t n, char *line);
|
|
|
|
// Writes selected coordinate data to EEPROM
|
|
void settings_write_coord_data(uint8_t coord_select, float *coord_data);
|
|
|
|
// Reads selected coordinate data from EEPROM
|
|
uint8_t settings_read_coord_data(uint8_t coord_select, float *coord_data);
|
|
|
|
#endif
|