Skip to content

Create a new project

Create a new project

To create a new project,

  • Call the menu File > New > Project... or press Cmd+Shift+N.

  • Select the macOS option.

  • Scroll down and look for the embedXcode or embedXcode+ group depending on the edition installed.

Select an embedXcode project template

Based on the options selected during the installation, the embedXcode standard edition group of templates include one single option for the Wiring / Arduino framework.

Select an embedXcode for Wiring / Arduino template

If embedXcode is installed and selected,

  • Select the template embedXcode for all the boards running on the Wiring / Arduino framework.

  • Click on Next to proceed to the next step.

Select an embedXcode+ project template

The embedXcode+ edition group of templates include five options for the Wiring / Arduino framework.

Select an embedXcode+ for Wiring / Arduino template

If the embedXcode+ edition is installed and selected, five options are available for the Wiring / Arduino framework.

  • Select the template embedXcode+ for all the boards running on the Wiring / Arduino framework.

  • Select the template embedXcode+ Arduino for the Arduino and Intel boards running on the Wiring / Arduino framework.

  • Select the template embedXcode+ Energia for the LaunchPad boards running on Energia.

  • Select the template embedXcode+ Energia MT for the LaunchPad boards running on Energia MT or Energia Multi-Tasking, based on Texas Instruments RTOS.

  • Select the template embedXcode+ Teensy for the Teensy boards running on the Wiring / Arduino framework..

Define the parameters of the new project

Once the option is selected, a second window asks for the parameters of the project.

On the embedXcode+ edition prior to release 7.0, an additional parameters defines the Update Policy. Please refer to Manage the Update Policy .

Name the project

  • Type in the Name of the project.

As for the standard IDEs, avoid spaces and special characters in the project name.

The iCloud drive contains special characters, it is thus recommended not to store projects inside.

  • Optionally, provide the Organisation Name and the Company Identifier. Those fields are pre-populated.

  • The Bundle Identifier is set automatically and can't be edited.

  • Provide a Description of the project. This field is optional.

Select the scope of the project

The Scope defines the kind of project: an example, a single sketch or a library.

Optionally on the embedXcode+ edition, the scope also sets the extension for the main sketch, standard .ino or C++ file .cpp.

  • Select the Scope among the options on the pull-down list.

For a first ready-to-use project,

  • Select the scope Example for a sketch populated with the standard blinking example.

For the first project, the recommended option is the Example project. It provides a sketch with a local library and corresponds to the standard blink example.

For an empty sketch, select the scope Sketch.

  • The Sketch (ino) option sets the ino extension for the main sketch.

  • The Sketch (cpp) option sets the .cpp extension for the main sketch.

When developing a new library, select the scope Library for an empty local library.

  • The Library (ino) option sets the .ino extension for the main sketch.

  • The Library (cpp) option sets the .cpp extension for the main sketch.

On the embedXcode+ edition, there are two options for the sketch extension.

  • Choose ino to allow editing the sketch with the standard IDEs of the boards.

  • Chose cpp to obtain a better compliance with the tool-chain, for example with debugging and disassembly of the executable code.

An embedXcode+ Energia MT project only offers the C++ file .cpp option, as each .ino file corresponds to a task.

For more infromation on adding a task for a embedXcode+ Energia MT project,

Select the board

  • Select the board on the drop-down list.

The names of the boards always starts with the platform and then the MCU, and ends with an option.

As examples, Arduino Uno, LaunchPad MSP430F5529, LaunchPad CC3200 and LaunchPad CC3200, LightBlue Bean (Bluetooth).

The board can be changed afterwards.

Optionally on the embedXcode+ edition, if your board isn't listed, you can create a configuration file.

Include the resources for all variants

Two platforms include multiple variants: Arduino with AVR, SAM and SAMD; and Energia with MSP430, MSP432, C2000, CC3200 and Tiva C.

  • For the Arduino and Energia platforms, if you plan to use the project on the selected variant only, check the box Include resources for selected variant only.

In this example, only the AVR resources will be included, not the SAM and SAMD.

  • For the Arduino and Energia platforms, if you plan to use the project on all the variants, leave the box Include resources for selected variant only unchecked.

In this example, the resources for all the variants, MSP430, MSP432, C2000, CC3200 and Tiva C, will be included.

For the other platforms, the option is not available, in light grey or hidden.

Select the Licence of the Project

The embedXcode+ edition provides a field for the Licence.

  • Select Licence on the combo list.

If the desired licence isn’t available on the list, type it in.

Select the folder and create the project

  • Click on Next to proceed to the last step.

A third and last window asks for the folder where to save the project and the activation of the version management.

Select the folder

  • Select the folder where the project is going to be saved.

  • Click on New Folder to create a new folder.

As for the standard IDEs, avoid space and special characters in the folder name.

The iCloud drive contains special characters, it is thus recommended not to store projects inside.

Activate version management

To activate the version management,

  • Click on Options to display the Source Control pane.

  • Check Create Git repository on.

  • Optionally, set the repository on My Mac or Add to New Server...

  • Optionally, select the project or repository to add to.

Finalise and Create the Project

  • Finally, click Create to confirm and create the project.

If the project already exists, a dialogue box asks for confirmation:

  • Click on Replace to replace the previous project with the new one, or

  • Click on Cancel to change the name of the project.