Skip to content

Update embedXcode

Update the embedXcode standard edition template

Updating the embedXcode standard edition is done through a standard installation.

Then the projects need to be updated.

Update the embedXcode+ edition template

This section requires the embedXcode+ edition.

To download an updated version of embedXcode+,

  • Use the links provided on the confirmation message, the newletter or the dialogue box.

  • Enter the credentials.

The credentials include the e-mail address of the latest PayPal transaction as Identification, and a 17-character-long string as Password.

  • Click on Download.

If the credentials are valid, the download starts.

If the credentials do not correspond to the latest ones, a warning message is displayed.

  • Refresh the page and try again with the latest credentials.

If the donation is older than one year, a warning message is displayed.

  • Update the donation and try again.

If the credentials do not correspond, an error message is displayed.

  • Refresh the page and try again.

To update embedXcode+,

The projects created with the embedXcode+ edition do not need to be updated.

The projects created with the embedXcode standard edition need to be upgraded to the embedXcode+ edition.

Update the projects

The projects created with the embedXcode+ edition do not need to be updated.

The projects created with the embedXcode standard edition need to be updated manually.

There are two procedures:

Create a new project

  • Create a new project with the same name, ProjectA but in a different folder.

  • Copy-paste the corresponding files from the old project to the new project: the main sketch ProjectA.ino and the local libraries.

  • Check Copy items if needed and select Index in the lists of targets for Add to targets.

  • Edit the main Makefile of the new project to add the libraries you plan to use, for example the application and user's libraries.

  • Optionally, edit the main Makefile of the new project to customise the options, for example the warning options.

Modify the initial project

As an alternative for more than one project, this time modifying the inital project:

  • Close the project you want to update, called ProjectA.

  • Create another project called ProjectB and launch the Build target.

  • Copy-paste the corresponding folders from ProjectB to ProjectA: Makefiles, Configuration, Utilities.

  • Copy-paste the corresponding files from ProjectB to ProjectA: main.cpp and the main Makefile.

  • For embedXcode standard edition, edit main.cpp of ProjectA and change #include "ProjectB.ino" for #include "ProjectA.ino".

  • For the embedXcode+ edition, edit the main Makefile of ProjectA and change PROJECT_NAME_AS_IDENTIFIER = ProjectB" for PROJECT_NAME_AS_IDENTIFIER = ProjectA.

  • Edit the main Makefile of ProjectA to add the libraries you plan to use.

  • Optionally, edit the main Makefile of ProjectA to customise the options, for example the warning options.

Upgrade projects from embedXcode to embedXcode+

This section requires the embedXcode+ edition.

To upgrade the projects created with the embedXcode standard edition to the embedXcode+ edition,

Upgrade projects automatically

When upgrading from the embedXcode standard edition to the embedXcode+ edition, the projects previously created with the embedXcode standard edition need to be prepared in order to enjoy the features of the embedXcode+ edition.

To update the projects created with the embedXcode standard edition to the embedXcode+ edition,

  • Close Xcode.

  • Download and install the latest release of the embedXcode+ edition.

  • Backup the projects you plan to update.

  • Open the ~/Documents/embedXcode folder.

  • Double-click on the Update Projects utility.

A window asks for the folder with the projects to update.

  • Select the folder that contains the projects to be updated and click on Choose.

The Update Projects utility updates all the projects located under the selected folder.

A notification confirms the project has been updated

The Terminal window lists the projects updated with their initial release.

*** embedXcode_update_7
---
Migrate /Users/ReiVilo/Projects

6.1.4    SUCCESS    ./eX-plus/eX-plus.xcodeproj
6.1.2    SUCCESS    ./eX-standard/eX-standard.xcodeproj
7.0.9    ERROR    ./eX-updated/eX-updated.xcodeproj
===

Here, two updates were successful for eX-plus and eX-standard. The latest project eX-updated was already up-to-date.

  • Launch Xcode and open the updated project.

  • Remove the Makefiles and Utilities groups on the left pane. They are no longer needed.

The Makefiles and Utilities groups

Once updated, the project is much more compact. The Makefiles and Utilities are now shared across all the projects.

Before and after

As an alternative, the manual procedure is available at procedure Update project manually .

Upgrade projects manually

To update the projects created with the embedXcode standard edition to the embedXcode+ edition,

  • Close the project you want to update, called ProjectA.

  • Create another project called ProjectB with the same board and launch the Build target.

  • Copy-paste the corresponding folder from ProjectA to ProjectB: Configuration.

  • Copy-paste the corresponding files from ProjectA to ProjectB: the main sketch ProjectA.ino, and all the header .h and code .cpp files related to local libraries.

  • Rename the main sketch from ProjectA.ino to ProjectB.ino.

  • Edit the main Makefile of ProjectB and change PROJECT_NAME_AS_IDENTIFIER = ProjectA for PROJECT_NAME_AS_IDENTIFIER = ProjectB.

  • Optionally, edit the main Makefile of ProjectB to add the libraries you plan to use.

  • Optionally, edit the main Makefile of ProjectB to customise the options, for example the warning options.