Darwin/Arduino GCode Interpreter
- 1 Arduino G-Code Interpreter
- 1.1 Introduction
- 1.2 Files
- 1.3 Usage
- 1.4 Implementation
- 1.5 TODO
- 1.6 Bugs
Arduino G-Code Interpreter
G-Code is a commonly use language to control CNC machines. G-Code is a light-weight, simple to parse format, designed to be able to run on modest hardware, such as the Arduino loaded with this firmware (in this case). It is a format that is prepared in advance and created from the digital design files (CAD files).
Several software packages can generate G-Code, so using this firmware allows you a degree of flexibility.
The G-Code firmware source is available from SourceForge as part of the RepRap Arduino firmware package. Make sure you get the latest version.
Once you download the proper files, there are a couple steps you need to do:
- Copy the folders in reprap-arduino-firmware-x.y/library to arduino-00xx/hardware/libraries
- Open the GCode_Interpreter sketch in reprap-arduino-firmware-x.y/gcode/GCode_Interpreter/GCode_Interpreter.pde with the Arduino software.
- Configure the firmware (see below)
- Upload the sketch to your Arduino.
Ubuntu users will also have to upgrade their avr-gcc; the standard one contains a bug. See this link for details.
In order for the firmware to operate properly, you must configure the proper variables in the firmware and then upload the firmware to your Arduino. The values are stored in the file _init.pde. An example version is included in the distribution called _init.pde.dist.
We'll cover each of the variables below:
This variable stores how many steps to take to move the X axis 1 inch. You will need to set this as accurately as possible if you want your machine to be accurate. There are two ways to set it:
- Move and Measure - slap a pen or marker on as a toolhead and draw a 1000 step line. Measure it and divide 1000 by the length in inches.
- Calculate Step Size - this one is the preferred way of doing things. Its rather easy to calculate step size based on your drive mechanism.
For threaded rod drive systems:
Find your TPI (threads per inch). for example, 1/4"-20 threaded rod means that there are 20 threads per inch (aka 20 turns = 1 inch.) Simply take that number and multiply it by the steps in a revolution. With a 400 step motor, it would be 8000 steps per inch.
For belt/pulley systems:
- Find the circumference of your drive pulley. (remember circumference = 2*pi*r) (say: 2.75")
- Calculate step size (ie: circumference / steps per revolution) (say: 2.75" / 400 = 0.00625")
- Divide 1 inch by step size (1" / 0.00625" = 160 steps/inch)
This variable stores how many steps to take to move the X axis 1mm. You can either calculate it independently, or take the number above and divide by 25.4.
This variable stores the maximum speed of the stepper in RPM (revolutions per minute). This is important as it determines the fastest speed to move the stepper. Start low and work your way up if you are unsure of the proper speed.
This variable stores the number of steps per revolution. This is important as it factors into how many steps to take for a line, as well as how fast your stepper will move. Your stepper will have a fixed number of steps per revolution and should say it on the datasheet.
If you are driving your stepper in half-stepping mode, double the number of steps. Similarly, if you are using a microstepper driver, multiply the steps by the appropriate factor. Make sure you use this new step number when you are calculating steps per inch/mm.
These variables are the same as the variables above, but allow for different drive systems on the Y and Z axes respectively. You must still fill them out, even if all drive systems are the same.
FAST_XY_FEEDRATE and FAST_Z_FEEDRATE
These define the maximum feedrates used for the G0 command. The feedrates are given in mm/minute.
The Arduino firmware waits for commands on the serial port and will start processing a command after either encountering a newline, or when there are no more characters to read.
There are several ways to control the machine through the G-Code Firmware:
- You can either write your own custom host software to send commands,
- Use Zach Smith's [ReplicatorG|http://replicat.org/ ReplicatorG]
- use the RepRap host software to send commands,
- or use the Processing app that we've bundled to send commands.
Due to the limited size and processing power available on the Arduino, only a limited subset of G-Code has been implemented. However, the vast majority of uses of G-Code are limited to these commands. Below, we cover the implemented commands as well as limitations.
G0 - Rapid Motion
Implemented - only supports X, Y, and Z axes.
G1 - Coordinated Motion
Implemented - only supports X, Y, and Z axes.
G2 - Arc - Clockwise
G3 - Arc - Counter Clockwise
G4 - Dwell
G20 - Inches as units
G21 - Millimeters as units
G28 - Go Home
G30 - Go Home via Intermediate Point
G90 - Absolute Positioning
G91 - Incremental Positioning
G92 - Set current as home
- Explore implementing offsets.
- None so far, but they are lurking.