Install embedXcode¶
Install the template¶
The installation of embedXcode is now performed by the Install embedXcode utility, as the PackageMaker utility previsouly used to generate the installation package no longer works on macOS 10.14 Mojave.
Warning
Starting 1st November 2020, only the embedXcode+ edition is maintained under long-term support.
The embedXcode standard edition is no longer available for download.
Download embedXcode¶
- Download the embedXcode package directly from the download page .
Danger
embedXcode does not support macOS 11 Big Sur and Xcode 12.
For more information,
- Please refer to Assessing macOS 11 and Xcode 12 .
For the systems running Xcode 11 on macOS 10.15 Catalina,
- Select the main option.

Safari prompts a warning dialogue box.

- Click on Allow to proceed with the download.
For legacy systems running Xcode 11 on macOS 10.14 Mojave or 10.15 Catalina,
- Please select the embedXcode Legacy 11 option. It corresponds to embedXcode release 11.9.11.

Warning
embedXcode Legacy 11 is no longer developed and has limited support.
This section requires the embedXcode+ edition.
For legacy systems running Xcode 10 on macOS 10.13 High Sierra or 10.14 Mojave,
- Please select the embedXcode Legacy 10 option. It corresponds to embedXcode release 10.9.9.

Warning
embedXcode Legacy 10 is deprecated and no longer supported.
For a complete list of the macOS and Xcode versions corresponding to the previous releases of embedXcode,
- Please refer to the section Check macOS and Xcode .
For more information on legacy versions,
- Please refer to the section Check the obsolescence notice .
Install embedXcode¶
The downloaded file is either a disk image with extension .dmg
or a compressed file with extension .zip
.
Depending on the extension,
- Double-click on the embedXcode.dmg or embedXcode-Plus.dmg dmg file to unzip the disk image.

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

- Open the resulting folder.

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

In case macOS complains about a non-signed installation package,
- Press Ctrl+Left Button on the embedXcode package icon to display the contextual menu and select Open.

A window prompts for confirmation.
- Answer Open to proceed.
The installation starts and displays the licence agreement.


-
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 and doesn’t ask for a password as all the files are installed inside the user’s home folder.
A Console window provides information about the files being copied.

For the embedXcode+ edition, the embedXcode utilities need to be authorised.
A first dialogue box warns about the next one.

- Click on OK to continue.
The second dialogue asks for the password to authorise the embedXcode utilities.

-
Enter the username and the password.
-
Click on Modify settings to authorise the embedXcode utilities.
A dialogue box informs the installation is completed.

Additionally, the utility opens the Release notes page.

Finally, the utility opens the Check Platforms and MCUs page.
-
Check the platforms and MCUs you plan to use are up to date.
-
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 .
Authorise the utilities¶
macOS 10.15 Catalina aggressive protection may deny some utilities from running. macOS 10.15 Catalina requires 64-bits applications and prevents some 32-bits utilities from running.
Danger
The solutions described below are for information purpose only. Please read carefully the mentioned references before applying them. You perform them at your own responsibility.
Allow utilities¶
The utilities need to access the ~/Documents
folder where the projects are and the ~/Library/embedXcode
folder where embedXcode is installed.
To allow the utilities,
- Call the menu > System Preferences.
- Select the Security & Privacy section and the Privacy pane.
- Click on the lock and enter the system password to unlock it.
- Drag and drop the utility into the list of applications.
- Close the window System Preferences.

Run unsigned and unnotarised utilities¶
Similarly, some utilities provided by the boards manufacturers are not signed or not notarised, and do not work on macOS 10.15 Catalina.
To allow unsigned and unnotarised applications to run on macOS 10.15 Catalina, either turn Gatekeeper off or keep Gatekeeper active but allow each utility.
- Open a Terminal window.
- Run
sudo spctl --master-disable
. - Call the menu > System Preferences.
- Select the Security & Privacy section and the Privacy pane.
- Click on the lock and enter the system password to unlock it.
- Set the option Allow apps downlaoded from to Anywhere.

Or keep Gatekeeper active but allow each utility.
-
Open a Terminal window.
-
For each utility
<utility>
, runspctl --add <utility>
.
For more information,
- Please refer to How to open apps from unidentified developers on Mac in macOS Catalina and How to manage OS X Gatekeeper from the command line .
Authorise the notifications¶
embedXcode relies on the utility Notify to display notifications, like information messages or warnings.

To authorise the notifications,
- Call the menu > System Preferences.
- Select the Notification section and look for the Notify application.
- Turn Allow Notifications from Notify on.
- Close the window System Preferences.
To remove the notifications,
- Proceed as above but turn Allow Notifications from Notify off.
Run 32-bit utilities¶
Some utilities are 32-bits only and do not work on macOS 10.15 Catalina. They have not been ported to 64-bit.
To allow the 32-bit utilities to run on macOS 10.15 Catalina, a parameter needs to be changed on the NVRAM.
- Open a Terminal window.
- Run
sudo nvram boot-args=”no32exec=0″
.
For more information,
- Please refer to Bringing back 32-bit apps to life .
Uninstall the template¶
There two procedures, automatic or manual, to 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
orembedXcode+
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