Help For Compiling On Linux

Overview:

=========

The 20230223 ARMv7hf SpinAPI version supports PulseBlaster, PBDDS-I-300, PBDDS-II, PBDDS-III, PulseBlasterESR, PulseBlasterESR-PRO, PulseBlasterESR-PRO-II, PB-DualCore, PB-QuadCore, USB-PTS, and RadioProcessor boards.

The contents of each directory is explained below.

lib            - contains the SpinAPI library
include        - contains the SpinAPI headers
src            - contains the source code for the SpinAPI library
examples       - contains the source code for the SpinAPI examples

Compilation Support:

====================

Required packages, for Debian based distribution: build-essential cmake

CMake version 3.6 or later is required.

To perform a full rebuild of SpinAPI and the examples:

    cd SpinAPI_linux-20230223_ARMv7hf
    mkdir build
    cd build
    cmake ..
    make

The freshly compiled programs will be inside the build directory, for example:

    cd SpinAPI_linux-20230223_ARMv7hf
    sudo ./build/examples/General/pb_read_firmware

Note that root privileges are required, or the programs may segfault.

Device Permissions:

Device permissions must be set properly in order run SpinAPI programs. It is recommended that users set device permissions using a udev rules file. An example udev rules file can be found here: 99-spincore.rules. This file should typically be placed in "/etc/udev/rules.d/", but this path may vary depending on your Linux distribution. This file is created for the RadioProcessorUSB and PulseBlasterUSB boards. Once the rules file has been added, you can update the system rules using the command "udevadm control --reload-rules". If the SpinCore board is plugged in while performing this step, power the board off and on. Any user in group "spincore" should now have access to the board. Alternatively, applications may be run as root, but this is not recommended.