Find Solutions to Most Common Issues

I’ve listed the most common causes of errors and the most frequently asked questions.

Before reporting an issue, there are basic checks to be performed.

  • Saying that compilation fails is not enough: more information is needed.

  • If the sketch doesn’t compile successfully with the standard IDE, the error isn’t generated by Xcode and embedXcode alone.

  • Please check this list before reporting the issue.

  • When reporting an issue, please provide the required information.

Solve Project Preparation Issues

Symptom Project preparation fails.
Solution Was the first build launched while indexing was running?
Reference See Prepare the Project and Launch the Procedure .
Symptom Project preparation fails.
Solution Are the IDEs of the boards installed under the /Applications folder?
Reference See Install the IDEs of the Boards .
Symptom Project preparation fails.
Solution Do the versions of the boards installed correspond to those supported by embedXcode?
Reference See Check and Update the Boards Reference List .
Symptom Project preparation fails.
Solution If the IDEs are in a folder other than the standard /Applications folder, is the path declared accordingly?
Reference See Change the Path for Standard IDEs .

Solve Compilation Issues

Symptom Compilation fails.
Solution Does the name of your project include a space or a special character in its name or path?Reference
Symptom Compilation fails.
Solution Are the installed IDEs compatible with the support versions?
Reference See Install the Wiring / Arduino Framework , Install the Cosa framework , Install the Edison SDKs .
Symptom Compilation fails.
Solution Have the boards been updated with the Boards Manager on Arduino CC 1.6.5?
Reference See Check and Update the Boards Reference List
Symptom Compilation fails.
Solution Is the project old and unused for a long time?
Reference See Update Project Manually , Update Project Automatically and Update Projects to embedXcode+ and New Release of Xcode .
Symptom Compilation fails.
Solution By default, no library is compiled. If the project uses libraries, mention them in the main Makefile after the APP_LIBS_LIST and USER_LIBS_LIST variables.
Reference See Manage the Libraries for Compilation .
Symptom Compilation fails.
Solution Some user's libraries may be incompatible. Exclude the conflicting libraries.
Reference See Manage the Libraries for Compilation .
Symptom Compilation fails.
Solution More information is needed.
Reference See Display the Report Navigator .
Symptom Compilation fails.
Solution Does the sketch compiles normally on the standard IDE?
Reference If the sketch doesn’t compile on the standard IDE, then the error isn’t generated by Xcode or embedXcode alone.
Symptom Compilation fails.
Solution What is the selected target? The targets All, Upload and Fast requires a board to be connected.
Reference See Select a Target .
Symptom Compilation fails.
Solution What are the messages in the Log navigator?
Reference See Manage Error Messages .
Symptom Compilation fails.
Solution Compilation of an embedXcode project fails with a Processing-based Wiring-derived Arduino-like IDE. Use the EMBEDXCODE pre-processing variable.
Reference See Use embedXcode Pre-Processing Variable.
Symptom Compilation fails with Maple, Microduino and Robotis boards with the message 'uint8_t' was not declared in this scope.
Solution Maple ignores the C99 standard [u]int{8|16|32|64}_t types. Refer to the procedure to add them.
Reference See Install the Maple Platform , Install the Microduino Platform and Install the Robotis Platform . As a recommended alternative, see Install the STM32duino Platform

Solve Libraries Issues

Symptom Xcode can’t find the libraries.
Solution Is the sketchbook directory defined?
Reference See Install the IDEs of the Boards .
Symptom Xcode can’t find the libraries.
Solution Is the library folder created inside the sketchbook folder?
Reference See Add User’s Libraries .
Symptom Xcode can’t find the libraries.
Solution Is the library mentioned in the main Makefile? Or is the library excluded, as Wifi and ArduinoRobot?
Reference See Manage the Libraries for Compilation .
Symptom The main sketch with extension .pde or .ino isn’t considered as C++ code.
Solution Declare .pde or .ino main sketch as standard C++ file.
Reference See Declare Sketch .pde or .ino File as C++ File .
Symptom Xcode can’t find the libraries of the board.
Solution For boards managed with the Boards Manager on Arduino 1.6.5 and later, have the libraries for the boards been installed?
Reference See Install Additional Boards on Arduino .
Symptom Xcode can’t find the libraries of the board.
Solution For boards managed with the Boards Manager on Arduino 1.6.5 and later, have the libraries for the boards been updated?
Reference See Check and Update the Boards Reference List .

Solve Pre-Compiled Libraries Issues

Symptom Xcode can’t find the .board file for one or more pre-compiled libraries.
Solution The .board file for one or more pre-compiled libraries boards is missing.
Reference See Generate Pre-Compiled Libraries .
Symptom One or more pre-compiled libraries are not compatible with the board of the project.
Solution The .board file for one or more pre-compiled libraries boards is not consistent with the board of the current project. Generate the pre-compiled library again for the current board.
Reference See Generate Pre-Compiled Libraries .

Solve Code-Sense Issues

Symptom Code-sense doesn’t work.
Solution Re-index the keywords for code-sense.
Reference See Re-Index the Keywords for Code-Sense .
Symptom Code-sense doesn’t include all the libraries.
Solution Re-index the keywords for code-sense.
Reference See Declare Sources for Code-Sense .
Symptom Click-to-error doesn’t point to the right line of code.
Solution Define the directories for the Targets.
Reference See Define the Directories for the Targets .

Solve Upload Issues

Symptom Upload fails.
Solution Check the USB connection and the drivers.
Reference Try with another USB cable.
Symptom Upload fails.
Solution Check the connection isn't already used by another application.
Reference Close the other application.
Symptom Upload fails.
Solution The name of the USB port is different.
Reference See Customise the Serial Port .
Symptom Upload fails.
Solution The Adafruit, Digispark and Teensy boards have specific upload procedures. Some LaunchPads MSP430F5529 may require a firmware update.
Reference See Upload to Specific Boards .
Symptom Upload fails after having used a programmer.
Solution The programmer has erased the boot-loader. You need to burn the boot-loader again.
Reference See Restore Initial Mode on Specific Boards .

Solve Platforms Issues

Symptom I want the same code for different platforms.
Solution Use the conditional statements based on MCU or on IDE.
Reference See Write Specific Code for Multiple Platforms .
Symptom My board isn’t listed.
Solution Create a specific Board Configuration Settings File for your board.
Reference See Add a Configuration File for a New Board .
Symptom My board isn’t listed.
Solution Ask support for a new board or a new programmer.
Reference See What Requirements to Meet When Asking Support for a New Board .

Solve Compatibility Issues

Symptom The standard IDE fails to open or compile a project created with embedXcode.
Solution Check the compatibility of the project.
Reference See Manage Compatibility with Standard IDEs .
Symptom embedXcode fails to open or compile a project created with a standard IDE.
Solution Check the compatibility of the project.
Reference See Manage Compatibility with Standard IDEs .
Symptom The standard IDE fails to compile a project with pre-compiled libraries created with embedXcode.
Solution Standard IDEs do not support pre-compiled libraries. Check the compatibility of the project.
Reference See Manage Pre-Compiled Libraries .

Solve Self-Documentation Issues

Symptom The documentation elaborated by Doxygen isn’t correct.
Solution Refer to the Doxygen Manual on the Doxygen website.
Reference See Comment the Code .

Solve Other Issues

Symptom I need more information about Xcode.
Solution Buy a book about Xcode.
Symptom I need more information about Arduino.
Solution Buy a book about Arduino.
Symptom My issue is not listed.
Solution Post on a forum or contact me.
Reference See Visit the Official Websites .