xref: /openbmc/phosphor-dbus-interfaces/yaml/xyz/openbmc_project/Control/Valve.interface.yaml (revision 0a32d1a9e2d45074477253719e0d6333419a63a3)
1*0a32d1a9SJagpal Singh Gilldescription: >
2*0a32d1a9SJagpal Singh Gill    Implement to provide a valve control interface to open/close a valve.
3*0a32d1a9SJagpal Singh Gill
4*0a32d1a9SJagpal Singh Gill    Any service implementing this interface must also implement
5*0a32d1a9SJagpal Singh Gill    the  xyz.openbmc_project.Sensors.Value interface to show valve's open status
6*0a32d1a9SJagpal Singh Gill    in percentage units.
7*0a32d1a9SJagpal Singh Gill
8*0a32d1a9SJagpal Singh Gillproperties:
9*0a32d1a9SJagpal Singh Gill    - name: State
10*0a32d1a9SJagpal Singh Gill      type: enum[self.State]
11*0a32d1a9SJagpal Singh Gill      description: >
12*0a32d1a9SJagpal Singh Gill          This indicates the property used to open or close the valve.
13*0a32d1a9SJagpal Singh Gill
14*0a32d1a9SJagpal Singh Gillenumerations:
15*0a32d1a9SJagpal Singh Gill    - name: State
16*0a32d1a9SJagpal Singh Gill      description: >
17*0a32d1a9SJagpal Singh Gill          This indicates which status should be configured for the valve.
18*0a32d1a9SJagpal Singh Gill      values:
19*0a32d1a9SJagpal Singh Gill          - name: Open
20*0a32d1a9SJagpal Singh Gill            description: >
21*0a32d1a9SJagpal Singh Gill                This indicates the valve should be opened.
22*0a32d1a9SJagpal Singh Gill          - name: Close
23*0a32d1a9SJagpal Singh Gill            description: >
24*0a32d1a9SJagpal Singh Gill                This indicates the valve should be closed.
25*0a32d1a9SJagpal Singh Gill
26*0a32d1a9SJagpal Singh Gillassociations:
27*0a32d1a9SJagpal Singh Gill    - name: controlling
28*0a32d1a9SJagpal Singh Gill      description: >
29*0a32d1a9SJagpal Singh Gill          A valve control interface can optionally implement the 'controlling'
30*0a32d1a9SJagpal Singh Gill          association to provide link to the inventory item being controlled by
31*0a32d1a9SJagpal Singh Gill          it.
32*0a32d1a9SJagpal Singh Gill      reverse_name: controlled_by
33*0a32d1a9SJagpal Singh Gill      required_endpoint_interfaces:
34*0a32d1a9SJagpal Singh Gill          - xyz.openbmc_project.Inventory.Item.Valve
35*0a32d1a9SJagpal Singh Gill
36*0a32d1a9SJagpal Singh Gillpaths:
37*0a32d1a9SJagpal Singh Gill    - namespace: /xyz/openbmc_project/control/valve
38