Interface IDevice

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

interface IDevice {
    close(): boolean;
    getFPGA(): IDeviceFPGA;
    getInfo(): Promise<IDeviceInfo>;
    isOpen(): Promise<boolean>;
}

Methods

close

  • close(): boolean

  • Closes the Device.

    Returns boolean

    • True if the Device was successfully closed, otherwise false.

getFPGA

  • getFPGA(): IDeviceFPGA

  • The FPGA interface for the device.

    Returns IDeviceFPGA

    • The FPGA interface for the Device.

getInfo

  • getInfo(): Promise<IDeviceInfo>

  • Retrieves the device information.

    Returns Promise<IDeviceInfo>

    • Promise that resolves to a Device information interface.

isOpen

  • isOpen(): Promise<boolean>

  • Determines if the Device is currently open.

    Returns Promise<boolean>

    • Promise that resolves to true if the Device is open, otherwise false.

Settings

Member Visibility

Theme

On This Page

closegetFPGAgetInfoisOpen

Generated using TypeDoc