Interface IFPGADataPortAXIStream

Interface that provides the methods that may be used to interact with a FrontPanel device using AXI-Stream.

interface IFPGADataPortAXIStream {
    get readDatapathWidthByteCount(): number;
    get writeDatapathWidthByteCount(): number;
    read(buffer: DataBuffer): Promise<number>;
    read(buffer: DataBuffer, timeoutMilliseconds: number): Promise<number>;
    reset(): Promise<void>;
    write(data: DataBuffer): Promise<number>;
    write(data: DataBuffer, timeoutMilliseconds: number): Promise<number>;
}

Index

Accessors

readDatapathWidthByteCount writeDatapathWidthByteCount

Methods

read reset write

Accessors

readDatapathWidthByteCount

get readDatapathWidthByteCount(): number
Returns number

writeDatapathWidthByteCount

get writeDatapathWidthByteCount(): number
Returns number

Methods

read

read(buffer: DataBuffer): Promise<number>
Reads data with default timeout (10000ms).
Parameters
- buffer: DataBuffer
  The buffer to store the data that is read. The buffer must not be modified or detached until the returned Promise settles.
Returns Promise<number>
read(buffer: DataBuffer, timeoutMilliseconds: number): Promise<number>
Reads data with explicit timeout.
Parameters
- buffer: DataBuffer
  The buffer to store the data that is read.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<number>

reset

reset(): Promise<void>
Resets the AXI-Stream interface.

Returns Promise<void>

write

write(data: DataBuffer): Promise<number>
Writes data with default timeout (10000ms).
Parameters
- data: DataBuffer
  The data to write. The buffer must not be modified or detached until the returned Promise settles.
Returns Promise<number>
write(data: DataBuffer, timeoutMilliseconds: number): Promise<number>
Writes data with explicit timeout.
Parameters
- data: DataBuffer
  The data to write.
- timeoutMilliseconds: number
  The timeout period in milliseconds.
Returns Promise<number>