UsbDevice.java

/*******************************************************************************
 * Copyright (c) 2011, 2016 Eurotech and/or its affiliates
 *
 * All rights reserved. This program and the accompanying materials
 * are made available under the terms of the Eclipse Public License v1.0
 * which accompanies this distribution, and is available at
 * http://www.eclipse.org/legal/epl-v10.html
 *
 * Contributors:
 *     Eurotech
 *******************************************************************************/
package org.eclipse.kura.usb;

/**
 * Interface for all USB devices
 */
public interface UsbDevice {

    /**
     * The vendor ID of the device
     *
     * @return The vendor ID of the device
     */
    public String getVendorId();

    /**
     * The product ID of the device
     *
     * @return The product ID of the device
     */
    public String getProductId();

    /**
     * The manufacturer name of the device
     *
     * @return The manufacturer name of the device
     */
    public String getManufacturerName();

    /**
     * The product name of the device
     *
     * @return The product name of the device
     */
    public String getProductName();

    /**
     * The USB bus number of the device
     *
     * @return The USB bus number of the device
     */
    public String getUsbBusNumber();

    /**
     * The USB device path
     *
     * @return The USB device path
     */
    public String getUsbDevicePath();

    /**
     * The complete USB port (USB bus number plus USB device path)
     *
     * @return The complete USB port (USB bus number plus USB device path)
     */
    public String getUsbPort();

}