Power API Tutorial

Introduction

Power API methods can be used by constructing an instance of [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHWRMPower and calling its functions. However, to use its full functionality write a class which implements one or more of the observer interfaces described in the following table. Then, construct an instance of [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHWRMPower and provide it with pointers to observers.

For example, if the application requires periodic measurements of average battery voltage and current consumption, it must implement [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]MHWRMBatteryPowerObserver and instantiate a [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHWRMPower object using the [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHWRMPower::NewL(NULL, MHWRMBatteryPowerObserver *) method.

Note: The battery charging observers cannot be passed to [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHWRMPower using a [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]NewL() function. Call the dedicated function, [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHRMPower::SetBatteryChargingObserver().

Procedure

1. Derive a class and implement the appropriate observer functions.

2. Create a power client using [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHWRMPower::NewL() or [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]NewLC().

   You can retrieve the battery voltage or consumption information.

3. Call [[[ERROR: [NOKX000E] Unable to find definition for key reference 'CHWRMPower']]]CHRMPower::SetBatteryChargingObserver(), if necessary.

4. Start receiving notification using the appropriate start function(s).

5. Stop receiving notification using the appropriate stop function(s).

Note: If the notification period exceeds the maximum reporting period, set when the HWRM server starts, notification is cancelled.