Interface IFrontPanel

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

interface IFrontPanel {
    activateTriggerIn(address, bit): Promise<void>;
    getTriggerOutVector(address): number;
    getWireInValue(address): number;
    getWireOutValue(address): number;
    isTriggered(address, mask): boolean;
    readFromBlockPipeOut(address, blockSize, length, buffer): Promise<number>;
    readFromPipeOut(address, length, buffer): Promise<number>;
    readRegister(address): Promise<number>;
    readRegisters(registers): Promise<void>;
    setWireInValue(address, value, mask): void;
    updateTriggerOuts(): Promise<void>;
    updateWireIns(): Promise<void>;
    updateWireOuts(): Promise<void>;
    writeRegister(address, value): Promise<void>;
    writeRegisters(registers): Promise<void>;
    writeToBlockPipeIn(address, blockSize, length, data): Promise<number>;
    writeToPipeIn(address, length, data): Promise<number>;
}

Implemented by

Methods

activateTriggerIn

  • activateTriggerIn(address, bit): Promise<void>

  • 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.

getTriggerOutVector

  • getTriggerOutVector(address): number

  • Gets the TriggerOut vector at the specified address.

    Parameters

    • address: number

      The address of the TriggerOut vector endpoint.

    Returns number

    • The TriggerOut vector.

getWireInValue

  • getWireInValue(address): number

  • 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.

getWireOutValue

  • getWireOutValue(address): number

  • 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.

isTriggered

  • isTriggered(address, mask): boolean

  • 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.

readFromBlockPipeOut

  • readFromBlockPipeOut(address, blockSize, length, buffer): Promise<number>

  • 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.

    • length: number

      The length of the data to read in bytes.

    • buffer: ArrayBuffer

      The buffer to store the data that is read.

    Returns Promise<number>

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

readFromPipeOut

  • readFromPipeOut(address, length, buffer): Promise<number>

  • Reads data from the PipeOut at the specified address.

    Parameters

    • address: number

      The address of the PipeOut endpoint.

    • length: number

      The length of the data to read in bytes.

    • buffer: ArrayBuffer

      The buffer to store the data that is read.

    Returns Promise<number>

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

readRegister

  • readRegister(address): Promise<number>

  • 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.

readRegisters

  • readRegisters(registers): Promise<void>

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

    Parameters

    • registers: {
          address: number;
          data: number;
      }[]

      The array containing address and data pairs for each register.

    Returns Promise<void>

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

setWireInValue

  • setWireInValue(address, value, mask): 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

updateTriggerOuts

  • updateTriggerOuts(): Promise<void>

  • Retrieves the current TriggerOut vectors from the FPGA.

    Returns Promise<void>

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

updateWireIns

  • updateWireIns(): Promise<void>

  • Transfers current WireIn values to the FPGA.

    Returns Promise<void>

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

updateWireOuts

  • updateWireOuts(): Promise<void>

  • Retrieves current WireOut values from the FPGA.

    Returns Promise<void>

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

writeRegister

  • writeRegister(address, value): Promise<void>

  • 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.

writeRegisters

  • writeRegisters(registers): Promise<void>

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

    Parameters

    • registers: {
          address: number;
          data: number;
      }[]

      The array containing address and data pairs for each register.

    Returns Promise<void>

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

writeToBlockPipeIn

  • writeToBlockPipeIn(address, blockSize, length, data): Promise<number>

  • 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.

    • length: number

      The length of the data to write in bytes.

    • data: ArrayBuffer

      The buffer containing the data to write.

    Returns Promise<number>

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

writeToPipeIn

  • writeToPipeIn(address, length, data): Promise<number>

  • Writes data to the PipeIn at the specified address.

    Parameters

    • address: number

      The address of the PipeIn endpoint.

    • length: number

      The length of the data to write in bytes.

    • data: ArrayBuffer

      The buffer containing the data to write.

    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

Theme

On This Page

activateTriggerIngetTriggerOutVectorgetWireInValuegetWireOutValueisTriggeredreadFromBlockPipeOutreadFromPipeOutreadRegisterreadRegisterssetWireInValueupdateTriggerOutsupdateWireInsupdateWireOutswriteRegisterwriteRegisterswriteToBlockPipeInwriteToPipeIn

Generated using TypeDoc