@opalkelly/frontpanel-platform-api/src/core/IDeviceInfo.ts

TypeScript definitions for Opal Kelly FrontPanel Platform API

/**
 * Copyright (c) 2024 Opal Kelly Incorporated
 *
 * This source code is licensed under the FrontPanel license.
 * See the LICENSE file found in the root directory of this project.
 */

import DeviceInterfaceType from "./DeviceInterfaceType";
import DeviceUsbInterfaceInfo from "./DeviceUsbInterfaceInfo";

/**
 * Interface that provides information about the device.
 */
interface IDeviceInfo {

    /**
     * The device ID of the device.
     */
    get deviceID(): string;

    /**
     * The serial number of the device.
     */
    get serialNumber(): string;

    /**
     * The product ID of the device.
     */
    get productID(): number;

    /**
     * The product name of the device.
     */
    get productName(): string;

    /**
     * The interface type supported by the device.
     */
    get interfaceType(): DeviceInterfaceType;

    /**
     * The information detailing the interface of the device.
     */
    get interfaceInfo(): DeviceUsbInterfaceInfo | undefined;
}

export default IDeviceInfo;