From 3a7ae13003c7b2b1327c88541b59df82eaad1608 Mon Sep 17 00:00:00 2001 From: Simen Svale Skogsrud Date: Tue, 25 Jan 2011 14:27:18 +0100 Subject: [PATCH] updated readme --- readme.textile | 26 ++++++++++++++++++++++++++ readme.txt | 30 ------------------------------ 2 files changed, 26 insertions(+), 30 deletions(-) create mode 100644 readme.textile delete mode 100644 readme.txt diff --git a/readme.textile b/readme.textile new file mode 100644 index 0000000..8da2422 --- /dev/null +++ b/readme.textile @@ -0,0 +1,26 @@ +h1. Grbl - An embedded g-code interpreter and motion-controller for the Arduino/AVR328 microcontroller + +h2. The goal: A no-compromise, high performance, low cost alternative to parallel-port based motion control for CNC milling + +h2. Status: + +* Ready for production, used regularly for countless CNC jobs +* Highly optimized C utilizing the hardware-timers of the AVR-chip for all critical timing +* Able to maintain more than 30kHz step rate, generating an ultra clean, jitter free step-signal +* Robust G-code interpreter, tested with output from several CAM tools +* Standards-compliant g-code arcs/circles fully supported +* Buffered, non blocking, asynchronous step generation so the rest of the system is free to process + g-code while the steppers are steppin' +* Configuration parameters stored in EEPROM and set via simple commands +* Full acceleration management with look-ahead +** Smooth acceleration and deceleration lets stepper motors run at higher nominal speeds +** Smooth cornering within the set jerk-limit of your choosing will brake for sharp turns, but keep speed at slight direction changes + +Prioritized to-do: +* Backlash compensation +* Autodetect baud rate +* Spindle control +* Arduino IDE compatible (build and flash) +* Support "headless" fabrication by buffering all code to SD-card or similar + +The project was initially inspired by the Arduino GCode Interpreter by Mike Ellery diff --git a/readme.txt b/readme.txt deleted file mode 100644 index f6a4613..0000000 --- a/readme.txt +++ /dev/null @@ -1,30 +0,0 @@ -Grbl - An embedded rs274/ngc (g-code) interpreter and motion-controller for the Arduino/AVR328 microcontroller -The goal: A no-compromise, high performance, low cost alternative to parallel-port based motion control for CNC milling - -Status: -* Ready for production, but probably rough around the edges still -* Highly optimized C utilizing the hardware-timers of the AVR-chip for all critical timing -* Able to maintain more than 30kHz step rate, generating an ultra clean, jitter free step-signal -* G-code interpreter complete, tested with output from several CAM tools -* Standards-compliant g-code arcs/circles fully supported -* Buffered, non blocking, asynchronous step generation so the rest of the system is free to process - g-code while the steppers are steppin' -* Configuration parameters stored in EEPROM and set via simple commands -* Tested on very few (two) CNC rigs - -Prioritized to-do: -* Accelleration/decelleration -* Spindle control -* Autodetect baud rate -* Arduino IDE compatible (build and flash) -* Documentation and web-site -* Support for a alphanumeric LCD readout, a joystick and a few buttons for program control -* Support "headless" fabrication by buffering all code to SD-card or similar -* Backlash compensation - -Limitations by design: -* Limited GCode-support. Focus on the kind of GCode produced by CAM tools. Leave human GCoders frustrated. -* No support for tool offsets (typically handled by CAM-tool) -* No rotation axes, only x, y and z. - -The project was initially inspired by the Arduino GCode Interpreter by Mike Ellery