Get Started

  • 0.08
  • 06/18/2020
  • Public Content

Run a Sample Project Using the Command Line

Intel® oneAPI IoT Toolkit
To run the Intel oneAPI IoT Toolkit on a remote system, see Running an Eclipse* Built Application on an SSH Target.
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:
After you have downloaded the samples, follow the instructions in the
readme.md
file.
If you have not already configured your development environment, go to Configure Your System then return to this page. If you have already completed the steps to configure your system, continue with the steps below.
Command line development can be done with a terminal window or done through Visual Studio Code*. For details on how to use VS Code locally, see Basic Usage of Visual Studio Code with oneAPI on Linux*. To use VS Code remotely, see Remote Visual Studio Code Development with oneAPI on Linux*.
To compile and run a sample:
  1. Download the sample using the oneAPI CLI Samples Browser.
  2. Compile and run the sample with
    CMake*
    .

Download Samples using the oneAPI CLI Samples Browser

Use the oneAPI CLI Samples Browser to browse the collection of online oneAPI samples. As you browse the oneAPI samples, you can copy them to your local disk as buildable sample projects. Most oneAPI sample projects are built using Make or CMake, so the build instructions are included as part of the sample in a README file. The oneAPI CLI utility is a single-file, stand-alone executable that has no dependencies on dynamic runtime libraries. You can find the samples browser in the
<install-dir>/dev-utilities/latest/bin
folder on your development host system.
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. The samples can be downloaded from the code samples repository.
After you have downloaded the samples, follow the instructions in the
README.md
file. The readme file is located in the folder of the sample you are interested in.
  1. Open a
    terminal
    window.
  2. If you did not complete the steps in One time set up for setvars.sh in the Configure Your System section,
    set
    system variables by
    sourcing
    setvars:
    source /opt/intel/oneapi/setvars.sh
    The command above assumes you installed to the default folder. If you customized the installation folder,
    setvars.sh
    is in your custom folder.
    The
    setvars.sh
    script can also be managed using a configuration file. For more details, see Using a Configuration File to Manage Setvars.sh.
  3. In the same
    terminal
    window, run the application
    (it should be in your PATH)
    :
    oneapi-cli
    The oneAPI CLI menu appears:
  4. Move the arrow key down to select
    Create a project
    , then press
    Enter
  5. Select the language for your sample. For your first project, select
    cpp
    , then press
    Enter
    . The toolkit samples list appears.
  6. Use the down arrow to move down the list until you find the Intel® oneAPI IoT Toolkit section. Select the
    Hello IoT World
    sample.
    Hello IoT World
    is a simple test application that will help verify that the tools are setup correctly and can access your system's GPU:
  7. After you select a sample, press
    Enter
    .
  8. Enter an absolute or a relative directory path to create your project. Provide a directory and project name. The Project Name is the name of the sample you chose in the previous step.
  9. Press
    Tab
    to select Create, then press
    Enter
    :
    The directory path is printed below the Create button.
Now that you have a sample downloaded, compile and run the sample with CMake:

Build and Run a Sample Project using CMake*

If you have not installed CMake, follow the directions Configure Your System.
Build and Run the
hello_iot_world
Program
using CMake:
From the
hello_iot_world
directory, run the following commands:
mkdir build cd build cmake .. make make run make clean
A "Hello IoT" will appear on the command line.
Next, begin debugging the application with
gdb-ia
. GDB will break at start of code.

Product and Performance Information

1

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