FrontPanel API  4.5.0
Overview

The FrontPanel API provides a powerful C++ interface to Opal Kelly USB and PCI Express FPGA boards.

To build an application using this API, you need to include the files okFrontPanelDLL.h and okFrontPanelDLL.cpp in your project. These contain stub functions that will make calls to the DLL. You will also need to include the okFrontPanel.dll library in the same directory as your executable.

To use the library, you create an instance of okCFrontPanel which encapsulates communication with the USB driver and provides access to FrontPanel endpoints. The simplest way to do it is to create an instance of okCFrontPanelDevices object associated with the given "realm", by default just the realm of locally connected devices is used. You can then use its Open() method to open the first, or all, of the available devices.

Alternatively, you could call GetDeviceCount to determine how many devices are available and then use the GetDeviceListXXX methods to determine specific information about the boards attached, then call OpenBySerial to open one of them by referring to its serial number. (If no serial number is provided, this method opens the first available device.) However notice that these methods only work for the local devices.

ConfigureFPGA is used to download a configuration file to the FPGA. Sending data to WireIn endpoints is done with calls to SetWireInValue followed by a call to UpdateWireIns to simultaneously update all Wire Ins. ActivateTriggerIn is used to trigger the XEM.

The API uses polling to query the values of output endpoints such as WireOuts and TriggerOuts. The methods UpdateWireOuts and UpdateTriggerOuts perform these queries. Once the wire and trigger values have been updated by these methods, you can retrieve the values using the methods GetWireOutValue and IsTriggered or GetTriggerOutVector.


Version:

$Rev: 2825 $
$Date: 2015-05-26 10:20:33 -0700 (Tue, 26 May 2015) $

Copyright (c) 2005-2015 Opal Kelly Incorporated