Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 1 | description: > |
| 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 Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 10 | current |
| 11 | power |
| 12 | energy |
Adrian Ambrożewicz | ff69793 | 2020-05-11 11:46:50 +0200 | [diff] [blame] | 13 | utilization |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 14 | |
| 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 | |
| 20 | properties: |
| 21 | - name: Value |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 22 | type: double |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 23 | description: > |
| 24 | The sensor reading. |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 25 | - name: MaxValue |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 26 | type: double |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 27 | description: > |
| 28 | The Maximum supported sensor reading. |
| 29 | - name: MinValue |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 30 | type: double |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 31 | description: > |
| 32 | The Minimum supported sensor reading. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 33 | - name: Unit |
| 34 | type: enum[self.Unit] |
| 35 | description: > |
Patrick Venture | 573f182 | 2017-11-08 10:18:18 -0800 | [diff] [blame] | 36 | The unit of the reading. Immutable once set for a sensor. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 37 | For objects in the temperature namespace, Unit must be "DegreesC". |
| 38 | For objects in the fan_tach namespace, Unit must be "RPMS". |
| 39 | For objects in the voltage namespace, Unit must be "Volts". |
| 40 | For objects in the altitude namespace, Unit must be "Meters". |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 41 | For objects in the current namespace, Unit must be "Amperes". |
| 42 | For objects in the power namespace, Unit must be "Watts". |
| 43 | For objects in the energy namespace, Unit must be "Joules". |
Adrian Ambrożewicz | ff69793 | 2020-05-11 11:46:50 +0200 | [diff] [blame] | 44 | For objects in the utilization namespace, Unit must be "Percent" |
Igor Kononenko | f9d1af6 | 2020-09-17 13:37:52 +0300 | [diff] [blame^] | 45 | For objects in the airflow namespace, Unit must be "CFM" |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 46 | |
| 47 | enumerations: |
| 48 | - name: Unit |
| 49 | description: > |
| 50 | A sensor reading unit. |
| 51 | values: |
| 52 | - name: DegreesC |
| 53 | description: > |
| 54 | Temperature as degrees Celsius. |
| 55 | - name: RPMS |
| 56 | description: > |
| 57 | Frequency of rotation as revolutions per minute. |
| 58 | - name: Volts |
| 59 | description: > |
| 60 | Electomotive force as volts. |
| 61 | - name: Meters |
| 62 | description: > |
| 63 | Length as meters. |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 64 | - name: Amperes |
| 65 | description: > |
| 66 | Electrical charge flow rate as Amperes. |
| 67 | - name: Watts |
| 68 | description: > |
| 69 | Rate of energy transfer as Watts. |
| 70 | - name: Joules |
| 71 | description: > |
| 72 | Energy transfer as Joules. |
Adrian Ambrożewicz | ff69793 | 2020-05-11 11:46:50 +0200 | [diff] [blame] | 73 | - name: Percent |
| 74 | description: > |
| 75 | Resource utilization as percentage. |
Igor Kononenko | f9d1af6 | 2020-09-17 13:37:52 +0300 | [diff] [blame^] | 76 | - name: CFM |
| 77 | description: > |
| 78 | To calculate Air Flow in Cubic Feet per Minute |