grbl-LPC-CoreXY/readme.textile

h1. Grbl - An embedded g-code interpreter and motion-controller for the Arduino/AVR328 microcontroller
    
Grbl is a no-compromise, high performance, low cost alternative to parallel-port-based motion control for CNC milling. It will run on a vanilla Arduino (Duemillanove/Uno) as long as it sports an Atmega 328. 

The controller is written in highly optimized C utilizing every clever feature of the AVR-chips to achieve precise timing and asynchronous operation. It is able to maintain more than 30kHz of stable, jitter free control pulses.

It accepts standards-compliant G-code and has been tested with the output of several CAM tools with no problems. Arcs, circles and helical motion are fully supported, as well as, other basic functional g-code commands. Functions and variables are not currently supported, but may be included in future releases in a form of a pre-processor.

Grbl includes full acceleration management with look ahead. That means the controller will look up to 20 motions into the future and plan its velocities ahead to deliver smooth acceleration and jerk-free cornering.

*Changelog for v0.8 from v0.7:*
  - *ALPHA STATUS*: Major structural overhaul to allow for multi-tasking events and new feature sets
  - New run-time command control: Feed hold (pause), Cycle start (resume), Reset (abort), Status reporting
  - Controlled feed hold with deceleration to ensure no skipped steps and loss of location.
  - After feed hold, cycle accelerations are re-planned and may be resumed.
  - Work(G92) and machine coordinate system support.
  - System reset re-initializes grbl without resetting the Arduino and retains machine/home position.
  - Restructured planner and stepper modules to become independent and ready for future features.
  - Planned features: Jog mode, status reporting, runtime settings such as toggling block delete.
  - Reduce serial read buffer to 128 characters and increased write buffer to 64 characters.
  - Misc bug fixes and removed deprecated acceleration enabled code.

*Important note for Atmega 168 users:* Going forward, support for Atmega 168 will be dropped due to its limited memory and speed. However, legacy Grbl v0.51 "in the branch called 'v0_51' is still available for use.

_The project was initially inspired by the Arduino GCode Interpreter by Mike Ellery_
updated readme 2011-01-25 14:27:18 +01:00			`h1. Grbl - An embedded g-code interpreter and motion-controller for the Arduino/AVR328 microcontroller`
updated readme 2011-01-25 14:42:27 +01:00
			`Grbl is a no-compromise, high performance, low cost alternative to parallel-port-based motion control for CNC milling. It will run on a vanilla Arduino (Duemillanove/Uno) as long as it sports an Atmega 328.`
updated readme 2011-01-25 14:27:18 +01:00
updated readme 2011-01-25 14:42:27 +01:00			`The controller is written in highly optimized C utilizing every clever feature of the AVR-chips to achieve precise timing and asynchronous operation. It is able to maintain more than 30kHz of stable, jitter free control pulses.`
updated readme 2011-01-25 14:27:18 +01:00
Initial v0.8 ALPHA commit. Features multi-tasking run-time command execution (feed hold, cycle start, reset, status query). Extensive re-structuring of code for future features. - ALPHA status. - Multitasking ability with run-time command executions for real-time control and feedback. - Decelerating feed hold and resume during operation. - System abort/reset, which immediately kills all movement and re-initializes grbl. - Re-structured grbl to easily allow for new features: Status reporting, jogging, backlash compensation. (To be completed in the following releases.) - Resized TX/RX serial buffers (32/128 bytes) - Increased planner buffer size to 20 blocks. - Updated documentation. 2011-12-09 02:47:48 +01:00			`It accepts standards-compliant G-code and has been tested with the output of several CAM tools with no problems. Arcs, circles and helical motion are fully supported, as well as, other basic functional g-code commands. Functions and variables are not currently supported, but may be included in future releases in a form of a pre-processor.`
updated readme 2011-01-25 14:27:18 +01:00
updated readme 2011-01-25 14:42:27 +01:00			`Grbl includes full acceleration management with look ahead. That means the controller will look up to 20 motions into the future and plan its velocities ahead to deliver smooth acceleration and jerk-free cornering.`

