Win32_PowerMeter
Collapse the table of content
Expand the table of content

Win32_PowerMeter class

The Win32_PowerMeter class provides metering and budgeting information from an underlying power meter.

The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.

Syntax

[Provider("PowerMeterProvider"), Dynamic]
class Win32_PowerMeter : CIM_NumericSensor
{
  string  Name;
  string  DeviceID;
  uint32  SupportCapabilities;
  uint32  MeterType;
  uint32  SamplingPeriod;
  uint32  MinimumAveragingInterval;
  uint32  MaximumAveragingInterval;
  uint32  AveragingInterval;
  uint32  MinOperatingBudget;
  uint32  MaxOperatingBudget;
  boolean BudgetWriteable;
  boolean BudgetEnabled;
  uint32  ConfiguredBudget;
  uint16  BaseUnits;
  sint32  UnitModifier;
  uint32  Hysteresis;
};

Members

The Win32_PowerMeter class has these types of members:

Properties

The Win32_PowerMeter class has these properties.

AveragingInterval
Data type: uint32
Access type: Write-only

Specifies the averaging interval set in the power meter that is currently configured. Values read through this property are averaged over this interval.

The value of AveragingInterval must be between the values specified by the MinimumAveragingInterval and MaximumAveragingInterval properties, inclusive.

BaseUnits
Data type: uint16
Access type: Read-only

Specifies the base unit of the measurements.

Note  Starting in Windows 7 and Windows Server 2008 R2, the Win32_PowerMeter class only supports base units in watts.
 
BudgetEnabled
Data type: boolean
Access type: Write-only

Determines whether the power budget is enabled. If this property is TRUE, the power budget is enabled.

BudgetWriteable
Data type: boolean
Access type: Read-only

Determines whether this power budget is writeable. If this property is FALSE, saving an instance of the Win32_PowerMeter data with a modified ConfiguredBudget will fail, and the currently configured budget will not be changed.

ConfiguredBudget
Data type: uint32
Access type: Write-only

Specifies the power budget that is configured for this power meter. This value is marked writeable. The value will take effect when the instance is saved, but only if BudgetWriteable is set to TRUE. Otherwise, the save will fail.

DeviceID
Data type: string
Access type: Read-only

Specifies the unique identifier of the power meter. For more information about device IDs, see Device Identification.

Hysteresis
Data type: uint32
Access type: Read-only

Specifies the hysteresis margin of the power meter.

MaximumAveragingInterval
Data type: uint32
Access type: Read-only

Defines the maximum allowed value for the interval, in milliseconds, over which the power meter averages samples.

MaxOperatingBudget
Data type: uint32
Access type: Read-only

Specifies the maximum power budget, in watts, supported by the power meter.

MeterType
Data type: uint32
Access type: Read-only

Specifies the power measurements reported by the power meter. This property must be set to one of the following values.

ValueMeaning
0

The measurement data is based on input power.

1

The measurement data is based on output power.

 

MinimumAveragingInterval
Data type: uint32
Access type: Read-only

Defines the minimum interval, in milliseconds, over which the power meter averages samples.

MinOperatingBudget
Data type: uint32
Access type: Read-only

Specifies the minimum power budget, in watts, supported by the power meter.

Name
Data type: string
Access type: Read-only

Specifies the display name of the power meter.

SamplingPeriod
Data type: uint32
Access type: Read-only

Specifies the sampling period, in milliseconds, of the power meter. This property specifies the frequency with which the power meter reads data from the power supply.

SupportCapabilities
Data type: uint32
Access type: Read-only

A bitmask that specifies the supported capabilities of the power meter. This property must be set to one or more of the following values.

ValueMeaning
SupportMeasurement
0

Set if the power meter supports power measurement.

SupportThresholds
1

Set if the power meter supports power thresholds.

SupportBudgeting
2

Set if the power meter supports power budgeting.

SupportOnlyWhenDischarging
8

Set if the power meter reports data only when the power supply is discharging. This is typically the case on mobile battery systems or some uninterruptible power supplies (UPSs).

 

UnitModifier
Data type: sint32
Access type: Read-only

Specifies the unit modifier that determines the magnitude of the unit. For example, a value of -3 means that the reading is 0.001 times that of the base unit.

Remarks

The Win32_PowerMeter class is derived from the CIM_NumericSensor class. It is the primary WMI class for obtaining power consumption and budgeting information from a power meter.

An instance of the Win32_PowerMeter class is associated with the device that is being metered. For example, a power meter that supports power metering and budgeting for the entire system is associated with the instance of the Win32_ComputerSystem class that represents the system.

For more information, see CIM_NumericSensor and Win32_ComputerSystem.

Requirements

Minimum supported client

Windows 7

Minimum supported server

Windows Server 2008 R2

Namespace

Root\CIMV2\power

MOF

PowerMeterProvider.mof

DLL

UmPoWmi.dll

 

 

Community Additions

ADD
Show:
© 2016 Microsoft