Get Started

  • 0.09
  • 09/09/2020
  • Public Content

Run a Sample Project with

Intel® oneAPI IoT Toolkit
If you are using
with FPGA see the Intel
oneAPI DPC++ FPGA Workflows on Third-Party IDEs
After you run your sample project, use the Intel
System Debugger
to debug with a modern, GUI-based architecture system software debugger.

Building a Project Using Eclipse* IDE

You can access the entire suite using Eclipse* (see the release notes for minimum required version). If you need to install any of the Eclipse* plug-ins or are having any problems with the plug-ins, see the Troubleshooting section.
An internet connection is required to download the samples for oneAPI toolkits. If you are using an offline system, download the samples from a system that is internet connected and transfer the sample files to your offline system. If you are using an IDE for development, you will not be able to use the oneAPI CLI Samples Browser while you are offline. Instead, download the samples and extract them to a directory. Then open the sample with your IDE. The samples can be downloaded from here:
To use the compilers installed with the
Intel® oneAPI IoT Toolkit
, you must set up your environment by sourcing the setvars script or by loading a module file before launching the Eclipse* IDE workspace. The Intel oneAPI Samples plugin creates individual projects from an existing code samples and uses the CMake build system. You can specify the compiler executable used by changing CMake configuration variables (e.g., CMAKE_CXX_COMPILER to specify the C++ compiler front end). The
C/C++ Build
tab cannot be used to configure CMake projects.
To watch a video presentation of how to create a project, see Intel® oneAPI Eclipse Samples Plugin.
  1. Open a terminal session and source
  2. From the same terminal session, launch the version of Eclipse that you chose for integration during installation. The Intel-provided Eclipse option is in
    , where
    is typically
    when installed as root or a super user, and
  3. From the top level menu bar, select
    Browse Intel Samples
    . The samples window appears:
  4. Click
    Intel® oneAPI IoT Tooklit
  5. Click
    Intel® C++ Compiler Classic
  6. Click the
    Hello IoT World
  7. Click
  8. To build the project, first exclude the build folder by right clicking on the build folder and selecting
    Resource Configurations
    Exclude from Build...
  9. Click
    Build Project
  10. To run the application, click
    A "Hello IoT" message appears in the Eclipse console.
  11. Begin debugging the application.
    The debugger displays a breakpoint at the start of code.

Running a Remote Sample on an Up Squared* Device

  1. Create a Connection within Eclipse by selecting the
    New Connection
  2. Select the SSH Connection type and click
  3. Enter the Hostname and Username for your remote target. You can either use Key-based authentication or Password, depending on the configuration of the remote device.
  4. You may also be then prompted to set an Eclipse Secure Storage password. This protects the password you entered when stored on the disk. Enter the password and click OK.
  5. When connecting to the device for the first time, you should be prompted to trust the device. Click Yes to continue.
  6. From the top level menu bar, select
    Browse Samples
    and select the UP Squared Built-in LEDs sample.
  7. In the
    Project Explorer
    tree, right-click the Up Squared sample and then select
    Build Configurations
    Build All
  8. After the build command executes, in the
    Project Explorer
    tree, expand
    to see the binary. Right-click the
    binary, and then select
    Run Configurations
    Run Configurations
    dialog box opens.
  9. To create a remote run configuration, double-click
    C/C++ Remote Applications
    to create the new run configuration, then populate the following fields.
    Some of the fields pre-populate based on your selection of the binary.
    1. For
      , choose the new remote connection that you created.
    2. Choose a path for the binary on the remote UP Squared device (any directory that you can access will work).
    3. If multiple launchers are available, select the
      launcher to continue with SSH.
    4. Click
      and then
    After the remote application launches, the multi-color LEDs on the UP Squared board blink continuously.
    A message about authorization on the target device may appear, but authorization may not be required. Allow a few seconds for the application to launch on the target.
    run config dialog box

Create a Project Using Visual Studio Code

This procedure requires the Sample Browser extension to be installed. If you have not installed it, see Install the Sample Browser Extension.
  1. Navigate to the install directory and source
    source <install_dir>/
    The command above assumes you installed to the default folder. If you customized the installation folder,
    is in your custom folder. See here for more information on
  2. Launch VSCode:
  3. Click on the oneAPI button on the left navigation to view samples.
  4. A list of available samples will open in the left navigation.
  5. Select a sample. Instructions for how to build and run that sample will appear in a preview window.
  6. To build and run a sample, click the + to the right of the sample name.
  7. Create a new folder for the sample. The sample will load in a new window:
  8. Click to view instructions for the sample.
Not all oneAPI sample projects use CMake. The
file for each sample specifies how to build the sample. We recommend that you check out the CMake extension for VSCode that is maintained by Microsoft.
For more information on using VSCode with Intel oneAPI toolkits, see:

Product and Performance Information


Intel's compilers may or may not optimize to the same degree for non-Intel microprocessors for optimizations that are not unique to Intel microprocessors. These optimizations include SSE2, SSE3, and SSSE3 instruction sets and other optimizations. Intel does not guarantee the availability, functionality, or effectiveness of any optimization on microprocessors not manufactured by Intel. Microprocessor-dependent optimizations in this product are intended for use with Intel microprocessors. Certain optimizations not specific to Intel microarchitecture are reserved for Intel microprocessors. Please refer to the applicable product User and Reference Guides for more information regarding the specific instruction sets covered by this notice.

Notice revision #20110804