| Brad Bishop | a948d26 | 2016-10-05 19:51:48 -0400 | [diff] [blame] | 1 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 2 | Implement to provide basic item attributes. Required by all objects within |
| 3 | the inventory namespace. |
| Ed Tanous | fd26ad1 | 2022-07-12 15:20:26 -0700 | [diff] [blame] | 4 | |
| 5 | Any service implementing Inventory.Item on one or more objects must |
| 6 | implement org.freedesktop.DBus.ObjectManager on |
| 7 | /xyz/openbmc_project/inventory. |
| 8 | |
| Brad Bishop | a948d26 | 2016-10-05 19:51:48 -0400 | [diff] [blame] | 9 | properties: |
| 10 | - name: PrettyName |
| Deepak Kodihalli | 1542bae | 2016-11-09 05:23:39 -0600 | [diff] [blame] | 11 | type: string |
| Brad Bishop | a948d26 | 2016-10-05 19:51:48 -0400 | [diff] [blame] | 12 | description: > |
| 13 | The human readable name of the item. |
| 14 | - name: Present |
| Deepak Kodihalli | 1542bae | 2016-11-09 05:23:39 -0600 | [diff] [blame] | 15 | type: boolean |
| Brad Bishop | a948d26 | 2016-10-05 19:51:48 -0400 | [diff] [blame] | 16 | description: > |
| 17 | Whether or not the item is present. |
| Shounak Mitra | d4fad16 | 2022-08-08 21:53:41 +0000 | [diff] [blame] | 18 | |
| 19 | associations: |
| Benjamin Fair | 36b527a | 2022-11-02 20:41:21 +0000 | [diff] [blame] | 20 | - name: containing |
| 21 | description: > |
| 22 | Any inventory Items (usually Boards or Chassis) can optionally |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 23 | implement the 'containing' association to provide one or more links to |
| 24 | Items which it physically contains. |
| Benjamin Fair | 36b527a | 2022-11-02 20:41:21 +0000 | [diff] [blame] | 25 | reverse_name: contained_by |
| 26 | required_endpoint_interfaces: |
| 27 | - xyz.openbmc_project.Inventory.Item |
| 28 | - name: contained_by |
| 29 | description: > |
| 30 | Any inventory Items can optionally implement the 'contained_by' |
| 31 | association to provide a link to exactly one Item (usually a Board or |
| 32 | Chassis) which physically contains it. |
| 33 | reverse_name: containing |
| 34 | required_endpoint_interfaces: |
| 35 | - xyz.openbmc_project.Inventory.Item |
| Shounak Mitra | d4fad16 | 2022-08-08 21:53:41 +0000 | [diff] [blame] | 36 | - name: sensors |
| 37 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 38 | Sensors may implement an 'inventory' to 'sensors' association with the |
| 39 | inventory item related to it. |
| Shounak Mitra | d4fad16 | 2022-08-08 21:53:41 +0000 | [diff] [blame] | 40 | reverse_names: |
| 41 | - inventory |
| 42 | required_endpoint_interfaces: |
| Benjamin Fair | 36b527a | 2022-11-02 20:41:21 +0000 | [diff] [blame] | 43 | - xyz.openbmc_project.Sensor.Value |
| George Liu | d0aa13b | 2022-10-31 14:17:32 +0800 | [diff] [blame] | 44 | - name: cooled_by |
| 45 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 46 | Objects that implement Item can optionally implement the 'cooled_by' |
| 47 | association to provide a link to one or more fans. |
| George Liu | d0aa13b | 2022-10-31 14:17:32 +0800 | [diff] [blame] | 48 | reverse_name: cooling |
| 49 | required_endpoint_interfaces: |
| 50 | - xyz.openbmc_project.Inventory.Item.Fan |
| George Liu | 9eb460c | 2022-10-31 13:59:26 +0800 | [diff] [blame] | 51 | - name: identified_by |
| 52 | description: > |
| 53 | Objects that implement Item can optionally implement the |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 54 | 'identified_by' association to provide a link to one or more LED |
| 55 | Groups. |
| George Liu | 9eb460c | 2022-10-31 13:59:26 +0800 | [diff] [blame] | 56 | reverse_name: identifying |
| 57 | required_endpoint_interfaces: |
| 58 | - xyz.openbmc_project.Led.Group |
| George Liu | e7c10bd | 2022-11-03 21:12:53 +0800 | [diff] [blame] | 59 | - name: fault_identified_by |
| 60 | description: > |
| 61 | Objects that implement Item can optionally implement the |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 62 | 'fault_identified_by' association to provide a link to one or more LED |
| 63 | Groups. |
| George Liu | e7c10bd | 2022-11-03 21:12:53 +0800 | [diff] [blame] | 64 | reverse_name: fault_identifying |
| 65 | required_endpoint_interfaces: |
| 66 | - xyz.openbmc_project.Led.Group |
| George Liu | 380bb02 | 2022-11-10 08:31:25 +0800 | [diff] [blame] | 67 | - name: powered_by |
| 68 | description: > |
| Patrick Williams | a134741 | 2022-12-06 10:56:22 -0600 | [diff] [blame^] | 69 | Objects that implement Item can optionally implement the 'powered_by' |
| 70 | association to provide a link to one or more power supplies. |
| George Liu | 380bb02 | 2022-11-10 08:31:25 +0800 | [diff] [blame] | 71 | reverse_name: powering |
| 72 | required_endpoint_interfaces: |
| 73 | - xyz.openbmc_project.Inventory.Item.PowerSupply |