SDCLib

HowTo build

Essential requirements

• C++ 11 Compiler Support (Overview)
• CMake (> 3.5.0), pthread
• Supported Compilers:
  • GCC ( 4.8.1 ) full C++11 support
  • Clang ( 3.3 ) full C++11 support
  • MSVC++ ( 18.0 ) partial C++11 support (19.0 or higher recommended)

Additional dependecies:

• XSD, Xerces
• Examples for Debian / Ubuntu:
  • sudo apt-get install xsdcxx
  • sudo apt-get install libxerces-c-dev
  • sudo apt-get install libssl-dev
• Examples for Manjaro:
  • pamac install xerces-c
  • pamac install xsd

Build SDCLib using CMake

We recommend using CMake GUI to configure and generate the project.

• sudo apt-get install cmake-gui

(Hint: Select the "Grouped" checkbox to group name related variables together in a tree view structure)

Steps to Generate the Project (in source)

(Note: We recommend using out of source build as described below!)

• clone this project:
  • git clone https://github.com/surgitaix/sdclib.git
• navigate to the cloned folder and generate with:
  • cmake .

Steps to Generate the Project (out of source)

Note: A graphical how-to of the following steps to generate the makefiles can also be found under doc/SDCLib_Eclipse.pdf. Just the used generator varies. Choose "Unix Makefiles" and proceed as described.

(Steps with cmake-gui!)

• clone this project:
  • git clone https://github.com/surgitaix/sdclib.git
• Open cmake gui.
• Browse Source... -> select the cloned folder (default should be this projects name: sdclib)
• Browse Build... -> select another folder (e.g. sdclib_build)
• Click Configure: If the build folder does not exist, CMake will ask if it should create it for you. Select yes.
• In the next dialog you have to specify the generator. Unix Makefiles should be fine but if your preferred IDE has CMake support it will probably be listed in the drop down too. If you have the choice between Ninja and a Unix Makefiles variant, choose the Unix Makefile variant.
• Stay with the option "Use default native compilers" unless you know what you are doing and click Finish.
• During configuration you will most likely see a Warning (red text): It tells you that it could not find the sdclib (yet). For most users it is fine to proceed here.
• Configure and Generate again. The new variable will be highlighted by CMake.
  NOTE: The Warning wont disappear unless you finally built the library.
• Your project should now be generated inside the selected build folder.

Further configuration

BuildType

The Buildtype is controlled by CMAKE_BUILD_TYPE and defaults to Debug. If you want to change it, you can either do this inside the gui before calling configure/generate or pass it via the command line e.g.:

• cmake -DCMAKE_BUILD_TYPE=Release

Examples and Tests

Examples and Tests are built by default. If you dont want to built them, you can set the option to OFF before building.

• SDC_EXAMPLES [ON/OFF]
• SDC_TESTS [ON/OFF]

See the 'Examples' and 'Tests' folders for example implementations.
To run SDC related tests run './UnitTests'.

Building the Project

To build the project navigate to the build folder and enter:

• make

You can specify the number of parallel jobs with j (The following command uses 4 parallel jobs):

• make -j4

Note: On a Raspberry Pi you have to lower the number of parallel jobs ( -j ) or just use make without arguments.

Installing the Library (Non CMake Projects)

To get all the necessary Files to integrate the SDCLib into other projects (without CMake) follow the instructions above, but instead of make issue make install (with the optional -j parameter). This will copy the executable files / SDCLibrary and the header files into the folder inside the CMake Variable CMAKE_INSTALL_PREFIX. By default this will be <YOUR_BUILD_FOLDER>/install.

Using the SDCLib inside your project

To use the SDCLib inside your project we provide FindSDCLib.cmake .
You can include the following lines inside your CMakeLists file (Change the variables where marked with <...>):

###### Set the Search Path - FindSDCLib.cmake requires this variable as "entry point"
set(SDCLib_SEARCH_DIRS "<ABSOLUTE PATH TO SDCLIB FOLDER>" CACHE STRING "SDCLib root dir")
# Add SDCLib modules folder to CMake Modules Path
get_filename_component(PROJECT_CMAKE_MODULES ${SDCLib_SEARCH_DIRS}/cmake/Modules REALPATH)
message(STATUS "Adding ${PROJECT_CMAKE_MODULES} to Modules Path...")
set(CMAKE_MODULE_PATH ${CMAKE_MODULE_PATH} ${PROJECT_CMAKE_MODULES})
###### Out of Source build - Set the additional search path manually (dont change build folder later or change this too)
set(SDCLib_EXTERNAL_LIBRARY_DIRS "<ABSOLUTE PATH TO SDCLIB BUILD FOLDER>/bin" CACHE STRING "External Dirs")
find_package(SDCLib)
if(NOT SDCLib_FOUND)
    message(FATAL_ERROR "SDC not found, build it first or specify correct path!")
endif()

Hint: Depending on your project structure you can get the absolute file path (cleaned from symbolic links) with the following command and refer to the sdclib root folder like:

###### Example where 'dependencies/' is a subfolder inside your projects root folder
get_filename_component(MY_DEPENDENCIES_FOLDER ${CMAKE_CURRENT_LIST_DIR}/dependencies/ REALPATH)
set(SDCLib_SEARCH_DIRS "${MY_DEPENDENCIES_FOLDER}/sdclib" CACHE STRING "SDCLib root dir")
...

Note: There may be side effects in using CMAKE_CURRENT_LIST_DIR, so refer to the official CMake documentation here.

Use the set SDCLib_XXX Variables with your target:

target_include_directories(MyExecutable PRIVATE ${SDCLib_INCLUDE_DIRS})
target_link_libraries(MyExecutable PRIVATE ${SDCLib_LIBRARIES})

Note: You can find a small CMake Project using the SDCLib under Examples/CMakeExample!

Firewall configuration

Install ufw and open ports:

• sudo apt-get install ufw
• sudo ufw allow 3702/udp # discovery
• sudo ufw allow 5555/udp # streaming

Optional dependencies for MdibVisualizer

• graphviz, evince, pdfunite