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

    Interface IFPGADataPortClassic

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

    interface IFPGADataPortClassic {
        get hostInterfaceInfo(): IFrontPanelHostInfo;
        activateTriggerIn(address: number, bit: number): Promise<void>;
        getTriggerOutVector(address: number): number;
        getWireInValue(address: number): number;
        getWireOutValue(address: number): number;
        isTriggered(address: number, mask: number): boolean;
        readFromBlockPipeOut(
            address: number,
            blockSize: number,
            buffer: DataBuffer,
        ): Promise<number>;
        readFromPipeOut(address: number, buffer: DataBuffer): Promise<number>;
        readRegister(address: number): Promise<number>;
        readRegisters(registers: IFrontPanelRegisterEntry[]): Promise<void>;
        reset(): Promise<void>;
        setWireInValue(address: number, value: number, mask: number): void;
        updateTriggerOuts(): Promise<void>;
        updateWireIns(): Promise<void>;
        updateWireOuts(): Promise<void>;
        writeRegister(address: number, value: number): Promise<void>;
        writeRegisters(registers: IFrontPanelRegisterEntry[]): Promise<void>;
        writeToBlockPipeIn(
            address: number,
            blockSize: number,
            data: DataBuffer,
        ): Promise<number>;
        writeToPipeIn(address: number, data: DataBuffer): Promise<number>;
    }
    Index

    Accessors

    hostInterfaceInfo

    Methods

    activateTriggerIn getTriggerOutVector getWireInValue getWireOutValue isTriggered readFromBlockPipeOut readFromPipeOut readRegister readRegisters reset setWireInValue updateTriggerOuts updateWireIns updateWireOuts writeRegister writeRegisters writeToBlockPipeIn writeToPipeIn

    Accessors

    Methods

    • Activates the TriggerIn at the specified address and bit.

      Parameters

      • address: number

        The address of the TriggerIn vector endpoint.

      • bit: number

        The bit of the TriggerIn vector to activate.

      Returns Promise<void>

      • A promise that resolves when the TriggerIn has been activated.

    • Gets the TriggerOut vector at the specified address.

      Parameters

      • address: number

        The address of the TriggerOut vector endpoint.

      Returns number

      • The TriggerOut vector.

    • Gets the value of a WireIn at the specified address.

      Parameters

      • address: number

        The address of the WireIn endpoint.

      Returns number

      • The value of the WireIn.

    • Gets the value of the WireOut at the specified address.

      Parameters

      • address: number

        The address of the WireOut endpoint.

      Returns number

      • The value of the WireOut.

    • Checks if the TriggerOut at the specified address and mask is active.

      Parameters

      • address: number

        The address of the TriggerOut vector endpoint.

      • mask: number

        The mask to apply to the TriggerOut vector.

      Returns boolean

      • True if the TriggerOut is active, otherwise false.

    • Reads data from the Block Throttle PipeOut at the specified address.

      Parameters

      • address: number

        The address of the PipeOut endpoint.

      • blockSize: number

        The size of the blocks to read in bytes.

      • buffer: DataBuffer

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

      Returns Promise<number>

      • A promise that resolves when the data has been read indicating the number of bytes that were successfully read.

    • Reads data from the PipeOut at the specified address.

      Parameters

      • address: number

        The address of the PipeOut endpoint.

      • buffer: DataBuffer

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

      Returns Promise<number>

      • A promise that resolves when the data has been read indicating the number of bytes that were successfully read.

    • Reads the value of the Register at the specified address.

      Parameters

      • address: number

        The address of the Register.

      Returns Promise<number>

      • A promise that resolves to the value of the Register.

    • Reads the data of the Registers at the specified addresses and stores the data in the corresponding array element.

      Parameters

      Returns Promise<void>

      • A promise that resolves when all the registers have been read.

    • Sends RESET signal to the gateware via the okHostInterface.

      Returns Promise<void>

    • Sets the value of the WireIn at the specified address.

      Parameters

      • address: number

        The address of the WireIn endpoint.

      • value: number

        The value to set.

      • mask: number

        The mask to apply to the value.

      Returns void

    • Retrieves the current TriggerOut vectors from the FPGA.

      Returns Promise<void>

      • A promise that resolves when all TriggerOuts have been updated.

    • Transfers current WireIn values to the FPGA.

      Returns Promise<void>

      • A promise that resolves when all WireIns have been transferred.

    • Retrieves current WireOut values from the FPGA.

      Returns Promise<void>

      • A promise that resolves when all WireOuts have been updated.

    • Writes a value to the Register at the specified address.

      Parameters

      • address: number

        The address of the Register.

      • value: number

        The value to write.

      Returns Promise<void>

      • A promise that resolves when the value has been written.

    • Writes data to each of the Registers at the specified addresses.

      Parameters

      Returns Promise<void>

      • A promise that resolves when the register values have been written.

    • Writes data to the Block Throttle PipeIn at the specified address.

      Parameters

      • address: number

        The address of the PipeIn endpoint.

      • blockSize: number

        The size of the blocks to write in bytes.

      • data: DataBuffer

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

      Returns Promise<number>

      • A promise that resolves when the data has been written indicating the number of bytes that were successfully written.

    • Writes data to the PipeIn at the specified address.

      Parameters

      • address: number

        The address of the PipeIn endpoint.

      • data: DataBuffer

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

      Returns Promise<number>

      • A promise that resolves when the data has been written indicating the number of bytes that were successfully written.

    Settings

    Member Visibility

    On This Page

    Accessors
    Methods