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

    Interface IDevice

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

    interface IDevice {
        close(): boolean;
        getDeviceInfo(): Promise<IDeviceInfo>;
        getDeviceSensors(): Promise<DeviceSensorList | undefined>;
        getDeviceSettings(): Promise<IDeviceSettings | undefined>;
        getFPGAConfiguration(): IFPGAConfiguration;
        getFPGADataPortAXI(): Promise<IFPGADataPortAXI>;
        getFPGADataPortClassic(): Promise<IFPGADataPortClassic>;
        getI2C(): IDeviceI2C | undefined;
        getPLL(): IPLL22150 | IPLL22393 | undefined;
        getSystemFlash(): IFlashMemory | undefined;
        isFrontPanelEnabled(): Promise<boolean>;
        isOpen(): Promise<boolean>;
        setDeviceID(deviceID: string): Promise<void>;
    }
    Index

    Methods

    close getDeviceInfo getDeviceSensors getDeviceSettings getFPGAConfiguration getFPGADataPortAXI getFPGADataPortClassic getI2C getPLL getSystemFlash isFrontPanelEnabled isOpen setDeviceID

    Methods

    • Closes the Device.

      Returns boolean

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

    • Retrieves the Information interface for the Device.

      Returns Promise<IDeviceInfo>

      • Promise that resolves to a Device Information interface.

    • Retrieves the list of Sensor interfaces for the Device.

      Returns Promise<DeviceSensorList | undefined>

      • Promise that resolves to a list of Sensor interfaces if the Device supports sensors, otherwise undefined.

    • Retrieves the Settings interface for the Device.

      Returns Promise<IDeviceSettings | undefined>

      • Promise that resolves to a Device Settings interface if the Device supports settings, otherwise undefined.

    • Retrieves the FPGA dataport AXI interface for the Device.

      Returns Promise<IFPGADataPortAXI>

      • Promise that resolves to the FPGA dataport axi interface for the Device if it is supported.

    • Retrieves the FPGA dataport classic interface for the Device.

      Returns Promise<IFPGADataPortClassic>

      • Promise that resolves to the FPGA dataport classic interface for the Device if it is supported.

    • Retrieves the I2C interface for the Device.

      Returns IDeviceI2C | undefined

      • The I2C interface for the Device if the Device supports I2C, otherwise undefined.

    • Retrieves the PLL interface for the Device.

      Returns IPLL22150 | IPLL22393 | undefined

      • The PLL interface for the Device if the Device supports PLL, otherwise undefined.

    • Retrieves the System Flash interface for the Device.

      Returns IFlashMemory | undefined

      • The System Flash interface for the Device if the Device supports System Flash, otherwise undefined.

    • Determines if the FrontPanel Host Interface is present in the current FPGA configuration.

      Returns Promise<boolean>

      • Promise that resolves to true if FrontPanel is enabled, otherwise false.

    • Determines if the Device is currently open.

      Returns Promise<boolean>

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

    • Sets the ID of the device in EEPROM.

      Parameters

      • deviceID: string

        The new ID to store.

      Returns Promise<void>

      • Promise that resolves when the ID has been successfully set.

    Settings

    Member Visibility

    On This Page

    Methods