com.embeddedunveiled.serial.usb

Class SerialComUSBPowerInfo

java.lang.Object

com.embeddedunveiled.serial.usb.SerialComUSBPowerInfo

public final class SerialComUSBPowerInfo
extends Object

Encapsulates various power related information about a USB device.

Author:

Rishi Gupta

Constructor Summary

Constructors

Constructor and Description
SerialComUSBPowerInfo(String autoSuspendDelay, String currentControlConfig, String currentRuntimeStatus, String isSelectiveSuspendSupported, String isSelectiveSuspendEnabled, String selectiveSuspendTimeoutValue) Construct and allocates a new SerialComUSBPowerInfo object with the given details.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDevicePowerInfo() Prints information about power management of this USB device on console.
String	getAutoSuspendDelay() Retrieves time after which this USB device will be allowed to auto suspend if idle.
String	getCurrentControlConfig() Retrieves value indicating whether this USB device will be prevented from auto suspending or is allowed to auto suspend.
String	getCurrentRuntimeStatus() Retrieves value indicating whether this USB device is active or auto suspended.
int	getSelectiveSuspendTimeout() Gives current selective suspend timeout value for this device.
Boolean	isSelectiveSuspendEnabled() Tells whether selective suspend is enabled or not.
Boolean	isSelectiveSuspendSupported() Tells whether device support selective suspend or not.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

SerialComUSBPowerInfo

public SerialComUSBPowerInfo(String autoSuspendDelay,
                     String currentControlConfig,
                     String currentRuntimeStatus,
                     String isSelectiveSuspendSupported,
                     String isSelectiveSuspendEnabled,
                     String selectiveSuspendTimeoutValue)

Construct and allocates a new SerialComUSBPowerInfo object with the given details.

Parameters:

autoSuspendDelay - delay in milliseconds before USB device is suspended after inactivity.

currentControlConfig - value indicating whether device is to be kept on always or is allowed to suspend.

currentRuntimeStatus - current power status (on or suspended) of this USB device.

isSelectiveSuspendSupported - string indicating window's selective suspend supported or not.

isSelectiveSuspendEnabled - string indicating window's selective suspend is enabled or not.

selectiveSuspendTimeoutValue - string indicating window's selective suspend timeout value.

Method Detail

getAutoSuspendDelay

public String getAutoSuspendDelay()

Retrieves time after which this USB device will be allowed to auto suspend if idle.

Returns:

time in milliseconds as string.

getCurrentControlConfig

public String getCurrentControlConfig()

Retrieves value indicating whether this USB device will be prevented from auto suspending or is allowed to auto suspend.

Returns:

current control setting string.

getCurrentRuntimeStatus

public String getCurrentRuntimeStatus()

Retrieves value indicating whether this USB device is active or auto suspended.

Returns:

current power status string.

isSelectiveSuspendSupported

public Boolean isSelectiveSuspendSupported()

Tells whether device support selective suspend or not.

Returns:

true if selective suspend supported otherwise false.

isSelectiveSuspendEnabled

public Boolean isSelectiveSuspendEnabled()

Tells whether selective suspend is enabled or not.

Returns:

true if selective suspend is enabled otherwise false.

getSelectiveSuspendTimeout

public int getSelectiveSuspendTimeout()

Gives current selective suspend timeout value for this device.

Returns:

timeout value.

Throws:

NumberFormatException - if the timeout value hex string can not be converted into numerical representation.

dumpDevicePowerInfo

public void dumpDevicePowerInfo()

Prints information about power management of this USB device on console.