xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Sensor/Type.interface.yaml (revision 78a184942de9dbd77d7274668c50fc121f8b84e7) 
1description: >
2    Implement to provide detail on type of the sensor. Each property in the
3    interface maps to a distinct group of sensor subtypes.
4
5    Objects implementing Sensor.Type shall also implement Sensor.Value.
6
7properties:
8    - name: ReadingBasis
9      type: enum[self.ReadingBasisType]
10      default: Unknown
11      flags:
12          - readonly
13      description: >
14          Defines the type of the sensor based on how the sensor reading is
15          determined.
16
17    - name: Implementation
18      type: enum[self.ImplementationType]
19      default: Unknown
20      flags:
21          - readonly
22      description: >
23          The type of sensor implementation indicating how the reading is
24          obtained.
25
26enumerations:
27    - name: ReadingBasisType
28      description: >
29          Types of the sensors based on how their reading is determined.
30      values:
31          - name: Unknown
32            description: >
33                Indicates that the how sensor reading is determined is not
34                known.
35          - name: Zero
36            description: >
37                A zero-based reading. This value shall indicate a reading with
38                zero as its reference point.
39          - name: Delta
40            description: >
41                A reading that reports the difference between two measurements.
42                This value shall indicate a reading that reports the difference
43                between two measurements.
44          - name: Headroom
45            description: >
46                Indicates that the reading decreases in value as it approaches
47                the reference point. If the value crosses the reference point,
48                the value may be reported as a negative number, or may report a
49                value of zero.
50
51    - name: ImplementationType
52      description: >
53          The method by which the sensor reading is obtained.
54      values:
55          - name: Unknown
56            description: >
57                The source of the sensor reading is unknown(unable to classify).
58          - name: Physical
59            description: >
60                The sensor reading is acquired from a physical sensor.
61                Service(on BMC) is monitoring the sensor reading.
62          - name: Reported
63            description: >
64                Source of sensor reading is some other BMC/software component.
65                But  sensor is represented on local BMC.
66          - name: Synthesized
67            description: >
68                The sensor reading is obtained by applying a calculation on one
69                or more properties or multiple sensors.
70