FailedDevice Class Reference

The FailedDevice class provides information about Leap Motion hardware that has been physically connected to the client computer, but is not operating correctly. More...

Inherits Interface.

Classes
enum	FailureType
	The errors that can cause a device to fail to properly connect to the service. More...

Public Member Functions
boolean	equals (FailedDevice arg0)
	Test FailedDevice equality. More...
FailedDevice.FailureType	failure ()
	The reason for device failure. More...
boolean	isValid ()
	Reports whether this FailedDevice object contains valid data. More...
String	pnpId ()
	The device plug-and-play id string. More...

Static Public Member Functions
static FailedDevice	invalid ()
	An invalid FailedDevice object. More...

Detailed Description

The FailedDevice class provides information about Leap Motion hardware that has been physically connected to the client computer, but is not operating correctly.

Failed devices do not provide any tracking data and do not show up in the Controller:devices() list.

Get the list of failed devices using Controller::failedDevices().

public void  onDeviceFailure (Controller controller)
{
    System.out.println ("A device was plugged in, but failed..");
    FailedDeviceList badDevices = controller.failedDevices();
    for(FailedDevice badDevice : badDevices){
        String failureReason = "";
        switch (badDevice.failure()) {
            case FAIL_CALIBRATION:
                failureReason = " has bad calibration record.";
                break;
            case FAIL_CONTROL:
                failureReason = " failed to establish USB control interfaces.";
                break;
            case FAIL_FIRMWARE:
                failureReason = " has corrupt firmware or failed to update";
                break;
            case FAIL_TRANSPORT:
                failureReason = " not responding.";
                break;
            case FAIL_UNKNOWN:
                failureReason = " failed for unknown reason.";
                break;
        }
        System.out.println("USB device with pnpID: " + badDevice.pnpId() + failureReason);
    }
}

Since

3.0

Member Function Documentation

boolean equals

(

FailedDevice

arg0

)

Test FailedDevice equality.

True if the devices are the same.

Since

3.0

FailedDevice.FailureType failure

(

)

The reason for device failure.

The failure reasons are defined as members of the FailureType enumeration:

FailureType::FAIL_UNKNOWN The cause of the error is unknown.

FailureType::FAIL_CALIBRATION The device has a bad calibration record.

FailureType::FAIL_FIRMWARE The device firmware is corrupt or failed to update.

FailureType::FAIL_TRANSPORT The device is unresponsive.

FailureType::FAIL_CONTROL The service cannot establish the required USB control interfaces.

FailureType::FAIL_COUNT Not currently used.

Since

3.0

static FailedDevice invalid ( )

static

An invalid FailedDevice object.

Since

3.0

boolean isValid

(

)

Reports whether this FailedDevice object contains valid data.

An invalid FailedDevice does not represent a physical device and can be the result of creating a new FailedDevice object with the constructor. Get FailedDevice objects from Controller::failedDevices() only.

Since

3.0

String pnpId

(

)

The device plug-and-play id string.

Since

3.0