From f42385265700ac13ad048c2d75d2543c6987c8af Mon Sep 17 00:00:00 2001 From: Simen Svale Skogsrud Date: Fri, 11 Feb 2011 23:54:13 +0100 Subject: [PATCH] added som documentation for other contributors --- doc/resources.txt | 13 +++++++++++++ doc/structure.txt | 39 +++++++++++++++++++++++++++++++++++++++ 2 files changed, 52 insertions(+) create mode 100644 doc/resources.txt create mode 100644 doc/structure.txt diff --git a/doc/resources.txt b/doc/resources.txt new file mode 100644 index 0000000..2754464 --- /dev/null +++ b/doc/resources.txt @@ -0,0 +1,13 @@ +Allocation of AVR peripherals in Grbl +===================================== + +See config.h for pin allocation. + +The UART is handled by 'wiring_serial' and used primarily for streaming gcode + +16 bit Timer 1 and the TIMER1_COMPA interrupt is used by the 'stepper' module to handle step events + +8 bit Timer 2 and the TIMER2_OVF interrupt is used by the 'stepper' module to reset the step pins +after a step event + + diff --git a/doc/structure.txt b/doc/structure.txt new file mode 100644 index 0000000..93cb1bd --- /dev/null +++ b/doc/structure.txt @@ -0,0 +1,39 @@ +The general structure of Grbl +============================= + +The main processing stack: + +'serial_protocol' : Accepts command lines from the serial port and passes them to 'gcode' for execution. + Provides status responses for each command. + +'gcode' : Recieves gcode from 'serial_protocol', parses it according to the current state + of the parser and issues commands via '..._control' modules + +'spindle_control' : Commands for controlling the spindle. + +'motion_control' : Accepts motion commands from 'gcode' and passes them to the 'planner'. This module + represents the public interface of the planner/stepper duo. + +'planner' : Recieves linear motion commands from 'motion_control' and adds them to the plan of + prepared motions. It takes care of continously optimizing the acceleration profile + as motions are added. + +'stepper' : Executes the motions by stepping the steppers according to the plan. + + + + +Supporting files: + +'config.h' : Compile time user settings + +'settings' : Maintains the run time settings record in eeprom and makes it availible + to all modules. + +'eeprom' : A library from Atmel that provides methods for reading and writing the eeprom with + a small addition from us that read and write binary streams with check sums used + to verify validity of the settings record. + +'nuts_bolts.h' : A tiny collection of useful constants and macros used everywhere + +'wiring_serial' : Low level serial library initially from an old version of the Arduino software \ No newline at end of file