Install embedXcode

Install the template

The installation of embedXcode is now performed by the Install embedXcode utility, as the PackageMaker previsouly used to generate the installation package no longer works on macOS 10.14 Mojave.

Download embedXcode

Download the embedXcode package directly from the download page .

For the systems running Xcode 10 on macOS 10.13 High Sierra or 10.14 Mojave,

• Select the main option.

For legacy systems running Xcode 9 on macOS 10.12 Sierra or 10.13 High Sierra,

• Please select the embedXcode Legacy 9 option. It corresponds to embedXcode release 9.6.8.

Warning

embedXcode Legacy 9 is no longer developed and has limited support.

This section requires the embedXcode+ edition.

For legacy systems running Xcode 8 on macOS 10.11 El Capitan and Mac OS X 10.12 Sierra,

• Please select the embedXcode Legacy 8 option. It corresponds to embedXcode release 7.6.9.

Danger

embedXcode Legacy 8 is deprecated and no longer supported.

For more information on legacy versions,

• Please refer to the section Use discontinued frameworks .

Install embedXcode

• Double-click on the embedXcode.zip or embedXcode-Plus.zip zip file to unzip the file.

• Open the resulting folder.

• Double-click on the Install embedXcode utility to launch the installation.

The installation starts and displays the licence agremment.

• Click on I Agree to proceed.

• Otherwise, click on I Decline to end.

The installation checks if embedXcode is already installed. If so, it switches to the update procedure.

If the release already installed is too old, an error message is displayed.

The safest way consists on removing the previous release and proceeding with a fresh installation.

• Run the Uninstall embedXcode utility as described at section Uninstall the template .

• Launch the Install embedXcode utility again.

If the release already installed is more recent, a warning message is displayed.

No action is needed.

• Click on Cancel.

A dialogue box asks for confirmation.

• Click on OK to launch the installation.

• Otherwise, click on Cancel to cancel the installation.

Installation starts. No password is asked for as all the files are installed inside the user's home folder.

A Console window provides information about the files being copied.

A dialogue box informs the installation is completed.

Additionnaly, the utility opens the Release Notes page.

• Close the different Terminal and Console windows.

Check the installation process

To check the installation process,

• Launch the Console application,

• Select ~/Library/Logs on the left pane.

• Locate the embedXcode Installation.log under the Files section.

Set the folder for standard IDEs

This section requires the embedXcode+ edition.

This is an optional procedure.

By default, the folder where the standard IDEs are installed and located is the /Applications folder.

However, if you've installed all the IDEs on another folder, an option allows to change the folder.

For example, if the IDEs are located on the /Applications/IDE folder,

• Open the ~/Documents/embedXcode folder.

• Double click on Define paths to IDEs.

A window asks for the folder containing all the standard IDEs.

• Select the folder containing the IDEs and click on Choose.

A notification confirms the new path.

Alternatively, on a project basis,

• Follow the procedure described at the section Change the path for standard IDEs . 

Update the template

Update embedXcode

Updating embedXcode is done through a standard installation.

• Just follow the procedure Install the template .

Then the projects need to be updated.

• Please refer to the procedure Update project manually for the embedXcode standard edition.

Update embedXcode+

This section requires the embedXcode+ edition.

To update embedXcode+,

• Perform a standard installation and follow the procedure Install the template .

To update the projects created with embedXcode+,

• Please follow the automatic procedure described at Update projects to embedXcode+ and new release of Xcode .

Upgrade projects from embedXcode to embedXcode+

This section requires the embedXcode+ edition.

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 .

Update project manually

For projects created with embedXcode, you need to perform a manual update of the project.

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.

Update a project from embedXcode to embedXcode+

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.

Uninstall the template

There is an automatic procedure to uninstall the template.

• Click on Uninstall embedXcode located on the embedXcode folder:

A dialogue box opens and asks for confirmation:

• Click on OK to proceed or on Cancel to abort.

As an alternative, the manual procedure requires to delete the following files and folders:

• Delete the folder embedXcode under ~/Documents.

This folder contains the utilities and the Release Notes for embedXcode.

• Delete the folder embedXcode under ~/Library.

This folder contains the frameworks, tool-chains, licences, preferences, makefiles and utilities used by embedXcode.

• Delete all the sub-folders related to embedXcode or embedXcode+ under the folders ~/Library/Developer/Xcode/Templates/Files Templates and ~/Library/Developer/Xcode/Templates/Project Templates.

Those folders contain the templates for the embedXcode files and projects.

• Keep the sub-folders which are not related to embedXcode or embedXcode+.

• Delete the files under ~/Library/Developer/Xcode/ UserData/CodeSnippets.

This folder contains the code snippets for embedXcode.

For the IDEs and optional tools you may have installed,

• Please refer to the respective procedures supplied by their editors