Class CIM_Battery
extends CIM_PowerSource

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).

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_PowerSource
   |
   +--CIM_Battery

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCapabilities 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).
UMLPackagePathstringCIM::Device::CoolingAndPower
Versionstring2.26.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
BatteryStatusuint16
DescriptionstringDescription 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).
MappingStringsstringMIF.DMTF|Portable Battery|003.14
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, .., 32768..65535
ValuesstringOther, Unknown, Fully Charged, Low, Critical, Charging, Charging and High, Charging and Low, Charging and Critical, Undefined, Partially Charged, Learning, Overcharged, DMTF Reserved, Vendor Specific
ChargingStatusuint16
DescriptionstringChargingStatus indicates whether the battery is charging. Charging - the battery is charging. Discharging - the battery is discharging. Idle - the batter is neither charging nor discharging.
ValueMapstring0, 2, 3, 4, .., 32768..65535
ValuesstringUnknown, Charging, Discharging, Idle, DMTF Reserved, Vendor Specified
Chemistryuint16
DescriptionstringAn enumeration that describes the chemistry of the Battery.
MappingStringsstringMIF.DMTF|Portable Battery|003.7
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
ValuesstringOther, Unknown, Lead Acid, Nickel Cadmium, Nickel Metal Hydride, Lithium-ion, Zinc air, Lithium Polymer, DMTF Reserved, Vendor Specified
DesignCapacityuint32
DescriptionstringThe design capacity of the battery in mWatt-hours. If this property is not supported, enter 0.
MappingStringsstringMIF.DMTF|Portable Battery|003.8
PUnitstringwatt * hour * 10^-3
UnitsstringMilliWattHours
DesignVoltageuint64
DescriptionstringThe design voltage of the battery in mVolts. If this attribute is not supported, enter 0.
MappingStringsstringMIF.DMTF|Portable Battery|003.9
PUnitstringvolt * 10^-3
UnitsstringMilliVolts
EstimatedChargeRemaininguint16
DescriptionstringAn estimate of the percentage of full charge remaining.
Gaugebooleantrue
PUnitstringpercent
UnitsstringPercent
EstimatedRunTimeuint32
DescriptionstringEstimatedRunTime 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.
MappingStringsstringMIF.DMTF|Portable Battery|003.15
PUnitstringminute
UnitsstringMinutes
ExpectedLifeuint32
DescriptionstringIndicates the expected lifetime of the Battery 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.
PUnitstringminute
UnitsstringMinutes
FullChargeCapacityuint32
DescriptionstringThe 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.
MappingStringsstringMIF.DMTF|Portable Battery|003.11
PUnitstringwatt * hour * 10^-3
UnitsstringMilliWattHours
HealthPercentuint8
DescriptionstringAn 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.
PUnitstringpercent
UnitsstringPercentage
MaxRechargeCountuint32
DescriptionstringThe maximum number of times the Battery can be recharged.
MaxRechargeTimeuint32
DescriptionstringMaxRechargeTime indicates the 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.
PUnitstringminute
UnitsstringMinutes
OtherChemistryDescriptionstring
DescriptionstringThe description of the battery chemistry when the Chemistry property has value 1 (Other). The property shall be implemented if the Chemistry property has value 1(Other).
PermanentErrorInfouint16
DescriptionstringAn enumeration that describes the error information in the event of permanent failure of the battery. This code will enable system administrators to troubleshoot the reason behind failed batteries. Unknown value means a permanent error has occured but the error type is unknown.
Experimentalbooleantrue
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
ValuesstringUnknown, No Failure, Fuse Blown, Cell imbalance, Over voltage, FET inoperative, Communication error, Incompatible battery type, DMTF Reserved, Vendor Reserved
RechargeCountuint32
DescriptionstringThe number of times the Battery has been recharged.
RemainingCapacityuint32
DescriptionstringThe Battery's remaining charge capacity in mWatt-hours.
PUnitstringwatt * hour * 10^-3
UnitsstringMilliWattHours
RemainingCapacityMaxErroruint8
DescriptionstringThe maximum error (as a percentage) in the mWatt-hour data reported by RemainingCapacity property.
PUnitstringpercent
UnitsstringPercentage
SmartBatteryVersionstring
DescriptionstringThe 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 blank.
MappingStringsstringMIF.DMTF|Portable Battery|003.10
MaxLenuint3264
TimeOnBatteryuint32
DescriptionstringTimeOnBattery indicates the elapsed time in seconds since the ComputerSystem, UPS, or so on, last switched to battery power, or the time since the System or UPS was last restarted, whichever is less. Zero is returned if the Battery is 'on line'.
PUnitstringsecond
UnitsstringSeconds
TimeToFullChargeuint32
DescriptionstringThe remaining time in minutes to charge the battery fully at the current charging rate and usage.
MappingStringsstringMIF.DMTF|Portable Battery|003.16
PUnitstringminute
UnitsstringMinutes

Inherited Properties

NameData TypeClass Origin
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
IsACOutputbooleanCIM_PowerSource
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OutputPowerUnitsstringCIM_PowerSource
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RatedMaxOutputPoweruint32CIM_PowerSource
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice