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<undefined | DeviceSensorList>;
    getDeviceSettings(): Promise<undefined | IDeviceSettings>;
    getFPGAConfiguration(): IFPGAConfiguration;
    getFPGADataPortClassic(): Promise<IFPGADataPortClassic>;
    getI2C(): undefined | IDeviceI2C;
    getPLL(): undefined | IPLL22150 | IPLL22393;
    getSystemFlash(): undefined | IFlashMemory;
    isOpen(): Promise<boolean>;
    setDeviceID(deviceID): Promise<void>;
}

Index

Methods

close getDeviceInfo getDeviceSensors getDeviceSettings getFPGAConfiguration getFPGADataPortClassic getI2C getPLL getSystemFlash isOpen setDeviceID

Methods

close

close(): boolean
Closes the Device.

Returns boolean
- True if the Device was successfully closed, otherwise false.

getDeviceInfo

getDeviceInfo(): Promise<IDeviceInfo>
Retrieves the Information interface for the Device.

Returns Promise<IDeviceInfo>
- Promise that resolves to a Device Information interface.

getDeviceSensors

getDeviceSensors(): Promise<undefined | DeviceSensorList>
Retrieves the list of Sensor interfaces for the Device.

Returns Promise<undefined | DeviceSensorList>
- Promise that resolves to a list of Sensor interfaces if the Device supports sensors, otherwise undefined.

getDeviceSettings

getDeviceSettings(): Promise<undefined | IDeviceSettings>
Retrieves the Settings interface for the Device.

Returns Promise<undefined | IDeviceSettings>
- Promise that resolves to a Device Settings interface if the Device supports settings, otherwise undefined.

getFPGAConfiguration

getFPGAConfiguration(): IFPGAConfiguration
Retrieves the FPGA configuration interface for the Device.

Returns IFPGAConfiguration
- The FPGA configuration interface for the Device.

getFPGADataPortClassic

getFPGADataPortClassic(): Promise<IFPGADataPortClassic>
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.

getI2C

getI2C(): undefined | IDeviceI2C
Retrieves the I2C interface for the Device.

Returns undefined | IDeviceI2C
- The I2C interface for the Device if the Device supports I2C, otherwise undefined.

getPLL

getPLL(): undefined | IPLL22150 | IPLL22393
Retrieves the PLL interface for the Device.

Returns undefined | IPLL22150 | IPLL22393
- The PLL interface for the Device if the Device supports PLL, otherwise undefined.

getSystemFlash

getSystemFlash(): undefined | IFlashMemory
Retrieves the System Flash interface for the Device.

Returns undefined | IFlashMemory
- The System Flash interface for the Device if the Device supports System Flash, otherwise undefined.

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.

setDeviceID

setDeviceID(deviceID): Promise<void>
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.