Installation#

These instructions primarily focus on the PixieSDK. We encourage all users to migrate to the latest version of the library. For convenience, we have kept the C API library named Pixie16Api.

We will not be distributing any precompiled binaries for the time being. This is due to the extreme variability of the compiler / architecture options for Windows.

There are a number of CMake Options available when generating the build system files. The defaults will always build the PixieSDK and the Pixie16Api compatibility library.

Prerequisites#

You’ve already

  1. installed the Broadcom PCI/PCIe SDK 8.00 or newer,

  2. exported the PLX_SDK_DIR in your environment,

  3. installed CMake 3.10+,

  4. the cmake application is available in your path, and

  5. installed a compiler that supports C++ 17 standard on a supported platform.

Windows 10#

Instructions#

  1. Clone or download the project and put the pixie_sdk directory in your Downloads folder.

  2. Open an x64_x86 Cross Tools Visual Studio Developer Command Prompt

  3. Navigate to the source folder

    C:\Program Files (x86)\Microsoft Visual Studio\2019\Community>cd %USERPROFILE%\Downloads\pixie_sdk

  4. Create and enter the build directory

    C:Users\username\Downloads\pixie_sdk>mkdir build && cd build

  5. Generate the nmake build scripts

    C:Users\username\Downloads\pixie_sdk\build>cmake.exe ..\

  6. Build the project

    C:Users\username\Downloads\pixie_sdk\build>cmake --build .\

    OR

    C:Users\username\Downloads\pixie_sdk\build>msbuild ALL_BUILD.vcxproj /p:Configuration=Release -maxcpucount:4

  7. Optional Install the project (requires administrative command prompt)

    C:Users\username\Downloads\pixie_sdk\build>msbuild INSTALL.vcxproj /p:Configuration=Release -maxcpucount:4

Linux#

Instructions#

These installation instructions assume that you’re using git to obtain a copy of the project. If you’re starting with a zip folder from a release then skip to Step 2.

  1. Clone the project

    [user@localhost ~]$ git clone https://github.com/xiallc/pixie_sdk.git

  2. Navigate to the cloned project

    [user@localhost ~]$ cd pixie_sdk

  3. Configure and build the project

    [user@localhost pixie_sdk]$ mkdir build; cd build; cmake ../

  4. Compile the project

    [user@localhost build]$ make

  5. (Optional) Install the software system-wide. Defaults to /usr/local/xia/PixieSDK.

    [user@localhost build]$ sudo make install

  6. (Optional) Add the XIA_PIXIE_SDK environment variable (assumes bash)

    [user@localhost build]$ echo -e "export XIA_PIXIE_SDK=/usr/local/xia/PixieSDK\n" | sudo tee -a /etc/profile.d/xia_pixie_sdk.sh

CMake Options#

Primary Options#

Option

Description

Default

BUILD_EXAMPLES

Builds the example programs

ON

BUILD_SDK

Builds PixieSdk.a

ON

BUILD_TESTS

Builds the test suites

OFF

Dependent Options#

Option

Depends on

Default

BUILD_INTEGRATION_TESTS

BUILD_TESTS BUILD_SDK

ON

BUILD_PIXIE16_API

BUILD_SDK

ON

BUILD_SYSTEM_TESTS

BUILD_TESTS BUILD_SDK

ON

BUILD_SDK_UNIT_TESTS

BUILD_TESTS BUILD_SDK

ON