Initial v0.8 ALPHA commit. Features multi-tasking run-time command execution (feed hold, cycle start, reset, status query). Extensive re-structuring of code for future features. - ALPHA status. - Multitasking ability with run-time command executions for real-time control and feedback. - Decelerating feed hold and resume during operation. - System abort/reset, which immediately kills all movement and re-initializes grbl. - Re-structured grbl to easily allow for new features: Status reporting, jogging, backlash compensation. (To be completed in the following releases.) - Resized TX/RX serial buffers (32/128 bytes) - Increased planner buffer size to 20 blocks. - Updated documentation. 2011-12-09 02:47:48 +01:00			`Changelog for v0.8 from v0.7:`
			`- ALPHA STATUS: Major structural overhaul to allow for multi-tasking events and new feature sets`
Update readme.textile 2012-01-18 02:05:46 +01:00			`- New run-time command control: Feed hold (pause), Cycle start (resume), Reset (abort), Status reporting`
Initial v0.8 ALPHA commit. Features multi-tasking run-time command execution (feed hold, cycle start, reset, status query). Extensive re-structuring of code for future features. - ALPHA status. - Multitasking ability with run-time command executions for real-time control and feedback. - Decelerating feed hold and resume during operation. - System abort/reset, which immediately kills all movement and re-initializes grbl. - Re-structured grbl to easily allow for new features: Status reporting, jogging, backlash compensation. (To be completed in the following releases.) - Resized TX/RX serial buffers (32/128 bytes) - Increased planner buffer size to 20 blocks. - Updated documentation. 2011-12-09 02:47:48 +01:00			`- Controlled feed hold with deceleration to ensure no skipped steps and loss of location.`
			`- After feed hold, cycle accelerations are re-planned and may be resumed.`
Update readme.textile 2012-01-18 02:05:46 +01:00			`- Work(G92) and machine coordinate system support.`
			`- System reset re-initializes grbl without resetting the Arduino and retains machine/home position.`
Initial v0.8 ALPHA commit. Features multi-tasking run-time command execution (feed hold, cycle start, reset, status query). Extensive re-structuring of code for future features. - ALPHA status. - Multitasking ability with run-time command executions for real-time control and feedback. - Decelerating feed hold and resume during operation. - System abort/reset, which immediately kills all movement and re-initializes grbl. - Re-structured grbl to easily allow for new features: Status reporting, jogging, backlash compensation. (To be completed in the following releases.) - Resized TX/RX serial buffers (32/128 bytes) - Increased planner buffer size to 20 blocks. - Updated documentation. 2011-12-09 02:47:48 +01:00			`- Restructured planner and stepper modules to become independent and ready for future features.`
Update readme.textile 2012-01-18 02:05:46 +01:00			`- Planned features: Jog mode, status reporting, runtime settings such as toggling block delete.`
			`- Reduce serial read buffer to 128 characters and increased write buffer to 64 characters.`
Initial v0.8 ALPHA commit. Features multi-tasking run-time command execution (feed hold, cycle start, reset, status query). Extensive re-structuring of code for future features. - ALPHA status. - Multitasking ability with run-time command executions for real-time control and feedback. - Decelerating feed hold and resume during operation. - System abort/reset, which immediately kills all movement and re-initializes grbl. - Re-structured grbl to easily allow for new features: Status reporting, jogging, backlash compensation. (To be completed in the following releases.) - Resized TX/RX serial buffers (32/128 bytes) - Increased planner buffer size to 20 blocks. - Updated documentation. 2011-12-09 02:47:48 +01:00			`- Misc bug fixes and removed deprecated acceleration enabled code.`
updated readme 2011-01-25 14:27:18 +01:00
Initial v0.8 ALPHA commit. Features multi-tasking run-time command execution (feed hold, cycle start, reset, status query). Extensive re-structuring of code for future features. - ALPHA status. - Multitasking ability with run-time command executions for real-time control and feedback. - Decelerating feed hold and resume during operation. - System abort/reset, which immediately kills all movement and re-initializes grbl. - Re-structured grbl to easily allow for new features: Status reporting, jogging, backlash compensation. (To be completed in the following releases.) - Resized TX/RX serial buffers (32/128 bytes) - Increased planner buffer size to 20 blocks. - Updated documentation. 2011-12-09 02:47:48 +01:00			`Important note for Atmega 168 users: Going forward, support for Atmega 168 will be dropped due to its limited memory and speed. However, legacy Grbl v0.51 "in the branch called 'v0_51' is still available for use.`
added another note for existing users 2011-02-17 20:03:29 +01:00
updated readme 2011-01-25 14:42:27 +01:00			`_The project was initially inspired by the Arduino GCode Interpreter by Mike Ellery_`