Skip to main content

Quick Start

This guide will step you through the process of building and running sample applications available on the Nebula platform SDK.

Prerequisites

  • Basic understanding of Nebula Pulsar Platform communication module.
  • Basic understanding of the C++14 language.
  • Basic understanding of CMake based build system.
  • Familiarity with ara::com concepts.
  • Familiarity with Franca Interface Definition Language.
  • Familiarity with Pulsar code generation tool.

Setting up the Environment

This section details software installations, configurations, or environment setups needed for Nebula Pulsar SDK and for building applications based on the SDK

Environment Prerequisites

  • Ubuntu 22.04.3 LTS
  • GCC C++ Compiler v9.4.0
  • CMake > v3.16
  • Boost C++ libraries v1.74

To install the prerequisites on Ubuntu 22.04.3 execute following command

$ sudo apt install build-essential cmake libboost-all-dev

Build App

To build any specific app using SDK follow the steps

$ cd  <app folder>
$ mkdir build
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX=<SDK Install Path> ..
$ make

For example to build the HelloWorldServer application from Sample code. Follow the below steps

$ cd  <SDK Install Path>/samples/aracom/HelloWorldServer/
$ mkdir build
$ cd build
$ cmake -DCMAKE_INSTALL_PREFIX=<SDK Install Path> ..
$ make
tip

For each sample application, the build and run steps are explained in README.md contained in respective application folder.

Run

The built applications can be run using execution manager or as standalone (recommended only for testing). Follow the below steps to launch an application using EM once its deployed to application folder. (default ./opt folder)

note

The sample applications can be deployed by running make install from their build folder once its built.

$ cd <SDK Install Path>
$ export LD_LIBRARY_PATH=<SDK Install Path>/lib
$ ./bin/routingdaemon &> /dev/null &
$ ./bin/executionManager -d ./bin/ -d ./opt/

To launch the application standalone, it can be directly launched after setting the library path. For example to launch the HelloWorldServer application from Sample code. Follow the below steps

$ cd build
$ export LD_LIBRARY_PATH=<SDK_Path>/lib
$ ./HelloWorldServer