# 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_AllocatedLogicalElement
|
+--CIM_LogicalDevice
|
+--CIM_PowerSource
|
+--CIM_Battery

## Direct Known Subclasses

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | 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).
UMLPackagePath | string | CIM::Device::CoolingAndPower
Version | string | 2.26.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
BatteryStatus | uint16 |
Description | string | 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).
MappingStrings | string | MIF.DMTF|Portable Battery|003.14
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, .., 32768..65535
Values | string | Other, Unknown, Fully Charged, Low, Critical, Charging, Charging and High, Charging and Low, Charging and Critical, Undefined, Partially Charged, Learning, Overcharged, DMTF Reserved, Vendor Specific
ChargingStatus | uint16 |
Description | string | 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 | string | 0, 2, 3, 4, .., 32768..65535
Values | string | Unknown, Charging, Discharging, Idle, DMTF Reserved, Vendor Specified
Chemistry | uint16 |
Description | string | An enumeration that describes the chemistry of the Battery.
MappingStrings | string | MIF.DMTF|Portable Battery|003.7
ValueMap | string | 1, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
Values | string | Other, Unknown, Lead Acid, Nickel Cadmium, Nickel Metal Hydride, Lithium-ion, Zinc air, Lithium Polymer, DMTF Reserved, Vendor Specified
DesignCapacity | uint32 |
Description | string | The design capacity of the battery in mWatt-hours. If this property is not supported, enter 0.
MappingStrings | string | MIF.DMTF|Portable Battery|003.8
PUnit | string | watt * hour * 10^-3
Units | string | MilliWattHours
DesignVoltage | uint64 |
Description | string | The design voltage of the battery in mVolts. If this attribute is not supported, enter 0.
MappingStrings | string | MIF.DMTF|Portable Battery|003.9
PUnit | string | volt * 10^-3
Units | string | MilliVolts
EstimatedChargeRemaining | uint16 |
Description | string | An estimate of the percentage of full charge remaining.
Gauge | boolean | true
PUnit | string | percent
Units | string | Percent
EstimatedRunTime | uint32 |
Description | string | 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.
MappingStrings | string | MIF.DMTF|Portable Battery|003.15
PUnit | string | minute
Units | string | Minutes
ExpectedLife | uint32 |
Description | string | Indicates 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.
PUnit | string | minute
Units | string | Minutes
FullChargeCapacity | uint32 |
Description | string | 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.
MappingStrings | string | MIF.DMTF|Portable Battery|003.11
PUnit | string | watt * hour * 10^-3
Units | string | MilliWattHours
HealthPercent | uint8 |
Description | string | 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.
PUnit | string | percent
Units | string | Percentage
MaxRechargeCount | uint32 |
Description | string | The maximum number of times the Battery can be recharged.
MaxRechargeTime | uint32 |
Description | string | MaxRechargeTime 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.
PUnit | string | minute
Units | string | Minutes
OtherChemistryDescription | string |
Description | string | The 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).
PermanentErrorInfo | uint16 |
Description | string | An 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.
Experimental | boolean | true
ValueMap | string | 0, 2, 3, 4, 5, 6, 7, 8, .., 32768..65535
Values | string | Unknown, No Failure, Fuse Blown, Cell imbalance, Over voltage, FET inoperative, Communication error, Incompatible battery type, DMTF Reserved, Vendor Reserved
RechargeCount | uint32 |
Description | string | The number of times the Battery has been recharged.
RemainingCapacity | uint32 |
Description | string | The Battery's remaining charge capacity in mWatt-hours.
PUnit | string | watt * hour * 10^-3
Units | string | MilliWattHours
RemainingCapacityMaxError | uint8 |
Description | string | The maximum error (as a percentage) in the mWatt-hour data reported by RemainingCapacity property.
PUnit | string | percent
Units | string | Percentage
SmartBatteryVersion | string |
Description | string | The 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.
MappingStrings | string | MIF.DMTF|Portable Battery|003.10
MaxLen | uint32 | 64
TimeOnBattery | uint32 |
Description | string | TimeOnBattery 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'.
PUnit | string | second
Units | string | Seconds
TimeToFullCharge | uint32 |
Description | string | The remaining time in minutes to charge the battery fully at the current charging rate and usage.
MappingStrings | string | MIF.DMTF|Portable Battery|003.16
PUnit | string | minute
Units | string | Minutes

### Inherited Properties

Name | Data Type | Class Origin
--- | --- | ---
AllocationState | string | CIM_LogicalDevice
Availability | uint16 | CIM_LogicalDevice
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_LogicalDevice
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
DeviceID | string | CIM_LogicalDevice
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
ErrorCleared | boolean | CIM_LogicalDevice
ErrorDescription | string | CIM_LogicalDevice
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
IsACOutput | boolean | CIM_PowerSource
LastErrorCode | uint32 | CIM_LogicalDevice
LocationIndicator | uint16 | CIM_LogicalDevice
MaxQuiesceTime | uint64 | CIM_LogicalDevice
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OutputPowerUnits | string | CIM_PowerSource
PowerManagementSupported | boolean | CIM_LogicalDevice
PowerOnHours | uint64 | CIM_LogicalDevice
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RatedMaxOutputPower | uint32 | CIM_PowerSource
RequestedState | uint16 | CIM_EnabledLogicalElement
Status | string | CIM_ManagedSystemElement
StatusInfo | uint16 | CIM_LogicalDevice
SystemCreationClassName | string | CIM_LogicalDevice
SystemName | string | CIM_LogicalDevice
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TotalPowerOnHours | uint64 | CIM_LogicalDevice
TransitioningToState | uint16 | CIM_EnabledLogicalElement
AdditionalAvailability | uint16[] | CIM_LogicalDevice
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_LogicalDevice
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_LogicalDevice
PowerManagementCapabilities | uint16[] | CIM_LogicalDevice
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
EnableDevice | uint32 | CIM_LogicalDevice
OnlineDevice | uint32 | CIM_LogicalDevice
QuiesceDevice | uint32 | CIM_LogicalDevice
RequestStateChange | uint32 | CIM_EnabledLogicalElement
Reset | uint32 | CIM_LogicalDevice
RestoreProperties | uint32 | CIM_LogicalDevice
SaveProperties | uint32 | CIM_LogicalDevice
SetPowerState | uint32 | CIM_LogicalDevice