QtMobility Reference Documentation

Contents

QSystemBatteryInfo Class Reference

The QSystemBatteryInfo class provides access to battery and power information from the system. More...

 #include <QSystemBatteryInfo>

Inherits QObject.

This class was introduced in Qt Mobility 1.2.

Public Types

enum BatteryStatus { BatteryUnknown, BatteryEmpty, BatteryCritical, BatteryVeryLow, ..., BatteryFull }
enum ChargerType { UnknownCharger, NoCharger, WallCharger, USBCharger, ..., VariableCurrentCharger }
enum ChargingState { NotCharging, Charging, ChargingError }
enum EnergyUnit { UnitUnknown, UnitmAh, UnitmWh }

Properties

Public Functions

QSystemBatteryInfo ( QObject * parent = 0 )
~QSystemBatteryInfo ()
QSystemBatteryInfo::BatteryStatus batteryStatus () const
QSystemBatteryInfo::ChargerType chargerType () const
QSystemBatteryInfo::ChargingState chargingState () const
int currentFlow () const
QSystemBatteryInfo::EnergyUnit energyMeasurementUnit () const
int maxBars () const
int nominalCapacity () const
int remainingCapacity () const
int remainingCapacityBars () const
int remainingCapacityPercent () const
int remainingChargingTime () const
int voltage () const

Signals

void batteryStatusChanged ( QSystemBatteryInfo::BatteryStatus batteryStatus )
void chargerTypeChanged ( QSystemBatteryInfo::ChargerType chargerType )
void chargingStateChanged ( QSystemBatteryInfo::ChargingState chargingState )
void currentFlowChanged ( int level )
void nominalCapacityChanged ( int level )
void remainingCapacityBarsChanged ( int level )
void remainingCapacityChanged ( int level )
void remainingCapacityPercentChanged ( int level )
void remainingChargingTimeChanged ( int level )

Additional Inherited Members

Detailed Description

The QSystemBatteryInfo class provides access to battery and power information from the system.

Member Type Documentation

enum QSystemBatteryInfo::BatteryStatus

This enum describes the status of the main battery.

ConstantValueDescription
QSystemBatteryInfo::BatteryUnknown-1Battery level undetermined.
QSystemBatteryInfo::BatteryEmpty0Battery level reported as 0, system will shutdown.
QSystemBatteryInfo::BatteryCritical1Battery level is critical 3% or less.
QSystemBatteryInfo::BatteryVeryLow2Battery level is very low, 10% or less.
QSystemBatteryInfo::BatteryLow3Battery level is low 40% or less.
QSystemBatteryInfo::BatteryOk4Battery level is above 40%.
QSystemBatteryInfo::BatteryFull5Battery level is 100%.

enum QSystemBatteryInfo::ChargerType

This enum describes the type of charger used.

ConstantValueDescription
QSystemBatteryInfo::UnknownCharger-1Charger type unknown, or error.
QSystemBatteryInfo::NoCharger0No charger.
QSystemBatteryInfo::WallCharger1Using wall (mains) charger.
QSystemBatteryInfo::USBCharger2Using USB charger when the system cannot differentiate the current.
QSystemBatteryInfo::USB_500mACharger3Using USB charger at 500 mA.
QSystemBatteryInfo::USB_100mACharger4Using USB charger at 100 mA.
QSystemBatteryInfo::VariableCurrentCharger5Using variable current charger such as bicycle or solar.

enum QSystemBatteryInfo::ChargingState

This enum describes the charging state:

ConstantValueDescription
QSystemBatteryInfo::NotCharging0Battery is not charging.
QSystemBatteryInfo::Charging1Battery is charging.
QSystemBatteryInfo::ChargingError-1Error.

enum QSystemBatteryInfo::EnergyUnit

This enum describes the energy unit used by the system.

ConstantValueDescription
QSystemBatteryInfo::UnitUnknown-1Energy unit unknown.
QSystemBatteryInfo::UnitmAh0Energy described in milli Amp hours (mAh)
QSystemBatteryInfo::UnitmWh1Energy described in milli watt hours (mWh)

Property Documentation

batteryStatus : const BatteryStatus

This property holds the battery status.

Returns the battery charge status.

Access functions:

QSystemBatteryInfo::BatteryStatus batteryStatus () const

Notifier signal:

void batteryStatusChanged ( QSystemBatteryInfo::BatteryStatus batteryStatus )

chargerType : const ChargerType

This property holds the charger type. Returns the currently used charger type.

Access functions:

QSystemBatteryInfo::ChargerType chargerType () const

Notifier signal:

void chargerTypeChanged ( QSystemBatteryInfo::ChargerType chargerType )

chargingState : const ChargingState

This property holds the charging state. Returns the charging state.

Access functions:

