FrontPanel Platform API - v6.0.0
    Preparing search index...

    Interface IFPGAConfiguration

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

    interface IFPGAConfiguration {
        clearConfiguration(): Promise<void>;
        getInfo(): Promise<IDeviceFPGAInfo>;
        getResetProfile(
            method: ConfigurationMethod,
        ): Promise<IFrontPanelResetProfile>;
        loadConfigurationFromFile(
            filename: string,
            progressCallback?: DataProgressCallback,
        ): Promise<void>;
        loadConfigurationFromFileWithReset(
            filename: string,
            resetProfile: IFrontPanelResetProfile,
            progressCallback?: DataProgressCallback,
        ): Promise<void>;
        loadConfigurationFromMemory(
            data: DataBuffer,
            progressCallback?: DataProgressCallback,
        ): Promise<void>;
        loadConfigurationFromMemoryWithReset(
            data: DataBuffer,
            resetProfile: IFrontPanelResetProfile,
            progressCallback?: DataProgressCallback,
        ): Promise<void>;
        setResetProfile(
            method: ConfigurationMethod,
            resetProfile: IFrontPanelResetProfile,
        ): Promise<void>;
    }
    Index

    Methods

    clearConfiguration getInfo getResetProfile loadConfigurationFromFile loadConfigurationFromFileWithReset loadConfigurationFromMemory loadConfigurationFromMemoryWithReset setResetProfile

    Methods

    • Clears the FPGA configuration.

      Returns Promise<void>

      • A promise that resolves when the configuration has been cleared.

    • Retrieves the FPGA information.

      Returns Promise<IDeviceFPGAInfo>

      • Promise that resolves to a Device FPGA information interface.

    • Configures the FPGA with the specified data in file.

      Parameters

      • filename: string

        The full path to the file containing the configuration data.

      • OptionalprogressCallback: DataProgressCallback

        Optional callback that reports the progress of the configuration.

      Returns Promise<void>

      • A promise that resolves when the configuration is complete.

    • Configures the FPGA with the specified data in file and a reset profile.

      Parameters

      • filename: string

        The full path to the file containing the configuration data.

      • resetProfile: IFrontPanelResetProfile

        Reset Profile to perform after configuration.

      • OptionalprogressCallback: DataProgressCallback

        Optional callback that reports the progress of the configuration.

      Returns Promise<void>

      • A promise that resolves when the configuration is complete.

    • Configures the FPGA with the specified data in memory.

      Parameters

      • data: DataBuffer

        The configuration data. The transfer length is determined by the buffer's byte length. The buffer must not be modified or detached until the returned Promise settles.

      • OptionalprogressCallback: DataProgressCallback

        Optional callback that reports the progress of the configuration.

      Returns Promise<void>

      • A promise that resolves when the configuration is complete.

    • Configures the FPGA with the specified data in memory and a reset profile.

      Parameters

      • data: DataBuffer

        The configuration data. The transfer length is determined by the buffer's byte length. The buffer must not be modified or detached until the returned Promise settles.

      • resetProfile: IFrontPanelResetProfile

        Reset Profile to perform after configuration.

      • OptionalprogressCallback: DataProgressCallback

        Optional callback that reports the progress of the configuration.

      Returns Promise<void>

      • A promise that resolves when the configuration is complete.

    Settings

    Member Visibility

    On This Page

    Methods