Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 1 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 2 | Implement to provide sensor readings. Objects implementing Sensor.Value |
| 3 | must be instantiated in the correct hierarchy within the sensors |
| 4 | namespace. The following sensor hierarchies are recognized: |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 5 | airflow |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 6 | altitude |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 7 | current |
Brad Bishop | 6c4e2e9 | 2016-12-28 13:38:31 -0500 | [diff] [blame] | 8 | energy |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 9 | fan_tach |
Patrick Williams | 1bcf7fa | 2021-12-22 09:14:37 -0600 | [diff] [blame] | 10 | humidity |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 11 | power |
Bruce Mitchell | 69d821b | 2021-06-02 19:17:06 -0500 | [diff] [blame] | 12 | pressure |
Patrick Williams | d5f3635 | 2021-12-22 09:13:27 -0600 | [diff] [blame] | 13 | temperature |
| 14 | utilization |
| 15 | voltage |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 16 | |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 17 | Any service implementing Sensor.Value on one or more objects must implement |
| 18 | org.freedesktop.DBus.ObjectManager on /xyz/openbmc_project/sensors. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 19 | |
| 20 | All Sensor.Value properties are read-only. |
| 21 | |
| 22 | properties: |
| 23 | - name: Value |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 24 | type: double |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 25 | description: > |
| 26 | The sensor reading. |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 27 | - name: MaxValue |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 28 | type: double |
Patrick Williams | 5d0b767 | 2021-04-09 08:21:17 -0500 | [diff] [blame] | 29 | default: infinity |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 30 | description: > |
| 31 | The Maximum supported sensor reading. |
| 32 | - name: MinValue |
James Feist | 4ec6587 | 2018-07-31 11:00:25 -0700 | [diff] [blame] | 33 | type: double |
Patrick Williams | 5d0b767 | 2021-04-09 08:21:17 -0500 | [diff] [blame] | 34 | default: -infinity |
James Feist | 8a3b49d | 2018-01-22 16:11:43 -0800 | [diff] [blame] | 35 | description: > |
| 36 | The Minimum supported sensor reading. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 37 | - name: Unit |
| 38 | type: enum[self.Unit] |
| 39 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 40 | The unit of the reading. Immutable once set for a sensor. For objects |
| 41 | in the airflow namespace, Unit must be "CFM" For objects in the |
| 42 | altitude namespace, Unit must be "Meters". For objects in the current |
| 43 | namespace, Unit must be "Amperes". For objects in the energy |
| 44 | namespace, Unit must be "Joules". For objects in the fan_tach |
| 45 | namespace, Unit must be "RPMS". For objects in the humidity namespace, |
| 46 | Unit must be "PercentRH" For objects in the power namespace, Unit must |
| 47 | be "Watts". For objects in the pressure namespace, Unit must be |
| 48 | "Pascals" For objects in the temperature namespace, Unit must be |
| 49 | "DegreesC". For objects in the utilization namespace, Unit must be |
| 50 | "Percent" For objects in the voltage namespace, Unit must be "Volts". |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 51 | |
| 52 | enumerations: |
| 53 | - name: Unit |
| 54 | description: > |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 55 | A sensor reading unit. |
Brad Bishop | 45387d6 | 2016-11-10 21:58:58 -0600 | [diff] [blame] | 56 | values: |
Patrick Williams | 8da396c | 2022-03-14 14:21:02 -0500 | [diff] [blame] | 57 | - name: Amperes |
| 58 | description: > |
| 59 | Electrical charge flow rate as Amperes. |
| 60 | - name: CFM |
| 61 | description: > |
| 62 | To calculate Air Flow in Cubic Feet per Minute |
| 63 | - name: DegreesC |
| 64 | description: > |
| 65 | Temperature as degrees Celsius. |
| 66 | - name: Joules |
| 67 | description: > |
| 68 | Energy transfer as Joules. |
| 69 | - name: Meters |
| 70 | description: > |
| 71 | Length as meters. |
| 72 | - name: Percent |
| 73 | description: > |
| 74 | Resource utilization as a percentage. |
| 75 | - name: PercentRH |
| 76 | description: > |
| 77 | Relative humidity as a percentage. |
| 78 | - name: Pascals |
| 79 | description: > |
| 80 | Pressure as pascals. |
| 81 | - name: RPMS |
| 82 | description: > |
| 83 | Frequency of rotation as revolutions per minute. |
| 84 | - name: Volts |
| 85 | description: > |
| 86 | Electomotive force as volts. |
| 87 | - name: Watts |
| 88 | description: > |
| 89 | Rate of energy transfer as Watts. |
Shounak Mitra | d4fad16 | 2022-08-08 21:53:41 +0000 | [diff] [blame] | 90 | |
| 91 | associations: |
| 92 | - name: inventory |
| 93 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 94 | Sensors may implement an 'inventory' to 'sensors' association with the |
| 95 | inventory item related to it. |
Shounak Mitra | d4fad16 | 2022-08-08 21:53:41 +0000 | [diff] [blame] | 96 | reverse_names: |
| 97 | - sensors |
| 98 | required_endpoint_interfaces: |
Sui Chen | fc5546e | 2022-10-25 15:52:03 -0700 | [diff] [blame] | 99 | - xyz.openbmc_project.Inventory.Item |
| 100 | - name: monitoring |
| 101 | description: > |
Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame] | 102 | Sensors may monitor the BMC's resource utilization and implement an |
Patrick Williams | c29c927 | 2023-08-17 09:56:38 -0500 | [diff] [blame] | 103 | association to the Bmc item. |
Sui Chen | fc5546e | 2022-10-25 15:52:03 -0700 | [diff] [blame] | 104 | reverse_names: |
| 105 | - monitored_by |
| 106 | required_endpoint_interfaces: |
| 107 | - xyz.openbmc_project.Inventory.Item.Bmc |
Patrick Williams | 1bb6961 | 2024-01-20 10:20:07 -0600 | [diff] [blame] | 108 | |
| 109 | paths: |
| 110 | - namespace: /xyz/openbmc_project/sensors |
| 111 | segments: |
| 112 | - name: Airflow |
| 113 | value: airflow |
| 114 | - name: Altitude |
| 115 | value: altitude |
| 116 | - name: Current |
| 117 | value: current |
| 118 | - name: Energy |
| 119 | value: energy |
| 120 | - name: FanTach |
| 121 | value: fan_tach |
| 122 | - name: Humidity |
| 123 | value: humidity |
| 124 | - name: Power |
| 125 | value: power |
| 126 | - name: Pressure |
| 127 | value: pressure |
| 128 | - name: Temperature |
| 129 | value: temperature |
| 130 | - name: Utilization |
| 131 | value: utilization |
| 132 | - name: Voltage |
| 133 | value: voltage |