Interface IDeviceFPGA

Interface that provides the methods that may be used to interact with the FPGA on a device.

interface IDeviceFPGA {
    clearConfiguration(): Promise<void>;
    getFrontPanel(): Promise<IFrontPanel>;
    loadConfiguration(data, length, progressCallback?): Promise<void>;
}

Index

Methods

clearConfiguration

clearConfiguration(): Promise<void>
Clears the FPGA configuration.

Returns Promise<void>
- A promise that resolves when the configuration has been cleared.

getFrontPanel

getFrontPanel(): Promise<IFrontPanel>
Gets the FrontPanel interface if the device is configured.

Returns Promise<IFrontPanel>
- A promise that resolves to a FrontPanel interface if the FPGA is configured with the host gateware, otherwise null.

loadConfiguration

loadConfiguration(data, length, progressCallback?): Promise<void>
Configures the FPGA with the specified data.
Parameters
- data: ArrayBuffer
  The buffer containing the configuration data.
- length: number
  The length of the configuration data in bytes.
- Optional progressCallback: DataProgressCallback
  Optional callback that reports the progress of the configuration.
Returns Promise<void>
- A promise that resolves when the configuration is complete.

Generated using TypeDoc