Skip to content

Setup Development Environment

Jump to bottom
bitblit11 edited this page May 21, 2012 · 6 revisions

Assumptions

  • CentOS 6.2 installed with development packages
  • This project will adhere to the MISRA C++ 2008 Coding Standards.
  • Coding style adheres to the "BSD/Allman" profile in Eclipse.
  • No tabs. White space are spaces only.

Prerequisites

  1. Install Eclipse IDE for C/C++ Development from http://www.eclipse.org/downloads/.
  2. Install AVR for Eclipse using instructions at http://interactive-matter.eu/how-to/developing-software-for-the-atmel-avr-with-avr-eclipse-avr-gcc-avrdude/.
  3. Install EGit from http://www.eclipse.org/egit/download/.
  4. Install the Arduino IDE and source code from http://arduino.cc/en/Main/Software.

Build the Arduino Static Library

  1. Start Eclipse.
  2. Create workspace.
  3. Click "File->New->C++ Project".
  4. Click "AVR Cross Target Static Library->Empty Project".
  5. Project name: ArduinoCore
  6. Click "Next".
  7. Check both "Debug" and "Release".
  8. Click "Next".
  9. Fill in the MCU type and frequency for your Arduino. For this project, I'm using: MCU Type: ATmega328P MCU Frequency (Hz): 16000000
  10. Click "Finish".
  11. Right click "ArduinoCore" in the Project Explorer pane.
  12. Click "Properties".
  13. In the left pane, click "C/C++ General->Paths and Symbols".
  14. In "Languages" tab, click "GNU C".
  15. In the right pane, click "Add".
  16. Click "File system..." and navigate to the Arduino platform specific source code at /hardware/arduino/variants/. I used "standard" for this project.
  17. Click "Ok".
  18. Check "Add to all configurations".
  19. In "Languages" tab, click "GNU C++".
  20. In the right pane, click "Add".
  21. Click "File system..." and navigate to the Arduino source at /hardware/arduino/cores/arduino.
  22. Click "Ok".
  23. Check "Add to all configurations".
  24. Click "Ok".
  25. In the right pane, click "Add".
  26. Click "File system..." and navigate to the Arduino platform specific source code at /hardware/arduino/variants/. I used "standard" for this project.
  27. Click "Ok".
  28. Check "Add to all configurations".
  29. Click "Ok".
  30. In the left pane, click "C/C++ General->Paths and Symbols".
  31. In the right pane, click the "Source Location" tab.
  32. In the right pane, click the "Link Folder..." button.
  33. Folder name: src
  34. If the advanced pane is not visible, click "Advanced >>".
  35. Check "Link to folder in the file system".
  36. Click the "Browse..." button.
  37. Navigate to the Arduino source code at /hardware/arduino/cores/arduino.
  38. Click the "OK" button.
  39. Click the "OK" button.
  40. In the right pane, click "/ArduinoCore".
  41. In the right pane, click the "Delete" button.
  42. Click the "OK" button.
  43. Click "Project->Build Configurations->Set Active->Debug".
  44. Click "Project->Build Project". You should see a bunch of text scroll by in the console and end with:

**** Build Finished ****

If so and you see no errors, congratulations. You've just built the Arduino static library you will be using for most of the remainder of the project. This is the debug version of the static library that will allow us to debug and step through even the low level Arduino code.

  1. Click "Project->Build Configurations->Set Active->Release".
  2. Click "Project->Build Project". You should see the same bunch of text scroll by in the console. This is the release version of the static library. We'll use this version of the static library for release versions of this project.

Setup VW-Bugbox Project

Most users wilL NOT have to perform these steps. This is a one time procedure to create the initial project that is checked into the Git repo. It is documented here for archival purposes and for anybody that wants to create a similar project. For those that are joining this project, skip ahead to "Clone the VW-Bugbox Project from Github".

Assumptions:

  • The ArduinoCore project will also always reside in the same workspace as the VW_Bugbox project.

Create project

  1. Start Eclipse and load workspace with the ArduinoCore project.
  2. Click "File->New->C++ Project".
  3. Click "AVR Cross Target Application->Empty Project".
  4. Project name: VW-Bugbox
  5. Click "Next".
  6. Check both "Debug" and "Release".
  7. Click "Next".
  8. Fill in the MCU type and frequency for your Arduino. For this project, I'm using: MCU Type: ATmega328P MCU Frequency (Hz): 16000000
  9. Click "Finish".

Integrate the ArduinoCore project