QSystemBatteryInfo::ChargingState chargingState () const

Notifier signal:

void chargingStateChanged ( QSystemBatteryInfo::ChargingState chargingState )

currentFlow : const int

This property holds the battery current flow.

Returns the amount of current flowing out from the battery (a short term averge), milliapmeres (mA). Positive current means discharging and negative current means charging.

Access functions:

int currentFlow () const

Notifier signal:

void currentFlowChanged ( int level )

energyMeasurementUnit : const EnergyUnit

This property holds the energy unit used by the system. Returns the QSystemBatteryInfo::EnergyUnit that the system uses.

Access functions:

QSystemBatteryInfo::EnergyUnit energyMeasurementUnit () const

maxBars : const int

This property holds the maximum number of bars the system uses.

Returns the Maximum number of bars the system uses. In the case that the system has no default number of battery bars, 0 is returned.

Access functions:

int maxBars () const

nominalCapacity : const int

This property holds the nominal battery capacity.

Returns the nominal (maximum) capacity of the battery, in QSystemBatteryInfo::EnergyUnit. If no battery is found, -1.

Access functions:

int nominalCapacity () const

Notifier signal:

void nominalCapacityChanged ( int level )

remainingCapacity : const int

This property holds the battery level in QSystemBatteryInfo::EnergyUnit.

Returns the remaining battery level of the battery in QSystemBatteryInfo::EnergyUnit.

Access functions:

int remainingCapacity () const

Notifier signal:

void remainingCapacityChanged ( int level )

See also QSystemBatteryInfo::energyMeasurementUnit().

remainingCapacityBars : const int

This property holds the remaining capacity in number of bars.

Returns the remaining capacity in number of bars. The bar count will not necessarily always reflect one to one on the remaining capacity percentage.

Access functions:

int remainingCapacityBars () const

Notifier signal:

void remainingCapacityBarsChanged ( int level )

remainingCapacityPercent : const int

This property holds the battery level in percent.

Returns the remaining battery level of the battery in percent. If no battery is found, -1.

Access functions:

int remainingCapacityPercent () const

Notifier signal:

void remainingCapacityPercentChanged ( int level )

remainingChargingTime : const int

This property holds the remaining time of charging.

Returns the remaining time of charging in seconds if charging, In the case of battery is full and not charging 0 will be returned. In the case where no battery is found or the platform does not provide this information, -1 will be returned.

Access functions:

int remainingChargingTime () const

Notifier signal:

void remainingChargingTimeChanged ( int level )

voltage : const int

This property holds the battery voltage.

Returns the voltage of the battery, in millivolts (mV). If no battery is found, -1.

Access functions:

int voltage () const

Member Function Documentation

QSystemBatteryInfo::QSystemBatteryInfo ( QObject * parent = 0 )

Constructs a QSystemBatteryInfo object with the given parent.

QSystemBatteryInfo::~QSystemBatteryInfo ()

Destroys the QSystemBatteryInfo object.

void QSystemBatteryInfo::batteryStatusChanged ( QSystemBatteryInfo::BatteryStatus batteryStatus ) [signal]

This signal is emitted when battery status has changed. batteryStatus is the new battery status.

See also QSystemBatteryInfo::ChargingState.

void QSystemBatteryInfo::chargerTypeChanged ( QSystemBatteryInfo::ChargerType chargerType ) [signal]

This signal is emitted when the charger type has changed, such as when a phone gets plugged in to the wall, or usb. chargerType is the new charger type.

void QSystemBatteryInfo::chargingStateChanged ( QSystemBatteryInfo::ChargingState chargingState ) [signal]

This signal is emitted when charging state has changed. chargingState is the new chargingState.

void QSystemBatteryInfo::currentFlowChanged ( int level ) [signal]

This signal is emitted when the short term averge battery current has changed, or on some systems at regular intervals.

On some systems where this can lead to a CPU intensive process, you should disconnect from this signal when you are finished.

level is the new level.

void QSystemBatteryInfo::nominalCapacityChanged ( int level ) [signal]

This signal is emitted when nominal (maximum) battery level has changed. level is the new level.

void QSystemBatteryInfo::remainingCapacityBarsChanged ( int level ) [signal]

This signal is emitted when battery level has changed. level is the new level.

void QSystemBatteryInfo::remainingCapacityChanged ( int level ) [signal]

This signal is emitted when battery capacity has changed, reported in QSystemBatteryInfo::EnergyUnit. level is the new level.

void QSystemBatteryInfo::remainingCapacityPercentChanged ( int level ) [signal]

This signal is emitted when battery capacity in percent has changed. level is the new level.

void QSystemBatteryInfo::remainingChargingTimeChanged ( int level ) [signal]

This signal is emitted when remianing charge time has changed. level is the new level.