blob: 106210539edbac453bc22dff2b71d65bdd48cfa1 [file] [log] [blame]
Brad Bishop45387d62016-11-10 21:58:58 -06001description: >
2 Implement to provide sensor readings. Objects implementing
3 Sensor.Value must be instantiated in the correct
4 hierarchy within the sensors namespace. The following sensor
5 hierarchies are recognized:
6 temperature
7 fan_tach
8 voltage
9 altitude
Brad Bishop6c4e2e92016-12-28 13:38:31 -050010 current
11 power
12 energy
Adrian Ambrożewiczff697932020-05-11 11:46:50 +020013 utilization
Brad Bishop45387d62016-11-10 21:58:58 -060014
15 Any service implementing Sensor.Value on one or more objects must
16 implement org.freedesktop.DBus.ObjectManager on the sensors namespace root.
17
18 All Sensor.Value properties are read-only.
19
20properties:
21 - name: Value
James Feist4ec65872018-07-31 11:00:25 -070022 type: double
Brad Bishop45387d62016-11-10 21:58:58 -060023 description: >
24 The sensor reading.
James Feist8a3b49d2018-01-22 16:11:43 -080025 - name: MaxValue
James Feist4ec65872018-07-31 11:00:25 -070026 type: double
Patrick Williams5d0b7672021-04-09 08:21:17 -050027 default: infinity
James Feist8a3b49d2018-01-22 16:11:43 -080028 description: >
29 The Maximum supported sensor reading.
30 - name: MinValue
James Feist4ec65872018-07-31 11:00:25 -070031 type: double
Patrick Williams5d0b7672021-04-09 08:21:17 -050032 default: -infinity
James Feist8a3b49d2018-01-22 16:11:43 -080033 description: >
34 The Minimum supported sensor reading.
Brad Bishop45387d62016-11-10 21:58:58 -060035 - name: Unit
36 type: enum[self.Unit]
37 description: >
Patrick Venture573f1822017-11-08 10:18:18 -080038 The unit of the reading. Immutable once set for a sensor.
Brad Bishop45387d62016-11-10 21:58:58 -060039 For objects in the temperature namespace, Unit must be "DegreesC".
40 For objects in the fan_tach namespace, Unit must be "RPMS".
41 For objects in the voltage namespace, Unit must be "Volts".
42 For objects in the altitude namespace, Unit must be "Meters".
Brad Bishop6c4e2e92016-12-28 13:38:31 -050043 For objects in the current namespace, Unit must be "Amperes".
44 For objects in the power namespace, Unit must be "Watts".
45 For objects in the energy namespace, Unit must be "Joules".
Adrian Ambrożewiczff697932020-05-11 11:46:50 +020046 For objects in the utilization namespace, Unit must be "Percent"
Igor Kononenkof9d1af62020-09-17 13:37:52 +030047 For objects in the airflow namespace, Unit must be "CFM"
Brad Bishop45387d62016-11-10 21:58:58 -060048
49enumerations:
50 - name: Unit
51 description: >
52 A sensor reading unit.
53 values:
54 - name: DegreesC
55 description: >
56 Temperature as degrees Celsius.
57 - name: RPMS
58 description: >
59 Frequency of rotation as revolutions per minute.
60 - name: Volts
61 description: >
62 Electomotive force as volts.
63 - name: Meters
64 description: >
65 Length as meters.
Brad Bishop6c4e2e92016-12-28 13:38:31 -050066 - name: Amperes
67 description: >
68 Electrical charge flow rate as Amperes.
69 - name: Watts
70 description: >
71 Rate of energy transfer as Watts.
72 - name: Joules
73 description: >
74 Energy transfer as Joules.
Adrian Ambrożewiczff697932020-05-11 11:46:50 +020075 - name: Percent
76 description: >
77 Resource utilization as percentage.
Igor Kononenkof9d1af62020-09-17 13:37:52 +030078 - name: CFM
79 description: >
80 To calculate Air Flow in Cubic Feet per Minute