FrontPanel SDK Release Notes

Latest Release (FrontPanel 6.0.0)

The configurations below represent the current build targets for the API, samples, and applications in this release. Many similar configurations are known to work (e.g. Linux Ubuntu, etc) but these are the official distribution targets. 

OSC/C++PYTHONJAVARUBYC#Platform
Windows 10, 11 (x64)MSVS 20223.9+21YesYes
macOS 11+
Intel and Apple Silicon
Apple Clang 173.9+21YesYes
Ubuntu 24.04 LTS (x64)
Linux 6.8.0-48
gcc 13.3.03.9+21YesYes
Ubuntu 22.04 LTS (x64)
Linux 5.15.0-1013
gcc 11.4.03.9+21YesYes
Rocky Linux 10.1 (x64, RHEL 10)
Linux 6.12.0-124.8.1
gcc 14.3.13.9+21YesYes
Rocky Linux 9.3 (x64, RHEL 9)
Linux 5.14.0-472
gcc 11.5.03.9+8YesYes
Raspbian 12.0 (ARM64-Raspberry Pi, Bookworm)
Linux 6.6.31
gcc 12.2.03.9+21Yes

Language columns (C/C++, Python, Java, Ruby, C#): These indicate availability of FrontPanel API language bindings — wrapper libraries that allow applications written in those languages to call FrontPanel API functions directly.

Platform column: “Yes” indicates that the FrontPanel Platform application is available for that operating system. FrontPanel Platform is an Electron-based application that includes the graphical Device Manager and hosts TypeScript/JavaScript GUI applications such as the bundled examples and any custom apps you develop.

Changelog

  • Ubuntu 20.04 LTS support has been removed from FrontPanel 6+ went end-of-life 2025-04-30.
  • Rocky Linux 8 support has been removed.
  • Raspian 10.0 support has been removed.
  • nVidia TX2 support has been removed on Ubuntu 18.04.
  • The FrontPanel Application (FrontPanel Classic) has been removed from the SDK package. Release 5.3 is the continuing maintenance release for the application.
  • The FrontPanel Platform is now the supported application for managing FrontPanel-based devices.
  • FrontPanel Platform Example application sources added for Counters, DES, PipeTest, and RAMTester
  • Wire, Trigger, and Pipe Methods have been moved into a new FPGADataPortClassic class.
  • New GetFPGADataPortClassic and GetFPGADataPortAXI methods have been added to FrontPanel class.
  • Example source have been updated to use the new FPGADataPortClassic class.
  • FrontPanel::Error code has been replaced with OpalKelly::ErrorCode

Deprecation Notices

The following deprecated methods have been removed in FrontPanel 6.0.

  • okCFrontPanel::IsFrontPanel3Supported
  • okCFrontPanel::EnableAsynchronousTransfers
  • okCFrontPanel::GetHostInterfaceWidth – Migrate to these methods:
    • okTDeviceInfo::wireWidth
    • okTDeviceInfo::triggerWidth
    • okTDeviceInfo::pipeWidth
    • okTDeviceInfo::registerAddressWidth
    • okTDeviceInfo::registerDataWidth
  • okCFrontPanel::IsHighSpeed – Migrate to okTDeviceInfo::usbSpeed
  • okCFrontPanel::GetBoardModel – Migrate to okTDeviceInfo::productID
  • okCFrontPanel::GetDeviceMajorVersion – Migrate to okTDeviceInfo::deviceMajorVersion
  • okCFrontPanel::GetDeviceMinorVersion – Migrate to okTDeviceInfo::deviceMinorVersion
  • okCFrontPanel::GetSerialNumber – Migrate to okTDeviceInfo::serialNumber
  • okCFrontPanel::GetDeviceID – Migrate to okTDeviceInfo::deviceID
  • okCFrontPanel::GetDeviceCount – Migrate to OpalKelly::FrontPanelDevices::GetCount
  • okCFrontPanel::GetDeviceListModel – Migrate to okTDeviceInfo::productID
  • okCFrontPanel::GetBoardModel – Migrate to okTDeviceInfo::productID
  • okCFrontPanel::GetDeviceListSerial – Migrate to OpalKelly::FrontPanelDevices::GetSerial()
  • okCFrontPanel::OpenBySerial – Migrate to OpalKelly::FrontPanelDevices::Open()

Known Issues

  • Configuration Flash programming for USB Gen 2 devices (e.g. XEM6310) is inoperative. Planning a fix for 6.1 release.
  • loadConfigurationFromMemory() and loadConfigurationFromFile() methods of the IFPGAConfiguration JavaScript API interface throw an exception when optional progressCallback is not defined.
  • DESTester.rb Ruby example sources are not migrated to the new 6.0.0 API. Planning to fix in 6.1 release.

Previous Releases (FrontPanel 5.x)

FrontPanel 5.x Release Notes

FrontPanel 5 is currently under long-term (maintenance) support. Release notes are available here:

FrontPanel 5.x SDK Release Notes