FrontPanel SDK
Support Matrix
The table below lists all of the API classes and their support status in the latest revision of the FrontPanel SDK (5.3.0). Previous versions may have reduced support.
- USB 2.0 – Indicates that the listed API is supported by USB 2.0 devices such as the XEM7001 and XEM7010.
- USB 3.0 – Indicates that the listed API is supported by USB 3.0 devices such as the XEM7310 and XEM8350.
- FPoIP / WebAPI – Indicates that the listed API is supported by FPoIP. Note that the underlying device support is also relevant to this.
| Class | Method | USB 2.0 | USB 3.0 | FPoIP / Webapi |
|---|---|---|---|---|
| okCFrontPanelDevices | okCFrontPanelDevices | Yes | Yes | Yes |
| okCFrontPanelDevices | GetCount | Yes | Yes | X |
| okCFrontPanelDevices | GetSerial | Yes | Yes | X |
| okCFrontPanelDevices | Open | Yes | Yes | Yes |
| okCDeviceSettings | okCDeviceSettings | X | Yes | Yes |
| okCDeviceSettings | GetString | X | Yes | Yes |
| okCDeviceSettings | GetInt | X | Yes | Yes |
| okCDeviceSettings | SetString | X | Yes | Yes |
| okCDeviceSettings | SetInt | X | Yes | Yes |
| okCDeviceSettings | List | X | Yes | Yes |
| okCDeviceSettings | Delete | X | Yes | Yes |
| okCDeviceSettings | Save | X | Yes | Yes |
| okCDeviceSensors | okCDeviceSensors | X | Yes | Yes |
| okCDeviceSensors | GetSensorCount | X | Yes | X |
| okCDeviceSensors | GetSensor | X | Yes | X |
| okCFrontPanel | okCFrontPanel | Yes | Yes | Yes |
| okCFrontPanel | ActivateTriggerIn | Yes | Yes | Yes |
| okCFrontPanel | Close | Yes | Yes | Yes |
| okCFrontPanel | ClearFPGAConfiguration | Yes | Yes | Yes |
| okCFrontPanel | ConfigureFPGA | Yes | Yes | Yes |
| okCFrontPanel | ConfigureFPGAWithReset | X | Yes | Yes |
| okCFrontPanel | ConfigureFPGAFromMemory | Yes | Yes | Yes |
| okCFrontPanel | ConfigureFPGAFromMemoryWithReset | X | Yes | Yes |
| okCFrontPanel | ConfigureFPGAFromFlash | X | Yes | Yes |
| okCFrontPanel | EnableAsynchronousTransfers | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | X |
| okCFrontPanel | GetBoardModel | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | X |
| okCFrontPanel | GetDeviceCount | Deprecated | Deprecated | – |
| okCFrontPanel | GetDeviceID | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) |
| okCFrontPanel | GetDeviceInfo | Yes | Yes | Yes |
| okCFrontPanel | GetFPGAResetProfile | X | X | Yes |
| okCFrontPanel | GetDeviceListModel | Deprecated | Deprecated | – |
| okCFrontPanel | GetDeviceListSerial | Deprecated | Deprecated | – |
| okCFrontPanel | GetDeviceMajorVersion | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) |
| okCFrontPanel | GetDeviceMinorVersion | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) |
| okCFrontPanel | GetDeviceSensors | X | Yes | Yes |
| okCFrontPanel | GetDeviceSettings | X | Yes | Yes |
| okCFrontPanel | GetEepromPLL22150Configuration | Yes | X | Yes |
| okCFrontPanel | GetEepromPLL22393Configuration | Yes | X | X |
| okCFrontPanel | GetHostInterfaceWidth | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) |
| okCFrontPanel | GetLastTransferLength | Yes | Yes | Yes |
| okCFrontPanel | GetPLL22150Configuration | Yes | X | Yes |
| okCFrontPanel | GetPLL22393Configuration | Yes | X | X |
| okCFrontPanel | GetSerialNumber | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) | Deprecated (as of 5.3.0) |
| okCFrontPanel | GetWireInValue | Yes | Yes | Yes |
| okCFrontPanel | GetWireOutValue | Yes | Yes | Yes |
| okCFrontPanel | IsHighSpeed | Deprecated | – | – |
| okCFrontPanel | IsFrontPanel3Supported | Deprecated | Deprecated | – |
| okCFrontPanel | IsFrontPanelEnabled | Yes | Yes | Yes |
| okCFrontPanel | IsOpen | Yes | Yes | X |
| okCFrontPanel | IsRemote | Yes | Yes | X |
| okCFrontPanel | IsTriggered | Yes | Yes | Yes |
| okCFrontPanel | GetTriggerOutVector | Yes | Yes | Yes |
| okCFrontPanel | LoadDefaultPLLConfiguration | Yes | X | Yes |
| okCFrontPanel | OpenBySerial | Deprecated | Deprecated | – |
| okCFrontPanel | ReadI2C | Yes | X | Yes |
| okCFrontPanel | ReadFromBlockPipeOut | Yes | Yes | Yes |
| okCFrontPanel | ReadFromPipeOut | Yes | Yes | Yes |
| okCFrontPanel | ReadRegister | X | Yes | X |
| okCFrontPanel | ReadRegisters | X | Yes | Yes |
| okCFrontPanel | ResetFPGA | Yes | X | Yes |
| okCFrontPanel | SetBTPipePollingInterval | Yes | Yes | Yes |
| okCFrontPanel | SetFPGAResetProfile | X | Yes | Yes |
| okCFrontPanel | SetDeviceID | Yes | Yes | Yes |
| okCFrontPanel | SetPLL22150Configuration | Yes | X | Yes |
| okCFrontPanel | SetPLL22393Configuration | Yes | X | X |
| okCFrontPanel | SetEepromPLL22150Configuration | Yes | X | Yes |
| okCFrontPanel | SetEepromPLL22393Configuration | Yes | X | X |
| okCFrontPanel | SetTimeout | Yes | Yes | Yes |
| okCFrontPanel | SetWireInValue | Yes | Yes | Yes |
| okCFrontPanel | UpdateTriggerOuts | Yes | Yes | Yes |
| okCFrontPanel | UpdateWireIns | Yes | Yes | Yes |
| okCFrontPanel | UpdateWireOuts | Yes | Yes | Yes |
| okCFrontPanel | FlashEraseSector | X | Yes | Yes |
| okCFrontPanel | FlashWrite | X | Yes | Yes |
| okCFrontPanel | FlashRead | X | Yes | Yes |
| okCFrontPanel | WriteI2C | Yes | X | Yes |
| okCFrontPanel | WriteRegister | X | Yes | X |
| okCFrontPanel | WriteRegisters | X | Yes | Yes |
| okCFrontPanel | WriteToBlockPipeIn | Yes | Yes | Yes |
| okCFrontPanel | WriteToPipeIn | Yes | Yes | Yes |