com.datalogic.device.power

Class PowerManager

java.lang.Object

com.datalogic.device.power.PowerManager

public class PowerManager
extends java.lang.Object

This class provides access to battery life related methods of the device.

Constructor Summary

Constructors

Constructor and Description
PowerManager() This is the constructor of PowerManager.

Method Summary

Modifier and Type	Method and Description
int	activateWakeup(WakeupSource source) This function allows setting a wakeup source.
int	clearWakeup(WakeupSource source) This function allows clearing a wakeup source from those previously set.
RebootReason	getRebootReason() This function allows to know the reason of last device power-off.
SuspendTimeout	getSuspendTimeout(boolean externalPower) This function allows to get the device screen off timeout before automatic suspension.
WakeupSource	getWakeupReason() This function allows to know the source of the last wakeup.
boolean	isWakeupActive(WakeupSource source) This function allows to know if a wakeup source is currently active.
boolean	isWakeupSupported(WakeupSource source) This function allows to know if a wakeup source is configurable on a target device.
int	reboot(BootType resetType) Reset the device.
int	setSuspendTimeout(SuspendTimeout timeout, boolean externalPower) This function allows to set the device timeout before automatic suspension.

Methods inherited from class java.lang.Object

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

Constructor Detail

PowerManager

public PowerManager()

This is the constructor of PowerManager.

Throws:

DeviceException - in case of error.

Method Detail

setSuspendTimeout

public int setSuspendTimeout(SuspendTimeout timeout,
                             boolean externalPower)

This function allows to set the device timeout before automatic suspension.

Parameters:

timeout - The SuspendTimeout value of the timeout.

externalPower - The boolean value indicating if the timeout is meant for external AC power or for internal battery.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

getSuspendTimeout

public SuspendTimeout getSuspendTimeout(boolean externalPower)

This function allows to get the device screen off timeout before automatic suspension.

Parameters:

externalPower - The boolean value indicating if the requested timeout is the one running while powered externally or while the only power source is the internal battery.

Returns:

The SuspendTimeout representing the active timeout.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

reboot

public int reboot(BootType resetType)

Reset the device. The device will be turned off, then turned on.

Parameters:

resetType - The BootType type of reboot to perform.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

BootType

activateWakeup

public int activateWakeup(WakeupSource source)

This function allows setting a wakeup source. If the source is already set, no action is performed.

Parameters:

source - The WakeupSource that should activate the device from sleep and needs to be enabled.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

WakeupSource

clearWakeup

public int clearWakeup(WakeupSource source)

This function allows clearing a wakeup source from those previously set. If the source was not set, no action is performed.

Parameters:

source - The WakeupSource that should no longer wake up the device anymore.

Returns:

int DeviceException.SUCCESS in case of success, otherwise a possible error code, matching one of the DeviceException error constants.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

WakeupSource

isWakeupActive

public boolean isWakeupActive(WakeupSource source)

This function allows to know if a wakeup source is currently active.

Parameters:

source - The WakeupSource that should be checked, whether is currently active or not.

Returns:

boolean true if the source is active, false otherwise.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

WakeupSource

isWakeupSupported

public boolean isWakeupSupported(WakeupSource source)

This function allows to know if a wakeup source is configurable on a target device.

Parameters:

source - The WakeupSource that should be checked, whether is supported or not.

Returns:

boolean true if the source can be enabled or disabled, false otherwise.

See Also:

WakeupSource

getWakeupReason

public WakeupSource getWakeupReason()

This function allows to know the source of the last wakeup.

Returns:

The value of the last wakeup source as a WakeupSource, null in case no wake up source woke up the device.

Throws:

DeviceException - in case of error, when exceptions are enabled through the ErrorManager singleton.

See Also:

WakeupSource

getRebootReason

public RebootReason getRebootReason()

This function allows to know the reason of last device power-off.

Returns:

The RebootReason related to the reason of last device power-off event.