initial

.gitignore

@@ -0,0 +1,7 @@
+*.hex
+*.o
+*.elf
+*.DS_Store
+*.d
+
+README.md

Makefile

@@ -0,0 +1,106 @@
+#  Part of Grbl
+#
+#  Copyright (c) 2009-2011 Simen Svale Skogsrud
+#  Copyright (c) 2012-2016 Sungeun K. Jeon for Gnea Research LLC
+#
+#  Grbl 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.
+#
+#  Grbl 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 Grbl.  If not, see <http://www.gnu.org/licenses/>.
+
+
+# This is a prototype Makefile. Modify it according to your needs.
+# You should at least check the settings for
+# DEVICE ....... The AVR device you compile for
+# CLOCK ........ Target AVR clock rate in Hertz
+# OBJECTS ...... The object files created from your source files. This list is
+#                usually the same as the list of source files with suffix ".o".
+# PROGRAMMER ... Options to avrdude which define the hardware you use for
+#                uploading to the AVR and the interface where this hardware
+#                is connected.
+# FUSES ........ Parameters for avrdude to flash the fuses appropriately.
+
+DEVICE     ?= atmega328p
+CLOCK      = 16000000
+PROGRAMMER ?= -c avrisp2 -P usb
+SOURCE    = main.c motion_control.c gcode.c spindle_control.c coolant_control.c serial.c \
+             protocol.c stepper.c eeprom.c settings.c planner.c nuts_bolts.c limits.c jog.c\
+             print.c probe.c report.c system.c
+BUILDDIR = build
+SOURCEDIR = grbl
+# FUSES      = -U hfuse:w:0xd9:m -U lfuse:w:0x24:m
+FUSES      = -U hfuse:w:0xd2:m -U lfuse:w:0xff:m
+
+# Tune the lines below only if you know what you are doing:
+
+AVRDUDE = avrdude $(PROGRAMMER) -p $(DEVICE) -B 10 -F
+
+# Compile flags for avr-gcc v4.8.1. Does not produce -flto warnings.
+# COMPILE = avr-gcc -Wall -Os -DF_CPU=$(CLOCK) -mmcu=$(DEVICE) -I. -ffunction-sections
+
+# Compile flags for avr-gcc v4.9.2 compatible with the IDE. Or if you don't care about the warnings. 
+COMPILE = avr-gcc -Wall -Os -DF_CPU=$(CLOCK) -mmcu=$(DEVICE) -I. -ffunction-sections -flto
+
+
+OBJECTS = $(addprefix $(BUILDDIR)/,$(notdir $(SOURCE:.c=.o)))
+
+# symbolic targets:
+all:	grbl.hex
+
+$(BUILDDIR)/%.o: $(SOURCEDIR)/%.c
+	$(COMPILE) -MMD -MP -c $< -o $@
+
+.S.o:
+	$(COMPILE) -x assembler-with-cpp -c $< -o $(BUILDDIR)/$@
+# "-x assembler-with-cpp" should not be necessary since this is the default
+# file type for the .S (with capital S) extension. However, upper case
+# characters are not always preserved on Windows. To ensure WinAVR
+# compatibility define the file type manually.
+
+#.c.s:
+	$(COMPILE) -S $< -o $(BUILDDIR)/$@
+
+flash:	all
+	$(AVRDUDE) -U flash:w:grbl.hex:i
+
+fuse:
+	$(AVRDUDE) $(FUSES)
+
+# Xcode uses the Makefile targets "", "clean" and "install"
+install: flash fuse
+
+# if you use a bootloader, change the command below appropriately:
+load: all
+	bootloadHID grbl.hex
+
+clean:
+	rm -f grbl.hex $(BUILDDIR)/*.o $(BUILDDIR)/*.d $(BUILDDIR)/*.elf
+
+# file targets:
+$(BUILDDIR)/main.elf: $(OBJECTS)
+	$(COMPILE) -o $(BUILDDIR)/main.elf $(OBJECTS) -lm -Wl,--gc-sections
+
+grbl.hex: $(BUILDDIR)/main.elf
+	rm -f grbl.hex
+	avr-objcopy -j .text -j .data -O ihex $(BUILDDIR)/main.elf grbl.hex
+	avr-size --format=berkeley $(BUILDDIR)/main.elf
+# If you have an EEPROM section, you must also create a hex file for the
+# EEPROM and add it to the "flash" target.
+
+# Targets for code debugging and analysis:
+disasm:	main.elf
+	avr-objdump -d $(BUILDDIR)/main.elf
+
+cpp:
+	$(COMPILE) -E $(SOURCEDIR)/main.c
+
+# include generated header dependencies
+-include $(BUILDDIR)/$(OBJECTS:.o=.d)

build/.gitignore

@@ -0,0 +1,4 @@
+# Ignore everything in this directory
+*
+# Except this file
+!.gitignore

doc/csv/alarm_codes_en_US.csv

@@ -0,0 +1,11 @@
+"Alarm Code in v1.1+"," Alarm Message in v1.0-"," Alarm Description"
+"1","Hard limit","Hard limit has been triggered. Machine position is likely lost due to sudden halt. Re-homing is highly recommended."
+"2","Soft limit","Soft limit alarm. G-code motion target exceeds machine travel. Machine position retained. Alarm may be safely unlocked."
+"3","Abort during cycle","Reset while in motion. Machine position is likely lost due to sudden halt. Re-homing is highly recommended."
+"4","Probe fail","Probe fail. Probe is not in the expected initial state before starting probe cycle when G38.2 and G38.3 is not triggered and G38.4 and G38.5 is triggered."
+"5","Probe fail","Probe fail. Probe did not contact the workpiece within the programmed travel for G38.2 and G38.4."
+"6","Homing fail","Homing fail. The active homing cycle was reset."
+"7","Homing fail","Homing fail. Safety door was opened during homing cycle."
+"8","Homing fail","Homing fail. Pull off travel failed to clear limit switch. Try increasing pull-off setting or check wiring."
+"9","Homing fail","Homing fail. Could not find limit switch within search distances. Try increasing max travel, decreasing pull-off distance, or check wiring."
+"10","Homing fail","Homing fail. Second dual axis limit switch failed to trigger within configured search distance after first. Try increasing trigger fail distance or check wiring."

doc/csv/build_option_codes_en_US.csv

@@ -0,0 +1,23 @@
+OPT: Code, Build-Option Description,State
+V,Variable spindle,Enabled
+N,Line numbers,Enabled
+M,Mist coolant M7,Enabled
+C,CoreXY,Enabled
+P,Parking motion,Enabled
+Z,Homing force origin,Enabled
+H,Homing single axis commands,Enabled
+T,Two limit switches on axis,Enabled
+A,Allow feed rate overrides in probe cycles,Enabled
+D,Use spindle direction as enable pin,Enabled
+0,Spindle enable off when speed is zero,Enabled
+S,Software limit pin debouncing,Enabled
+R,Parking override control,Enabled
++,Safety door input pin,Enabled
+*,Restore all EEPROM command,Disabled
+$,Restore EEPROM `$` settings command,Disabled
+#,Restore EEPROM parameter data command,Disabled
+I,Build info write user string command,Disabled
+E,Force sync upon EEPROM write,Disabled
+W,Force sync upon work coordinate offset change,Disabled
+L,Homing initialization auto-lock,Disabled
+2,Dual axis motors,Enabled

doc/csv/error_codes_en_US.csv

@@ -0,0 +1,37 @@
+"Error Code in v1.1+","Error Message in v1.0-","Error Description"
+"1","Expected command letter","G-code words consist of a letter and a value. Letter was not found."
+"2","Bad number format","Missing the expected G-code word value or numeric value format is not valid."
+"3","Invalid statement","Grbl '$' system command was not recognized or supported."
+"4","Value < 0","Negative value received for an expected positive value."
+"5","Setting disabled","Homing cycle failure. Homing is not enabled via settings."
+"6","Value < 3 usec","Minimum step pulse time must be greater than 3usec."
+"7","EEPROM read fail. Using defaults","An EEPROM read failed. Auto-restoring affected EEPROM to default values."
+"8","Not idle","Grbl '$' command cannot be used unless Grbl is IDLE. Ensures smooth operation during a job."
+"9","G-code lock","G-code commands are locked out during alarm or jog state."
+"10","Homing not enabled","Soft limits cannot be enabled without homing also enabled."
+"11","Line overflow","Max characters per line exceeded. Received command line was not executed."
+"12","Step rate > 30kHz","Grbl '$' setting value cause the step rate to exceed the maximum supported."
+"13","Check Door","Safety door detected as opened and door state initiated."
+"14","Line length exceeded","Build info or startup line exceeded EEPROM line length limit. Line not stored."
+"15","Travel exceeded","Jog target exceeds machine travel. Jog command has been ignored."
+"16","Invalid jog command","Jog command has no '=' or contains prohibited g-code."
+"17","Setting disabled","Laser mode requires PWM output."
+"20","Unsupported command","Unsupported or invalid g-code command found in block."
+"21","Modal group violation","More than one g-code command from same modal group found in block."
+"22","Undefined feed rate","Feed rate has not yet been set or is undefined."
+"23","Invalid gcode ID:23","G-code command in block requires an integer value."
+"24","Invalid gcode ID:24","More than one g-code command that requires axis words found in block."
+"25","Invalid gcode ID:25","Repeated g-code word found in block."
+"26","Invalid gcode ID:26","No axis words found in block for g-code command or current modal state which requires them."
+"27","Invalid gcode ID:27","Line number value is invalid."
+"28","Invalid gcode ID:28","G-code command is missing a required value word."
+"29","Invalid gcode ID:29","G59.x work coordinate systems are not supported."
+"30","Invalid gcode ID:30","G53 only allowed with G0 and G1 motion modes."
+"31","Invalid gcode ID:31","Axis words found in block when no command or current modal state uses them."
+"32","Invalid gcode ID:32","G2 and G3 arcs require at least one in-plane axis word."
+"33","Invalid gcode ID:33","Motion command target is invalid."
+"34","Invalid gcode ID:34","Arc radius value is invalid."
+"35","Invalid gcode ID:35","G2 and G3 arcs require at least one in-plane offset word."
+"36","Invalid gcode ID:36","Unused value words found in block."
+"37","Invalid gcode ID:37","G43.1 dynamic tool length offset is not assigned to configured tool length axis."
+"38","Invalid gcode ID:38","Tool number greater than max supported value."

doc/csv/setting_codes_en_US.csv

@@ -0,0 +1,35 @@
+"$-Code"," Setting"," Units"," Setting Description"
+"0","Step pulse time","microseconds","Sets time length per step. Minimum 3usec."
+"1","Step idle delay","milliseconds","Sets a short hold delay when stopping to let dynamics settle before disabling steppers. Value 255 keeps motors enabled with no delay."
+"2","Step pulse invert","mask","Inverts the step signal. Set axis bit to invert (00000ZYX)."
+"3","Step direction invert","mask","Inverts the direction signal. Set axis bit to invert (00000ZYX)."
+"4","Invert step enable pin","boolean","Inverts the stepper driver enable pin signal."
+"5","Invert limit pins","boolean","Inverts the all of the limit input pins."
+"6","Invert probe pin","boolean","Inverts the probe input pin signal."
+"10","Status report options","mask","Alters data included in status reports."
+"11","Junction deviation","millimeters","Sets how fast Grbl travels through consecutive motions. Lower value slows it down."
+"12","Arc tolerance","millimeters","Sets the G2 and G3 arc tracing accuracy based on radial error. Beware: A very small value may effect performance."
+"13","Report in inches","boolean","Enables inch units when returning any position and rate value that is not a settings value."
+"20","Soft limits enable","boolean","Enables soft limits checks within machine travel and sets alarm when exceeded. Requires homing."
+"21","Hard limits enable","boolean","Enables hard limits. Immediately halts motion and throws an alarm when switch is triggered."
+"22","Homing cycle enable","boolean","Enables homing cycle. Requires limit switches on all axes."
+"23","Homing direction invert","mask","Homing searches for a switch in the positive direction. Set axis bit (00000ZYX) to search in negative direction."
+"24","Homing locate feed rate","mm/min","Feed rate to slowly engage limit switch to determine its location accurately."
+"25","Homing search seek rate","mm/min","Seek rate to quickly find the limit switch before the slower locating phase."
+"26","Homing switch debounce delay","milliseconds","Sets a short delay between phases of homing cycle to let a switch debounce."
+"27","Homing switch pull-off distance","millimeters","Retract distance after triggering switch to disengage it. Homing will fail if switch isn't cleared."
+"30","Maximum spindle speed","RPM","Maximum spindle speed. Sets PWM to 100% duty cycle."
+"31","Minimum spindle speed","RPM","Minimum spindle speed. Sets PWM to 0.4% or lowest duty cycle."
+"32","Laser-mode enable","boolean","Enables laser mode. Consecutive G1/2/3 commands will not halt when spindle speed is changed."
+"100","X-axis travel resolution","step/mm","X-axis travel resolution in steps per millimeter."
+"101","Y-axis travel resolution","step/mm","Y-axis travel resolution in steps per millimeter."
+"102","Z-axis travel resolution","step/mm","Z-axis travel resolution in steps per millimeter."
+"110","X-axis maximum rate","mm/min","X-axis maximum rate. Used as G0 rapid rate."
+"111","Y-axis maximum rate","mm/min","Y-axis maximum rate. Used as G0 rapid rate."
+"112","Z-axis maximum rate","mm/min","Z-axis maximum rate. Used as G0 rapid rate."
+"120","X-axis acceleration","mm/sec^2","X-axis acceleration. Used for motion planning to not exceed motor torque and lose steps."
+"121","Y-axis acceleration","mm/sec^2","Y-axis acceleration. Used for motion planning to not exceed motor torque and lose steps."
+"122","Z-axis acceleration","mm/sec^2","Z-axis acceleration. Used for motion planning to not exceed motor torque and lose steps."
+"130","X-axis maximum travel","millimeters","Maximum X-axis travel distance from homing switch. Determines valid machine space for soft-limits and homing search distances."
+"131","Y-axis maximum travel","millimeters","Maximum Y-axis travel distance from homing switch. Determines valid machine space for soft-limits and homing search distances."
+"132","Z-axis maximum travel","millimeters","Maximum Z-axis travel distance from homing switch. Determines valid machine space for soft-limits and homing search distances."