com.datalogic.device.battery

Class DLBatteryManager

java.lang.Object

com.datalogic.device.battery.DLBatteryManager

public final class DLBatteryManager
extends java.lang.Object

The DLBatteryManager allows to read specific battery parameters. Lifetime and realtime values can be read through the BatteryStatus and manufacturer information can be read through the ManufacturerInfo. This class is also used to retrieve information and setup the current charging profile between the ones available, through the ChargingProfile.

Method Summary

Modifier and Type	Method and Description
int	addBatteryEventListener(BatteryEventListener listener) Registers a BatteryEventListener to be notified of the BatteryManager events.
BatteryStatus	getBatteryStatus() Reads the battery status.
ChargingProfile	getCurrentChargingProfile() Gets the current charging profile setup in this device.
static DLBatteryManager	getInstance() Returns an instance of the DLBatteryManager.
int	getIntProperty(BatteryInfo prop) Reads the integer value of a specific battery property.
ManufacturerInfo	getManufacturerInfo() Reads the battery manufacturer info.
java.lang.String	getStringProperty(BatteryInfo prop) Reads the String value of a specific battery property.
java.util.List<ChargingProfile>	getSupportedChargingProfiles() Gets the supported charging profiles in this device.
void	initBatteryEvents(android.content.Context context) Prepare the DlBatteryManager to receive events from the Android PowerManger Service.
int	removeBatteryEventListener(BatteryEventListener listener) Unregisters a BatteryEventListener associated with the BatteryManager.
void	setCurrentChargingProfile(ChargingProfile chargingProfile) Sets the current charging profile.

Methods inherited from class java.lang.Object

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

Method Detail

getInstance

public static DLBatteryManager getInstance()

Returns an instance of the DLBatteryManager.

Returns:

The Battery Manager.

initBatteryEvents

public void initBatteryEvents(android.content.Context context)

Prepare the DlBatteryManager to receive events from the Android PowerManger Service.
If not called the addBatteryEventListener(com.datalogic.device.battery.BatteryEventListener) fails with error BatteryException.CONTEXT_UNKNOWN.

Parameters:

context - The context of the caller.

getManufacturerInfo

public ManufacturerInfo getManufacturerInfo()

Reads the battery manufacturer info.

Returns:

A ManufacturerInfo object containing all battery manufacturer info.

getBatteryStatus

public BatteryStatus getBatteryStatus()

Reads the battery status.

Returns:

A BatteryStatus object containing all battery status.

getSupportedChargingProfiles

public java.util.List<ChargingProfile> getSupportedChargingProfiles()

Gets the supported charging profiles in this device. You can use one of the returning objects to setup the desired charging profile.

Returns:

A list of ChargingProfile objects, each representing one of the supported charging profile. The list can be empty in case no charging profile is supported in the current device.

setCurrentChargingProfile

public void setCurrentChargingProfile(ChargingProfile chargingProfile)

Sets the current charging profile. This setting is persistent to device reboots or even factory resets.

Parameters:

chargingProfile - The ChargingProfile to set.

getCurrentChargingProfile

public ChargingProfile getCurrentChargingProfile()

Gets the current charging profile setup in this device.

Returns:

The ChargingProfile currently setup in this device.

getIntProperty

public int getIntProperty(BatteryInfo prop)

Reads the integer value of a specific battery property. This value is present as one of the properties of the BatteryInfo. Call this method only with BatteryInfo related to properties of type int. For properties of type String, use getStringProperty() instead.

Parameters:

prop - The required BatteryInfo.

Returns:

int The value of the specified property, or throws an Exception in case of failure.

getStringProperty

public java.lang.String getStringProperty(BatteryInfo prop)

Reads the String value of a specific battery property. This value is present as one of the properties of the BatteryInfo. Call this method only with BatteryInfo related to properties of type String. For properties of type int, call getIntProperty() instead.

Parameters:

prop - The required BatteryInfo.

Returns:

String The value of the specified property, or throws an Exception in case of failure.

addBatteryEventListener

public int addBatteryEventListener(BatteryEventListener listener)

Registers a BatteryEventListener to be notified of the BatteryManager events.
A call to addBatteryEventListener will fail with error BatteryException.CONTEXT_UNKNOWN if initBatteryEvents(android.content.Context) has not been not previously called to register the client's context.
Call removeBatteryEventListener(com.datalogic.device.battery.BatteryEventListener) before the application closes to properly shut down the listener and avoid memory leaks.

Parameters:

listener - The BatteryEventListener that will be called to signal a BatteryEvent

Returns:

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

Throws:

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

removeBatteryEventListener

public int removeBatteryEventListener(BatteryEventListener listener)

Unregisters a BatteryEventListener associated with the BatteryManager.

Parameters:

listener - The BatteryEventListener that will be no more notified.

Returns:

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

Throws:

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