Edit

Share via

CIM_Battery class

  • Article

The CIM_Battery class represents the capabilities and management of the battery logical device. This class applies to batteries in laptop systems and other internal and external batteries.

Important

The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.

The following syntax is simplified from Managed Object Format (MOF) code and includes all inherited properties. Properties are listed in alphabetic order, not MOF order.

Syntax

[Abstract, UUID("{8502C548-5FBB-11D2-AAC1-006008C78BC7}"), AMENDMENT]
class CIM_Battery : CIM_LogicalDevice
{
  string   Caption;
  string   Description;
  datetime InstallDate;
  string   Name;
  string   Status;
  uint16   Availability;
  uint32   ConfigManagerErrorCode;
  boolean  ConfigManagerUserConfig;
  string   CreationClassName;
  string   DeviceID;
  uint16   PowerManagementCapabilities[];
  boolean  ErrorCleared;
  string   ErrorDescription;
  uint32   LastErrorCode;
  string   PNPDeviceID;
  boolean  PowerManagementSupported;
  uint16   StatusInfo;
  string   SystemCreationClassName;
  string   SystemName;
  uint16   BatteryStatus;
  uint16   Chemistry;
  uint32   DesignCapacity;
  uint64   DesignVoltage;
  uint16   EstimatedChargeRemaining;
  uint32   EstimatedRunTime;
  uint32   ExpectedLife;
  uint32   FullChargeCapacity;
  uint32   MaxRechargeTime;
  string   SmartBatteryVersion;
  uint32   TimeOnBattery;
  uint32   TimeToFullCharge;
};

Members

The CIM_Battery class has these types of members:

Methods

The CIM_Battery class has these methods.

Method Description
Reset Requests a reset of the logical device. Not implemented by WMI.
SetPowerState Defines the desired power state for a logical device and when the device should be put into that state. Not implemented by WMI.

Properties

The CIM_Battery class has these properties.

Availability

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus")

Availability and status of the device.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Running/Full Power (3)

Warning (4)

In Test (5)

Not Applicable (6)

Power Off (7)

Off Line (8)

Off Duty (9)

Degraded (10)

Not Installed (11)

Install Error (12)

Power Save - Unknown (13)

The device is known to be in a power save mode, but its exact status is unknown.

Power Save - Low Power Mode (14)

The device is in a power save state but still functioning, and may exhibit degraded performance.

Power Save - Standby (15)

The device is not functioning but could be brought to full power quickly.

Power Cycle (16)

Power Save - Warning (17)

The device is in a warning state, though also in a power save mode.

Paused (18)

The device is paused.

Not Ready (19)

The device is not ready.

Not Configured (20)

The device is not configured.

Quiesced (21)

The device is quiet.

BatteryStatus

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.14")

Description of the battery's charge status. The value 10 is not valid in the CIM schema, which represents no battery being installed in Desktop Management Interface (DMI). In this case, the object should not be instantiated.

Other (1)

Other.

Unknown (2)

Unknown.

Fully Charged (3)

Fully charged.

Low (4)

Low.

Critical (5)

Critical.

Charging (6)

Charging.

Charging and High (7)

Charging and high.

Charging and Low (8)

Charging and low.

Charging and Critical (9)

Charging and critical.

Undefined (10)

Undefined.

Partially Charged (11)

Partially charged.

Caption

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), DisplayName ("Caption")

A short textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

Chemistry

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.7")

Enumeration that describes the battery's chemistry.

Other (1)

Other.

Unknown (2)

Unknown.

Lead Acid (3)

Lead acid.

Nickel Cadmium (4)

Nickel cadmium.

Nickel Metal Hydride (5)

Nickel metal hydride.

Lithium-ion (6)

Lithium ion.

Zinc air (7)

Zinc air.

Lithium Polymer (8)

Lithium polymer.

ConfigManagerErrorCode

Data type: uint32

Access type: Read-only

Qualifiers: Schema ("Win32")

Win32 Configuration Manager error code.

This property is inherited from CIM_LogicalDevice.

This device is working properly. (0)

This device is not configured correctly. (1)

Windows cannot load the driver for this device. (2)

The driver for this device might be corrupted, or your system may be running low on memory or other resources. (3)

This device is not working properly. One of its drivers or your registry might be corrupted. (4)

