FrontPanel 6.0 introduces several breaking changes to the Java API. The most significant are:

• Device opening — OpenBySerial() and device-listing methods are removed; use okCFrontPanelDevices instead
• Data port separation — Wire, Trigger, Pipe, Register, and ResetFPGA operations move from okCFrontPanel to a dedicated okCFPGADataPortClassic object
• Standalone error codes — okCFrontPanel.ErrorCode becomes a standalone ErrorCode class
• Removed convenience methods — Several methods eliminated in favor of GetDeviceInfo()

OpenBySerial(), GetDeviceCount(), and GetDeviceListSerial() are removed. Use okCFrontPanelDevices instead.

// FP5:
okCFrontPanel dev = new okCFrontPanel();
dev.OpenBySerial("");

// FP6:
okCFrontPanelDevices devices = new okCFrontPanelDevices();
okCFrontPanel dev = devices.Open();Code language: Java (java)

Open() returns the device object directly. Pass a serial number to open a specific device, or pass an empty string to open the first available device.

Device enumeration:

// FP5:
okCFrontPanel dev = new okCFrontPanel();
int count = dev.GetDeviceCount();
for (int i = 0; i < count; i++) {
    String serial = dev.GetDeviceListSerial(i);
}

// FP6:
okCFrontPanelDevices devices = new okCFrontPanelDevices();
int count = devices.GetCount();
for (int i = 0; i < count; i++) {
    String serial = devices.GetSerial(i);
}Code language: Java (java)

After configuring the FPGA, call GetFPGADataPortClassic() on the okCFrontPanel instance:

// FP5:
dev.ConfigureFPGA("my_design.bit");

if (dev.IsFrontPanelEnabled())
    System.out.println("FrontPanel support is enabled.");

dev.SetWireInValue(0x00, 0x01);
dev.UpdateWireIns();

// FP6:
dev.ConfigureFPGA("my_design.bit");

if (dev.IsFrontPanelEnabled())
    System.out.println("FrontPanel support is enabled.");

okCFPGADataPortClassic classicDataPort = dev.GetFPGADataPortClassic();
classicDataPort.SetWireInValue(0x00, 0x01);
classicDataPort.UpdateWireIns();Code language: Java (java)

The object returned by GetFPGADataPortClassic() is owned by the okCFrontPanel instance. It remains valid for the lifetime of that object.

Change every call that previously went through okCFrontPanel to go through the classic data port instead. The method names and parameters are identical — only the target object changes.

Wires:

// FP5:
dev.SetWireInValue(0x00, value, mask);
dev.UpdateWireIns();
dev.UpdateWireOuts();
long wireOut = dev.GetWireOutValue(0x20);

// FP6:
classicDataPort.SetWireInValue(0x00, value, mask);
classicDataPort.UpdateWireIns();
classicDataPort.UpdateWireOuts();
long wireOut = classicDataPort.GetWireOutValue(0x20);Code language: Java (java)

Triggers:

// FP5:
dev.ActivateTriggerIn(0x40, 0);
dev.UpdateTriggerOuts();
if (dev.IsTriggered(0x60, 1)) { ... }

// FP6:
classicDataPort.ActivateTriggerIn(0x40, 0);
classicDataPort.UpdateTriggerOuts();
if (classicDataPort.IsTriggered(0x60, 1)) { ... }Code language: Java (java)

Pipes:

// FP5:
dev.WriteToPipeIn(0x80, length, data);
dev.ReadFromPipeOut(0xA0, length, data);
dev.WriteToBlockPipeIn(0x80, blockSize, length, data);
dev.ReadFromBlockPipeOut(0xA0, blockSize, length, data);

// FP6:
classicDataPort.WriteToPipeIn(0x80, length, data);
classicDataPort.ReadFromPipeOut(0xA0, length, data);
classicDataPort.WriteToBlockPipeIn(0x80, blockSize, length, data);
classicDataPort.ReadFromBlockPipeOut(0xA0, blockSize, length, data);Code language: Java (java)

Registers:

// FP5:
dev.ReadRegister(addr, data);
dev.WriteRegister(addr, data);

// FP6:
classicDataPort.ReadRegister(addr, data);
classicDataPort.WriteRegister(addr, data);Code language: Java (java)

ResetFPGA:

// FP5:
dev.ResetFPGA();

// FP6:
classicDataPort.ResetFPGA();Code language: Java (java)

The ErrorCode nested enum has been moved from okCFrontPanel.ErrorCode to a standalone ErrorCode class:

// FP5:
if (okCFrontPanel.ErrorCode.NoError != dev.ConfigureFPGA(file))
    ...

// FP6:
if (ErrorCode.NoError != dev.ConfigureFPGA(file))
    ...Code language: Java (java)

Common replacements:

• okCFrontPanel.ErrorCode.NoError → ErrorCode.NoError
• okCFrontPanel.ErrorCode.Failed → ErrorCode.Failed
• okCFrontPanel.ErrorCode.Timeout → ErrorCode.Timeout
• okCFrontPanel.ErrorCode.DeviceNotOpen → ErrorCode.DeviceNotOpen
• okCFrontPanel.ErrorCode.InvalidEndpoint → ErrorCode.InvalidEndpoint
• okCFrontPanel.ErrorCode.InvalidBlockSize → ErrorCode.InvalidBlockSize
• okCFrontPanel.ErrorCode.UnsupportedFeature → ErrorCode.UnsupportedFeature

Several convenience methods are removed in favor of GetDeviceInfo():

// FP5:
String serial = dev.GetSerialNumber();
okCFrontPanel.BoardModel model = dev.GetBoardModel();
int major = dev.GetDeviceMajorVersion();
int minor = dev.GetDeviceMinorVersion();
String id = dev.GetDeviceID();
boolean fast = dev.IsHighSpeed();

// FP6:
okTDeviceInfo info = new okTDeviceInfo();
dev.GetDeviceInfo(info);
// info.getSerialNumber(), info.getDeviceID(), info.getProductName(),
// info.getProductID(), info.getDeviceMajorVersion(), info.getDeviceMinorVersion(),
// info.getUsbSpeed(), info.getWireWidth()Code language: Java (java)

Other removals:

• GetErrorString() — use GetErrorMessage(ErrorCode) instead
• EnableAsynchronousTransfers() — removed, no replacement
• IsFrontPanel3Supported() — removed, no replacement
• GetHostInterfaceWidth() — use info.getWireWidth() from GetDeviceInfo()
• GetDeviceListModel() — use FrontPanelDevices (see Step 1)

1. Replace okCFrontPanel() + OpenBySerial("") with okCFrontPanelDevices().Open().
2. After ConfigureFPGA(), add okCFPGADataPortClassic classicDataPort = dev.GetFPGADataPortClassic();.
3. Find-and-replace all wire/trigger/pipe/register calls from dev. to classicDataPort..
4. Find-and-replace okCFrontPanel.ErrorCode with ErrorCode.
5. Replace removed convenience methods with GetDeviceInfo().