1 out of 1 rated this helpful - Rate this topic

Sensor class

The Sensor class represents a hardware device capable of measuring the characteristics of some physical property, for example, the temperature or voltage of the computer system monitored by the BMC. The SensorType property distinguishes between types of sensors. Each Sensor instance is a node for grouping NumericSensor instances. For example, all of the voltage sensors represented by NumericSensor may be grouped under a Sensor instance for voltages.

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

Syntax

class Sensor : CIM_Sensor
{
  string Caption;
  string CreationClassName;
  string CurrentState;
  string Description;
  string DeviceID;
  string ElementName;
  string Name;
  string OtherSensorTypeDescription;
  string PossibleStates[];
  uint16 SensorType;
  string SystemCreationClassName;
  string SystemName;
};

Members

The Sensor class has these types of members:

Properties

The Sensor class has these properties.

Caption
Data type: string
Access type: Read-only
Qualifiers: MaxLen (64)

Concatenation of sensor type string and sensor device ID. This property is inherited from CIM_ManagedElement.

Example: "Power Supply(52.0.32)"

CreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Fixed value: "Sensor". This property is inherited from CIM_LogicalDevice.

CurrentState
Data type: string
Access type: Read-only
Qualifiers: MaxLen (128)

Current state indicated by the sensor. The value must always come from PossibleStates. This property is inherited from CIM_Sensor.

Description
Data type: string
Access type: Read-only

Concatenation of the following values:

  • Sensor name
  • Sensor Device ID
  • Sensor Type string
  • Entity ID
  • Entity Instance

Example: "PwrSupply1Pres 0(52.0.32):Power Supply for Power supply 1"

DeviceID
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (64)

Concatenation of the following values:

  • Sensor Number
  • Owner LUN
  • Owner ID

This property is inherited from CIM_LogicalElement.

ElementName
Data type: string
Access type: Read-only

Concatenation of sensor name and sensor DeviceID.

Example: "PwrSupply1Pres 0(52.0.32)"

Name
Data type: string
Access type: Read-only
Qualifiers: MaxLen (256)

Same as ElementName. This property is inherited from CIM_ManagedSystemElement.

OtherSensorTypeDescription
Data type: string
Access type: Read-only
Qualifiers: MaxLen (128)

Describes the sensor type when SensorType is set to 1, meaning "Other". This property is inherited from CIM_Sensor.

PossibleStates
Data type: string array
Access type: Read-only

Enumerates the string outputs of the sensor. This property is inherited from CIM_Sensor.

Example: "Presence detected"

SensorType
Data type: uint16
Access type: Read-only

The type of sensor. If value is "Other", then the type is described in OtherSensorTypeDescription. This property is inherited from CIM_Sensor.

The possible values for this property are as follows.

ValueMeaning
0 (0x0)

Unknown.

1 (0x1)

Other.

2 (0x2)

Temperature.

3 (0x3)

Voltage.

4 (0x4)

Current.

5 (0x5)

Tachometer.

Measures the speed or revolutions of a device such as a fan.

6 (0x6)

Counter.

A general purpose sensor that measures some numerical property of a device. A counter value can be cleared, but it never decreases.

7 (0x7)

Switch.

A switch sensor has states like Open/Close, On/Off, or Up/Down.

8 (0x8)

Lock.

A Lock sensor has states of Locked/Unlocked.

9 (0x9)

Humidity.

10 (0xA)

Smoke detection.

11 (0xB)

Presence.

Detects the presence of a physical entity.

 

SystemCreationClassName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Fixed value: "ComputerSystem". This property is inherited from CIM_LogicalDevice.

SystemName
Data type: string
Access type: Read-only
Qualifiers: Key, MaxLen (256)

Fixed value: "IPMI Controller 32". This property is inherited from CIM_LogicalElement.

Requirements

Minimum supported client

Windows Vista [desktop apps only]

Minimum supported server

Windows Server 2003 R2 [desktop apps only]

Namespace

\root\hardware

MOF

Ipmiprv.mof

See also

Intelligent Platform Management Interface (IPMI) Classes

 

 

Send comments about this topic to Microsoft

Build date: 11/19/2012

Community Additions

ADD
© 2013 Microsoft. All rights reserved.