The driver for this device needs a resource that Windows cannot manage. (5)

The boot configuration for this device conflicts with other devices. (6)

Cannot filter. (7)

The driver loader for the device is missing. (8)

This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly. (9)

This device cannot start. (10)

This device failed. (11)

This device cannot find enough free resources that it can use. (12)

Windows cannot verify this device's resources. (13)

This device cannot work properly until you restart your computer. (14)

This device is not working properly because there is probably a re-enumeration problem. (15)

Windows cannot identify all the resources this device uses. (16)

This device is asking for an unknown resource type. (17)

Reinstall the drivers for this device. (18)

Failure using the VxD loader. (19)

Your registry might be corrupted. (20)

System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device. (21)

This device is disabled. (22)

System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation. (23)

This device is not present, is not working properly, or does not have all its drivers installed. (24)

Windows is still setting up this device. (25)

Windows is still setting up this device. (26)

This device does not have valid log configuration. (27)

The drivers for this device are not installed. (28)

This device is disabled because the firmware of the device did not give it the required resources. (29)

This device is using an Interrupt Request (IRQ) resource that another device is using. (30)

This device is not working properly because Windows cannot load the drivers required for this device. (31)

ConfigManagerUserConfig

Data type: boolean

Access type: Read-only

Qualifiers: Schema ("Win32")

If TRUE, the device is using a user-defined configuration.

This property is inherited from CIM_LogicalDevice.

CreationClassName

Data type: string

Access type: Read-only

Qualifiers: CIM_Key

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

This property is inherited from CIM_LogicalDevice.

Description

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Description")

A textual description of the object.

This property is inherited from CIM_ManagedSystemElement.

DesignCapacity

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.8"), Units ("milliwatt-hours")

Designed capacity of the battery in milliwatt-hours. If this property is not supported, enter 0.

DesignVoltage

Data type: uint64

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.9"), Units ("millivolts")

Designed voltage of the battery in millivolts. If this attribute is not supported, enter 0.

For more information about using uint64 values in scripts, see Scripting in WMI.

DeviceID

Data type: string

Access type: Read-only

Qualifiers: CIM_Key

Address or other identifying information to uniquely name the logical device.

This property is inherited from CIM_LogicalDevice.

ErrorCleared

Data type: boolean

Access type: Read-only

If TRUE, the error reported in the LastErrorCode property is now cleared.

This property is inherited from CIM_LogicalDevice.

ErrorDescription

Data type: string

Access type: Read-only

Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform.

This property is inherited from CIM_LogicalDevice.

EstimatedChargeRemaining

Data type: uint16

Access type: Read-only

Qualifiers: Units ("percent")

Estimated percentage of the remaining full charge.

EstimatedRunTime

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.15"), Units ("minutes")

Estimated time, in minutes, until the battery charge is depleted under the present load conditions if the utility power is off, is lost and remains off, or if a laptop is disconnected from a power source.

ExpectedLife

Data type: uint32

Access type: Read-only

Qualifiers: Units ("minutes")

Battery's expected lifetime, in minutes, assuming that the battery is fully charged. This property represents the total expected life of the battery, not its current remaining life, which is indicated by the EstimatedRunTime property.

FullChargeCapacity

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.11"), Units ("milliwatt-hours")

The full charge capacity of the battery in milliwatt-hours. Compare this value to the DesignCapacity property to determine when the battery requires replacement. A battery's end-life is typically when the FullChargeCapacity property falls below 80 percent of the DesignCapacity property. If this property is not supported, enter 0.

InstallDate

Data type: datetime

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5"), DisplayName ("Install Date")

Indicates when the object was installed. Lack of a value does not indicate that the object is not installed.

This property is inherited from CIM_ManagedSystemElement.

LastErrorCode

Data type: uint32

Access type: Read-only

Last error code reported by the logical device.

This property is inherited from CIM_LogicalDevice.

MaxRechargeTime

Data type: uint32

Access type: Read-only

Qualifiers: Units ("minutes")

Maximum time, in minutes, to fully charge the battery. This property represents the time to recharge a fully depleted battery, not the current remaining charging time, which is indicated in the TimeToFullCharge property.

Name

Data type: string

Access type: Read-only

Qualifiers: DisplayName ("Name")

