Documentation  |   Table of Contents   |  < Previous   |  Next >   |  Index

17    Common Battery Types

System Management

Exploring Palm OS®

The header file CmnBatteryTypes.h simply defines battery types and battery states. The material in this chapter is divided up as follows:

Common Battery Types Structures and Types
Common Battery Types Constants

Common Battery Types Structures and Types ^TOP^

SysBatteryKind Typedef ^TOP^

Purpose

Contains a value indicating the type of battery used by the handheld.

Declared In

CmnBatteryTypes.h

Prototype

typedef Enum8 SysBatteryKind

Comments

See SysBatteryKindTag for the set of values that this type can assume.

SysBatteryState Typedef ^TOP^

Purpose

Contains a value indicating the current state of the handheld's battery.

Declared In

CmnBatteryTypes.h

Prototype

typedef Enum8 SysBatteryState

Comments

See SysBatteryStateTag for the set of values that this type can assume.

Common Battery Types Constants ^TOP^

SysBatteryKindTag Enum ^TOP^

Purpose

Identify the type of battery used in a Palm Powered handheld.

Declared In

CmnBatteryTypes.h

Constants

sysBatteryKindAlkaline = 0
Alkaline.
sysBatteryKindNiCad
Nickel-Cadmium (NiCad).
sysBatteryKindLiIon
Lithium Ion.
sysBatteryKindRechAlk
Rechargeable alkaline.
sysBatteryKindNiMH
Nickel-Metal-Hydride.
sysBatteryKindLiIon1400
Lithium-Ion, 1400 mA.
sysBatteryKindFuelCell
Fuel cell.
sysBatteryKindPlutonium237
Future power source.
sysBatteryKindAntiMatter
Future power source.
sysBatteryKindLast = 0xFF
The upper limit of the battery type values.

SysBatteryStateTag Enum ^TOP^

Purpose

Identify the state of the handheld's battery.

Declared In

CmnBatteryTypes.h

Constants

sysBatteryStateNormal = 0
The battery is in a normal state, able to provide sufficient power for normal handheld operation.
sysBatteryStateLowBattery
Battery power is low; the battery should be recharged. The battery can still provide sufficient power for normal handheld operation, but only for a limited time.
sysBatteryStateCritBattery
The battery state is critical; it should be recharged immediately. Normal operations will be curtailed.
sysBatteryStateShutdown
The battery cannot provide sufficient power to run the display. The handheld will be, or is already, shut down.