| Jagpal Singh Gill | 0a32d1a | 2025-08-04 19:32:16 -0700 | [diff] [blame] | 1 | description: > |
| 2 | Implement to provide a valve control interface to open/close a valve. |
| 3 | |
| 4 | Any service implementing this interface must also implement |
| 5 | the xyz.openbmc_project.Sensors.Value interface to show valve's open status |
| 6 | in percentage units. |
| 7 | |
| 8 | properties: |
| 9 | - name: State |
| 10 | type: enum[self.State] |
| 11 | description: > |
| 12 | This indicates the property used to open or close the valve. |
| 13 | |
| 14 | enumerations: |
| 15 | - name: State |
| 16 | description: > |
| 17 | This indicates which status should be configured for the valve. |
| 18 | values: |
| 19 | - name: Open |
| 20 | description: > |
| 21 | This indicates the valve should be opened. |
| 22 | - name: Close |
| 23 | description: > |
| 24 | This indicates the valve should be closed. |
| 25 | |
| 26 | associations: |
| 27 | - name: controlling |
| 28 | description: > |
| 29 | A valve control interface can optionally implement the 'controlling' |
| 30 | association to provide link to the inventory item being controlled by |
| 31 | it. |
| 32 | reverse_name: controlled_by |
| 33 | required_endpoint_interfaces: |
| 34 | - xyz.openbmc_project.Inventory.Item.Valve |
| 35 | |
| 36 | paths: |
| 37 | - namespace: /xyz/openbmc_project/control/valve |