Label by which the object is known. When subclassed, this property can be overridden to be a key property.

This property is inherited from CIM_ManagedSystemElement.

PNPDeviceID

Data type: string

Access type: Read-only

Qualifiers: Schema ("Win32")

Indicates the Win32 Plug and Play device identifier of the logical device.

Example: "*PNP030b"

This property is inherited from CIM_LogicalDevice.

PowerManagementCapabilities

Data type: uint16 array

Access type: Read-only

Indicates the specific power-related capabilities of the logical device.

This property is inherited from CIM_LogicalDevice.

Unknown (0)

The power-related capacities are unknown.

Not Supported (1)

Power-related capacities are not supported for this device.

Disabled (2)

Power-related capacities have been disabled.

Enabled (3)

The power management features are currently enabled but the exact feature set is unknown or the information is unavailable.

Power Saving Modes Entered Automatically (4)

The device can change its power state based on usage or other criteria.

Power State Settable (5)

The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes.

Power Cycling Supported (6)

The SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle").

Timed Power On Supported (7)

The SetPowerState method can be invoked with the PowerState parameter set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.

PowerManagementSupported

Data type: boolean

Access type: Read-only

If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.

This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.

This property is inherited from CIM_LogicalDevice.

SmartBatteryVersion

Data type: string

Access type: Read-only

Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|Portable Battery|002.10")

Smart battery data-specification version number that is supported by this battery. If the battery does not support this function, the value should be left empty.

Status

Data type: string

Access type: Read-only

Qualifiers: MaxLen (10), DisplayName ("Status")

String that indicates the current status of the object. Operational and non-operational status can be defined. Operational status can include "OK", "Degraded", and "Pred Fail". "Pred Fail" indicates that an element is functioning properly, but is predicting a failure (for example, a SMART-enabled hard disk drive).

Non-operational status can include "Error", "Starting", "Stopping", and "Service". "Service" can apply during disk mirror-resilvering, reloading a user permissions list, or other administrative work. Not all such work is online, but the managed element is neither "OK" nor in one of the other states.

This property is inherited from CIM_ManagedSystemElement.

Values include the following:

OK ("OK")

Error ("Error")

Degraded ("Degraded")

Unknown ("Unknown")

Pred Fail ("Pred Fail")

Starting ("Starting")

Stopping ("Stopping")

Service ("Service")

Stressed ("Stressed")

NonRecover ("NonRecover")

No Contact ("No Contact")

Lost Comm ("Lost Comm")

StatusInfo

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Operational State|003.3")

State of the logical device. If this property does not apply to the logical device, the value 5 ("Not Applicable") should be used.

This property is inherited from CIM_LogicalDevice.

Other (1)

Unknown (2)

Enabled (3)

Disabled (4)

Not Applicable (5)

SystemCreationClassName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_System.CreationClassName"), CIM_Key

The scoping system's creation class name.

This property is inherited from CIM_LogicalDevice.

SystemName

Data type: string

Access type: Read-only

Qualifiers: Propagated ("CIM_System.Name"), CIM_Key

The scoping system's name.

This property is inherited from CIM_LogicalDevice.

TimeOnBattery

Data type: uint32

Access type: Read-only

Qualifiers: Units ("seconds")

Elapsed time, in seconds, since the computer system's UPS last switched to battery power, or the amount of time since the system or UPS was last restarted, whichever is less. A value of 0 is returned if the battery is "online."

TimeToFullCharge

Data type: uint32

Access type: Read-only

Qualifiers: MappingStrings ("MIF.DMTF|Portable Battery|002.16"), Units ("minutes")

Remaining time, in minutes, to charge the battery fully at the current charging rate and use.

Remarks

The CIM_Battery class is derived from CIM_LogicalDevice.

WMI does not implement this class. For more information about classes derived from CIM_Battery, see Win32 Classes.

This documentation is derived from the CIM class descriptions published by the DMTF. Microsoft may have made changes to correct minor errors, conform to Microsoft SDK documentation standards, or provide more information.

Requirements

Requirement Value
Minimum supported client
 Windows Vista
Minimum supported server
 Windows Server 2008
Namespace
 Root\CIMV2
MOF
CIMWin32.mof
DLL
CIMWin32.dll

See also

CIM_LogicalDevice