summaryrefslogtreecommitdiffstats
path: root/org/open_power/Sensor/Aggregation/History/Maximum.interface.yaml
blob: e0f116a3f588956e0fa9da1fccd9b034b45efd11 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
description: >
    Implement to provide an object that contains a history of maximum values.
    The values are the maximum values within a time period.  The object this
    interface is placed on should provide information about the time period.

properties:
    - name: Scale
      type: int64
      description: >
          The reading scaling factor N, where the actual reading is value * 10^N.
          This is immutable once set.

    - name: Unit
      type: enum[self.Unit]
      description: >
          The unit of the reading.  Immutable once set for a sensor.
          For objects in the temperature namespace, Unit must be "DegreesC".
          For objects in the fan_tach namespace, Unit must be "RPMS".
          For objects in the voltage namespace, Unit must be "Volts".
          For objects in the altitude namespace, Unit must be "Meters".
          For objects in the current namespace, Unit must be "Amperes".
          For objects in the power namespace, Unit must be "Watts".
          For objects in the energy namespace, Unit must be "Joules".

    - name: Values
      type: array[struct[uint64,int64]]
      description: >
          An array of timestamp, maximum value tuples.  The timestamp is the
          number of milliseconds since 1970.  The entries in the array will
          always be ordered from newest to oldest.

enumerations:
    - name: Unit
      description: >
        A sensor reading unit.
      values:
        - name: DegreesC
          description: >
            Temperature as degrees Celsius.
        - name: RPMS
          description: >
            Frequency of rotation as revolutions per minute.
        - name: Volts
          description: >
            Electromotive force as volts.
        - name: Meters
          description: >
            Length as meters.
        - name: Amperes
          description: >
            Electrical charge flow rate as Amperes.
        - name: Watts
          description: >
            Rate of energy transfer as Watts.
        - name: Joules
          description: >
            Energy transfer as Joules.
OpenPOWER on IntegriCloud