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: |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 6 | airflow |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 7 | altitude |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 8 | current |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 9 | energy |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 10 | fan_tach |
Patrick Williams | 1bcf7fa | 2021-12-22 09:14:37 -0600 | [diff] [blame] | 11 | humidity |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 12 | power |
Bruce Mitchell | 69d821b | 2021-06-02 19:17:06 -0500 | [diff] [blame] | 13 | pressure |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 14 | temperature |
| 15 | utilization |
| 16 | voltage |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 17 | |
| 18 | Any service implementing Sensor.Value on one or more objects must |
| 19 | implement org.freedesktop.DBus.ObjectManager on the sensors namespace root. |
| 20 | |
| 21 | All Sensor.Value properties are read-only. |
| 22 | |
| 23 | properties: |
| 24 | - name: Value |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 25 | type: double |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 26 | description: > |
| 27 | The sensor reading. |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 28 | - name: MaxValue |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 29 | type: double |
Patrick Williams | 5d0b767 | 2021-04-09 08:21:17 -0500 | [diff] [blame] | 30 | default: infinity |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 31 | description: > |
| 32 | The Maximum supported sensor reading. |
| 33 | - name: MinValue |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 34 | type: double |
Patrick Williams | 5d0b767 | 2021-04-09 08:21:17 -0500 | [diff] [blame] | 35 | default: -infinity |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 36 | description: > |
| 37 | The Minimum supported sensor reading. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 38 | - name: Unit |
| 39 | type: enum[self.Unit] |
| 40 | description: > |
Patrick Venture | 573f182 | 2017-11-08 10:18:18 -0800 | [diff] [blame] | 41 | The unit of the reading. Immutable once set for a sensor. |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 42 | For objects in the airflow namespace, Unit must be "CFM" |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 43 | For objects in the altitude namespace, Unit must be "Meters". |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 44 | For objects in the current namespace, Unit must be "Amperes". |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 45 | For objects in the energy namespace, Unit must be "Joules". |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 46 | For objects in the fan_tach namespace, Unit must be "RPMS". |
Patrick Williams | 1bcf7fa | 2021-12-22 09:14:37 -0600 | [diff] [blame] | 47 | For objects in the humidity namespace, Unit must be "PercentRH" |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 48 | For objects in the power namespace, Unit must be "Watts". |
Bruce Mitchell | 69d821b | 2021-06-02 19:17:06 -0500 | [diff] [blame] | 49 | For objects in the pressure namespace, Unit must be "Pascals" |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 50 | For objects in the temperature namespace, Unit must be "DegreesC". |
| 51 | For objects in the utilization namespace, Unit must be "Percent" |
| 52 | For objects in the voltage namespace, Unit must be "Volts". |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 53 | |
| 54 | enumerations: |
| 55 | - name: Unit |
| 56 | description: > |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 57 | A sensor reading unit. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 58 | values: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 59 | - name: Amperes |
| 60 | description: > |
| 61 | Electrical charge flow rate as Amperes. |
| 62 | - name: CFM |
| 63 | description: > |
| 64 | To calculate Air Flow in Cubic Feet per Minute |
| 65 | - name: DegreesC |
| 66 | description: > |
| 67 | Temperature as degrees Celsius. |
| 68 | - name: Joules |
| 69 | description: > |
| 70 | Energy transfer as Joules. |
| 71 | - name: Meters |
| 72 | description: > |
| 73 | Length as meters. |
| 74 | - name: Percent |
| 75 | description: > |
| 76 | Resource utilization as a percentage. |
| 77 | - name: PercentRH |
| 78 | description: > |
| 79 | Relative humidity as a percentage. |
| 80 | - name: Pascals |
| 81 | description: > |
| 82 | Pressure as pascals. |
| 83 | - name: RPMS |
| 84 | description: > |
| 85 | Frequency of rotation as revolutions per minute. |
| 86 | - name: Volts |
| 87 | description: > |
| 88 | Electomotive force as volts. |
| 89 | - name: Watts |
| 90 | description: > |
| 91 | Rate of energy transfer as Watts. |