Add the paths for the header files so we can compile it.

  1. Right click "VW-Bugbox" in the Project Explorer pane.
  2. Click "Properties".
  3. In the left pane, click "C/C++ General->Paths and Symbols".
  4. In "Languages" tab, click "GNU C".
  5. In the right pane, click "Add".
  6. Click "File system..." and navigate to the Arduino platform specific source code at /hardware/arduino/variants/. I used "standard" for this project.
  7. Click "Ok".
  8. Check "Add to all configurations".
  9. Click "Ok".
  10. In "Languages" tab, click "GNU C++".
  11. In the right pane, click "Add".
  12. Click "File system..." and navigate to the Arduino platform specific source code at /hardware/arduino/variants/. I used "standard" for this project.
  13. Click "Ok".
  14. Check "Add to all configurations".
  15. Click "Ok".
  16. In the right pane, click "Add".
  17. Click "Workspace..." and click "ArduinoCore->src"
  18. Click "Ok".
  19. Check "Add to all configurations".
  20. Click "Ok".

Add the library so we can link it. Also, add a reference to the ArduinoCore so Eclipse will ensure that it rebuilds ArduinoCore if necessary. In case we decide to make tweaks to the Arduino code.

  1. In the left pane, click "C/C++ Build->Settings".
  2. In the right pane, click the "Tool Settings" tab.
  3. In the right pane, select "Debug" in the "Configuration" drop down.
  4. In the right pane, click "AVR C++ Linker->Libraries".
  5. In "Libraries Path (-L)" pane, click the add button.
  6. Click "Workspace...".
  7. Click "ArduinoCore->Debug".
  8. Click the "OK" button.
  9. In the right pane, select "Release" in the "Configuration" drop down.
  10. In the right pane, click "AVR C++ Linker->Libraries".
  11. In "Libraries Path (-L)" pane, click the add button.
  12. Click "Workspace...".
  13. Click "ArduinoCore->Debug".
  14. Click the "OK" button.
  15. Click the "OK" button.
  16. In "Libraries (-l)" pane, click the add button.
  17. Enter "ArduinoCore".
  18. Click the "OK" button.
  19. Click the "OK" button.

Now, our project has both the debug and release versions of the Arduino static library so we can debug or build for release just by selecting "Debug" or "Release". Lets make Eclipse always ensure that the ArduinoCore project is compiled.

  1. In the left pane, click "C/C++ General->Paths and Symbols".
  2. In the right pane, select "Debug" in the "Configuration" drop down.
  3. In the right pane, click the "References" tab.
  4. In the right pane, check the "Arduino->Debug" checkbox.
  5. In the right pane, select "Release" in the "Configuration" drop down.
  6. In the right pane, click the "References" tab.
  7. In the right pane, check the "Arduino->Release" checkbox.
  8. Click the "OK" button.

Now we're going to add a separate directory for all the source code, then configure Eclipse to ONLY parse the code in that source code directory when compiling code. This will allow us to include non-source code artifacts like documentation in our project without confusing Eclipse.

  1. In the Project Explorer pane, right click "VW-Bugbox".
  2. Click "New->Folder".
  3. Folder name: src
  4. Click the "Finish" button.
  5. Click "Add Folder...".
  6. In the Project Explorer pane, right click "VW-Bugbox".
  7. Click "Properties".
  8. In the left pane, click "C/C++ General->Paths and Symbols"
  9. In the right pane, click the "Source Location" tab.
  10. In the right pane, click the "Add Folder..." button.
  11. Click "src".
  12. Click "OK".
  13. In the right pane, click "/VW-Bugbox".
  14. In the right pane, click the "Delete" button.

Add our first source code.

  1. In the Project Explorer pane, right click "VW-Bugbox/src".
  2. Click "New->Other".
  3. Click "C/C++->Source File".
  4. Click the "Next >" button.
  5. Source file: setup.cpp
  6. Click the "Finish" button.
  7. In the Project Explorer pane, right click "VW-Bugbox/src".
  8. Click "New->Other".
  9. Click "C/C++->Source File".
  10. Click the "Next >" button.
  11. Source file: loop.cpp
  12. Click the "Finish" button.

Add some stub code to test our new build environment.

  1. In the setup.cpp file, add the following:

` #include <Arduino.h>

void setup() { } `

  1. In the loop.cpp file, add the following:

` #include <Arduino.h>

void loop() { } `

Test our new build environment.

  1. In the Project Explorer pane, click "VW-Bugbox".
  2. In the top menu, click "Project->Build Project".
  3. If you don't see any errors, congratulations. Your build environment is now ready for coding.

Clone this wiki locally