Firmware Update Guide

From re:3D
Revision as of 17:42, 25 July 2014 by Admin (Talk | contribs)

Jump to: navigation, search

Update your gigabot firmware for MAC

Updating and Reloading Gigabot Firmware (For Mac)

(Darren Suprina, 2014 06 26, v0001)

Purpose of This Document:

This document describes how to update and reload the firmware installed on the Arduino-based Azteeg X3 3D printer motion controller used to control a Gigabot 3D printer.


URLs of interest:

Azteeg X3 controllers product information: http://www.panucatt.com/default.asp

Azteeg X3 controller schematic and wiring details: http://files.panucatt.com/datasheets/x3_v2_wiring.pdf

Arduino libraries may be downloaded from: http://arduino.cc/en/Reference/Libraries

Instructions on loading Arduino libraries can be found at http://arduino.cc/en/Guide/Libraries

Instructions on loading firmware into Arduino-based systems: https://code.google.com/p/open-evse/wiki/LoadingFirmware


Building and Installing Gigabot Firmware:


1. Download and install the Arduino development environment (Arduino IDE).

http://arduino.cc/en/Main/Software

Instructions shown in this document reflect version 1.0.5.

Review instructions on using the IDE at http://arduino.cc/en/guide/Environment.


2. Download the latest Gigabot firmware:

Fetch file “Marlin Gigabot KS3.1.zip”

https://www.dropbox.com/s/swq88e15t8apb6... Note that re:3D has posted this software as part of their software instructions found at: http://www.re3d.org/ <tab: Products> <link: Software / Tools> <link: Gigabot Instruction Manuals> (which will take you to http://re3d.dozuki.com/Guide) <link: Software> <link: Gigabot Software Set Up> (Software link found in Comments section)

Save software in a directory set aside for software development. Unzip the archive. The directory “Marlin” will be created


3. Determine the Arduino software libraries required to build the Gigabot firmware.

This will be done by attempting to compile the Gigabot firmware and seeing what is missing.


3.1. Open the Gigabot Firmware in the Arduino IDE

Navigate to the file …/Marlin/Marlin.ino and double-click on it. The Arduino IDE will start.

Interesting configuration details, including which libraries are used by the firmware, can be found in file “Configuration.h”.

3.2. Compile the Gigabot firmware

Click the “Verify” icon (check mark in a circle, top left in the Arduino IDE window). Reports: ‘LiquidTWI2’ does not name a type


Figure 3.2 – Identifying missing software libraries.

Expect that the ‘LiquidTWI2’ library will be missing. Checking “Configuration.h”, the LiquidTWI2 library is stated to be found at https://github.com/lincomatic/LiquidTWI2.


4. Obtain and Install Required Software Libraries

4.1 Obtain the LiquidTWI2 library

Visit https://github.com/lincomatic/LiquidTWI2 and download the library.

Will need to sign up for an account at this site to obtain access. Free accounts are offered.


4.2 Install the LiquidTWI2 library for the Arduino IDE to use

Normally would be able to install the library by using the Arduino IDE’s interface: <Sketch><Import Library…><Add Library…>

Unfortunately, any library containing a non-alphanumeric character so this function does not work. (Note that the name of the library is “LiquidTWI2-master”, which has an embedded “-“.)

The workaround is to do the following:

Unzip the file “LiquidTWI2-master.zip”. The directory “LiquidTWI2-master” will be created

Move this directory to: …<users>[current user]<documents><Arduino><libraries>

Rename the directory “LiquidTWI2-master” to “LiquidTWI2”. The library will now be found at: …<users>[current user]<documents><Arduino><libraries><LiquidTWI2>


5. Close any open Arduino IDE windows and re-open

This is necessary because if a library is added, then the IDE must be restarted to see that library.

(Reference: http://stackoverflow.com/questions/18635465/arduino-error-does-not-name-a-type)



6. Compile the Gigabot firmware

Click the “Verify” icon.

The compilation should be successful.


Figure 6 – Compiling software for the Gigabot controller.

7. Install the Marlin Software Package into the Gigabot Controller:

Click the “Upload” icon (shown as a right arrow in the top left-hand corner of the IDE window).


Figure 7.1 – Initiating the uploading of Gigabot controller software.

The IDE will step through a sequence of operations: Compiling Sketch… Uploading…

During the upload process, the Tx and Rx lights of the controller will be lit, indicating that the software binary is being transferred. To observe these LED indicators it is necessary to open the door of the Gigabot control panel. The Tx and RX indicators are found in the bottom right-hand corner of the controller card.


Figure 7.2 – Controller indicating software upload in progress.

When complete, the IDE will state “Done uploading”.


Figure 7.3 – Controller software update is complete.


8. Reboot the Gigabot Controller

The Azteeg X3 controller is based on the Amtel ATmega 2560 processor. Upon the successful uploading of software the processor should automatically reset itself and start running the uploaded code.

To ensure that the controller has actually reset one can:

Power cycle the Gigabot. Power off the controller for at least 6 seconds to ensure that the unit has actually reset.

-or-

Open the Gigabot’s electronic panel and depress the reset button of the controller. The reset button is found close to the top of the rightmost edge of the card, immediately below the top-right mounting screw.


9. Validate that the Gigabot Controller can be Seen by Pronterface

9.1 Launch Pronterface.

Start Pronterface, which is used to manage the Gigabot by using the onboard Azteeg X3 controller to monitor the printer and send it commands.

(For Mac users the program will have the name “Printrun-Mac-10Mar2014.app” in the Finder, “Macpronterface” on the Menu Bar, and “Pronterface” within the primary window of the application while running.


9.2 Select the proper Port and Baud Rate.

Figure 9 – Accessing the Gigabot’s controller using Pronterface.

Note that the baud rate should be 250000.


9.3 Connect to the Computer to the Controller.

Click <Connect>.

Pronterface will connect to the Gigabot controller and be ready to accept commands and relay status..


Notes:

The Arduino IDE stores libraries at <user>/Documents/Arduino/libraries/


-fin-