Installing the SAMSON SDK

Facebooktwittergoogle_plusredditpinterestlinkedinmailFacebooktwittergoogle_plusredditpinterestlinkedinmail

Introduction

This tutorial applies for SAMSON version 0.7.0 and higher. For an older version, please, check SAMSON School 2017: Introduction and installation of the SAMSON SDK.

The SAMSON SDK (Software Development Kit) is a set of software development tools that help and allow the creation of new SAMSON Elements for the SAMSON software platform.

In addition to the provided SAMSON API (Application programming interfaces) which is a set of C++ headers and libraries, the SAMSON SDK also provides some SAMSON Elements to help developers design their SAMSON Elements:

Requirements

A 64-bit architecture with a 64-bit operating system (Windows 7, Windows 8, Windows 10, Ubuntu 14.04+, Fedora 21+, Mac OS 10.10.5+). Installation with older versions of operating systems has not been tested. If you experience any problems with installation, please, check SAMSON Forum.

To develop SAMSON Elements with SAMSON SDK 0.7.0 you will need:
1. SAMSON 0.7.0 installed first.

2. A compatible compiler

3. CMake v.2.8.9+, you can use your preferred version. On Windows, during the installation, please, specify to add CMake to the Path environment variable

4. Qt 5.9.3 for 64-bit architecture installed on your machine.

  • Windows: Qt5.9.3
    Add the path to Qt binaries into the system Path environment variable (see how to set the path and environment variables in Windows), i.e. the path to the qmake.exe file and dll libraries (by default, this should be C:\Qt\5.9.3\msvc2015_64\bin):

    • for Microsoft Visual Studio 2015: YourQtPath\Qt\5.9.3\msvc2015_64\bin
    • for Microsoft Visual Studio 2017: YourQtPath\Qt\5.9.3\msvc2017_64\bin

    This path should be the first one in the Path environment variable.

  • Linux: Qt5.9.3.
    Define an environment variable called QT5_CMAKE_INCLUDE_DIR equal to the path to the gcc_64/lib/cmake folder in the Qt installation. Add the path to Qt libraries to your LD_LIBRARY_PATH environment variable.
    export QT5_CMAKE_INCLUDE_DIR=YourQtPath/Qt5.9.3/5.9.3/gcc_64/lib/cmake/
    export LD_LIBRARY_PATH=YourQtPath/Qt5.9.3/5.9.3/gcc_64/lib:$LD_LIBRARY_PATH
  • Mac OS: Qt5.9.3.
    Define or add to the DYLD_FRAMEWORK_PATH environment variable the path to the clang_64/lib folder in the Qt installation.
    Define an environment variable called QT5_CMAKE_INCLUDE_DIR equal to the path to the clang_64/lib/cmake folder in the Qt installation.
    Open .bash_profile in your user directory and add the next two lines:
    export DYLD_FRAMEWORK_PATH=YourQtPath/Qt5.9.3/5.9.3/clang_64/lib:$DYLD_FRAMEWORK_PATH
    export QT5_CMAKE_INCLUDE_DIR=YourQtPath/Qt5.9.3/5.9.3/clang_64/lib/cmake

5. IDE (“Integrated Development Environment”):

Installation

To install the SAMSON SDK, you need to have a developer status. To get this status you need to do the following steps and send a developer request to us via samson-connect.net:

  1. Go to samson-connect.net
  2. Login to your account
  3. Go to My SAMSON → Develop Elements
  4. Click on “Get the SDK”. If everithing works well you should see the notification: “Your request has been sent” and the button text should be “Request sent”

Once you are granted the developer status, you can download the SAMSON SDK from samson-connect.net

  1. Go to samson-connect.net
  2. Login to your account (you need to logout and login again to refresh SAMSON Connect behaviour)
  3. Go to Download → SDK
  4. Click on “Get the SDK”, select were to save the installer and click Ok
  5. A key will be sent to the email address you used for registration when downloading the SDK. You will need to provide this key during the installation process.

Once you have downloaded the SAMSON SDK and prepared your environment as indicated in the Requirements section, you can launch the installer.

  • Windows
    • Double-click on the executable file.
    • Follow the installation steps.
  • Linux
    • Open a terminal
    • Go to the folder where SAMSON SDK installer was saved:
      cd /folder/with/installer/
    • Make the installer executable:
      chmod +x SAMSON-Developer-Setup.run
    • Run the installer (please, do not use sudo here):
      ./SAMSON-Developer-Setup.run
    • Follow the installation steps.
  • Mac OS
    • Double-click on the SAMSON-Developer-Setup.dmg file you have just downloaded to make its content available. Usually, a new window will be openned showing the content of the dmg-file, which should be SAMSON-Developer-Setup. Press the Control key (Ctrl) and click on the icon SAMSON-Developer-Setup, then click Open from the shortcut menu. The dialog window should appear with a security notification, press Open.
    • Follow the installation steps.
    • After the installation is done you may eject the .dmg by clicking the eject button in the Sidebar.

Once the SAMSON SDK installation is finished, there are some final things to do depending on the platform you are. If you experience any problems please check SAMSON-Connect forum. Assume, that SAMSON SDK is installed in SDK_PATH folder.

  • Windows
    • Go to SDK_PATH\SDK\0.7.0\SAMSON-Debug\Binaries (e.g., SDK_PATH = Home Directory\NANO-D or C:\Program Files\NANO-D).
    • Double click on SAMSON-Core.exe, it should launch the developers version of SAMSON.
  • Linux
    • Open a terminal
    • Go to SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries
    • Open and edit file SAMSON-Core.sh. You need to provide a path to Qt installed in your system, for that modify the following line:
      export LD_LIBRARY_PATH=YourQtPath/Qt5.9.3/5.9.3/gcc_64/lib:$script_dir:$LD_LIBRARY_PATH
      Save the file.
    • Open terminal in this folder and execute ./SAMSON-Core.sh, it should launch the developers version of SAMSON.

    You may also need to make executable the following files placed in SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries: SAMSON-Core.sh and SAMSON-Core:
    cd SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries
    ls -la | grep "SAMSON-Core"
    chmod +x SAMSON-Core*

    For an easy launch, you may create an alias in your .bachrc file:
    alias samson-debug='SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries/SAMSON-Core.sh'

  • Mac OS
    • Open a terminal
    • Go to SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries
    • Open and edit file SAMSON-Core.command. Uncomment and verify the following line:
      export DYLD_FRAMEWORK_PATH=YourQtPath/Qt5.9.3/5.9.3/clang_64/lib:$DYLD_FRAMEWORK_PATH
    • Open terminal in this folder and execute ./SAMSON-Core.command, it should launch the developers version of SAMSON.

    You may also need to make executable the following files placed in SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries: SAMSON-Core.sh and SAMSON-Core:
    cd SDK_PATH/SDK/0.7.0/SAMSON-Debug/Binaries
    ls -la | grep "SAMSON-Core"
    chmod +x SAMSON-Core*

At this step, you should have a working SAMSON-Debug. Now, you are ready to program your first SAMSON Element. Check out the following tutorials:

If you have experienced any problems, please check SAMSON-Connect forum.

Facebooktwittergoogle_plusredditpinterestlinkedinmailFacebooktwittergoogle_plusredditpinterestlinkedinmail

Leave a Reply

Your email address will not be published. Required fields are marked *