Class reference

Subclass of CIM_Battery

Capabilities and management of the Battery. This class applies to both batteries in Laptop Systems and other internal or external batteries, such as an uninterruptible power supply (UPS).

Local properties

uint16 BatteryStatus

Description of the charge status of the Battery. Values such as “Fully Charged” (value=3) or “Partially Charged” (value=11) can be specified. The value, 10, is not valid in the CIM Schema because in DMI it represents that no battery is installed. In this case, this object should not be instantiated. The valuemaps: 6(Charging), 7(Charging and High), 8(Charging and Low), and 9(Charing and Critical) has been deprecated in lieu of the ChargingStatus property. 10(Undefined) has been deprecated in lieu of 2(Unknown).

ValueMap Values
1 Other
2 Unknown
3 Fully Charged
4 Low
5 Critical
6 Charging
7 Charging and High
8 Charging and Low
9 Charging and Critical
10 Undefined
11 Partially Charged
12 Learning
13 Overcharged
DMTF Reserved
32768..65535 Vendor Specific

uint8 Capacity

Percentage of the current battery capacity.

string InstanceID

InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below.

To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following “preferred” algorithm:


Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>.

<LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above “preferred” algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance.

If not set to null for DMTF-defined instances, the “preferred” algorithm must be used with the <OrgID> set to CIM.

uint32 DesignCapacity

The design capacity of the battery in mWatt-hours. If this property is not supported, enter 0.

string SystemName

The System Name of the scoping system.

string ElementName

A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.

Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties. Note that if there is an associated instance of CIM_EnabledLogicalElementCapabilities, restrictions on this properties may exist as defined in ElementNameMask and MaxElementNameLen properties defined in that class.

uint32 TimeToFullCharge

The remaining time in minutes to charge the battery fully at the current charging rate and usage.

string Description

The Description property provides a textual description of the object.

uint32 RemainingCapacity

The Battery’s remaining charge capacity in mWatt-hours.

uint16 ChargingStatus

ChargingStatus indicates whether the battery is charging. Charging - the battery is charging. Discharging - the battery is discharging. Idle - the batter is neither charging nor discharging.

ValueMap Values
0 Unknown
2 Charging
3 Discharging
4 Idle
DMTF Reserved
32768..65535 Vendor Specified

string Name

The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.

uint64 DesignVoltage

The design voltage of the battery in mVolts. If this attribute is not supported, enter 0.

uint16 EstimatedChargeRemaining

An estimate of the percentage of full charge remaining.

string Caption

The Caption property is a short textual description (one- line string) of the object.

string DeviceID

An address or other identifying information used to uniquely name the LogicalDevice.

uint8 HealthPercent

An estimate of the percentage of the overall battery health. It indicates how much the battery has deteriorated over time. It can take values 0 to 100; 255 if it is unknown.

uint16 Chemistry

An enumeration that describes the chemistry of the Battery.

ValueMap Values
1 Other
2 Unknown
3 Lead Acid
4 Nickel Cadmium
5 Nickel Metal Hydride
6 Lithium-ion
7 Zinc air
8 Lithium Polymer
DMTF Reserved
32768..65535 Vendor Specified

string CreationClassName

CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.

uint32 EstimatedRunTime

EstimatedRunTime is an estimate in minutes of the time that battery charge depletion will occur under the present load conditions if the utility power is off, or is lost and remains off, or a Laptop is disconnected from a power source.

uint32 FullChargeCapacity

The full charge capacity of the battery in mWatt-hours. Comparison of this value to the Battery DesignCapacity determines when the Battery requires replacement. The end of life of a Battery is typically when the FullCharge Capacity falls below 80% of the DesignCapacity. If this property is not supported, enter 0.

string SystemCreationClassName

The CreationClassName of the scoping system.

Local methods