xref: /openbmc/entity-manager/schemas/pid.json (revision 5675496d)
1{
2    "$schema": "http://json-schema.org/draft-07/schema#",
3    "definitions": {
4        "Pid": {
5            "type": "object",
6            "properties": {
7                "CheckHysteresisWithSetpoint": {
8                    "type": "boolean"
9                },
10                "Class": {
11                    "type": "string"
12                },
13                "DCoefficient": {
14                    "type": "number"
15                },
16                "FFGainCoefficient": {
17                    "type": "number"
18                },
19                "FFOffCoefficient": {
20                    "type": "number"
21                },
22                "ICoefficient": {
23                    "type": "number"
24                },
25                "ILimitMax": {
26                    "type": "number"
27                },
28                "ILimitMin": {
29                    "type": "number"
30                },
31                "Inputs": {
32                    "type": "array",
33                    "items": {
34                        "type": "string"
35                    }
36                },
37                "InputUnavailableAsFailed": {
38                    "type": "boolean"
39                },
40                "MissingIsAcceptable": {
41                    "type": "array",
42                    "items": {
43                        "type": "string"
44                    }
45                },
46                "Name": {
47                    "type": "string"
48                },
49                "NegativeHysteresis": {
50                    "type": "number"
51                },
52                "OutLimitMax": {
53                    "type": "number"
54                },
55                "OutLimitMin": {
56                    "type": "number"
57                },
58                "Outputs": {
59                    "type": "array",
60                    "items": {
61                        "type": "string"
62                    }
63                },
64                "PCoefficient": {
65                    "type": "number"
66                },
67                "PositiveHysteresis": {
68                    "type": "number"
69                },
70                "Profiles": {
71                    "type": "array",
72                    "items": {
73                        "type": "string"
74                    }
75                },
76                "SlewNeg": {
77                    "type": "number"
78                },
79                "SlewPos": {
80                    "type": "number"
81                },
82                "TempToMargin": {
83                    "type": "array",
84                    "items": {
85                        "type": "number"
86                    }
87                },
88                "Type": {
89                    "type": "string"
90                },
91                "Zones": {
92                    "type": "array",
93                    "items": {
94                        "type": "string"
95                    }
96                },
97                "SetPoint": {
98                    "type": "number"
99                },
100                "SetPointOffset": {
101                    "type": "string"
102                }
103            },
104            "required": [
105                "Class",
106                "FFGainCoefficient",
107                "FFOffCoefficient",
108                "ICoefficient",
109                "ILimitMax",
110                "ILimitMin",
111                "Inputs",
112                "Name",
113                "OutLimitMax",
114                "OutLimitMin",
115                "PCoefficient",
116                "SlewNeg",
117                "SlewPos",
118                "Type",
119                "Zones"
120            ]
121        }
122    }
123}
124