xref: /openbmc/entity-manager/schemas/valve.json (revision 86780aa23e01a4215314f067b139d01fa0b320d0) 
1{
2    "$schema": "http://json-schema.org/draft-07/schema#",
3    "$defs": {
4        "GPIOValve": {
5            "additionalProperties": false,
6            "description": "Configuration for GPIO based Valve.",
7            "type": "object",
8            "properties": {
9                "Name": {
10                    "description": "The name of the valve.",
11                    "type": "string"
12                },
13                "Type": {
14                    "description": "The type of configuration object",
15                    "const": "GPIOValve"
16                },
17                "OpenPinName": {
18                    "description": "The name of the GPIO pin that shows the valve's open status.",
19                    "type": "string"
20                },
21                "OpenPolarity": {
22                    "description": "The GPIO polarity depicting valve's open status.",
23                    "$ref": "legacy.json#/$defs/Types/Polarity"
24                },
25                "OpenControlPinName": {
26                    "description": "The name of the GPIO pin that controls opening the valve.",
27                    "type": "string"
28                },
29                "OpenControlValue": {
30                    "description": "The GPIO value to set to open the valve.",
31                    "type": "boolean"
32                },
33                "CoolantLoopName": {
34                    "description": "The name of the coolant loop to which this valve is connected.",
35                    "type": "string"
36                }
37            },
38            "required": [
39                "Name",
40                "Type",
41                "OpenPinName",
42                "OpenPolarity",
43                "OpenControlPinName",
44                "OpenControlValue",
45                "CoolantLoopName"
46            ]
47        }
48    }
49}
50