Gitiles
Code Review Sign In
gerrit.openbmc.org / openbmc / entity-manager / a6686e5210b3cb4417dfd3b7aca1aa65de48668e / . / schemas / pid.json
blob: 9e6ae71d2a233dd6b817bed2f69c95fd6e2efbf0 [file] [log] [blame]
James Feist68500ff2018-08-08 15:40:42 -0700[diff] [blame]1{
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]2 "$schema": "http://json-schema.org/draft-07/schema#",
Patrick Williams7d6080d2024-09-04 12:54:45 -0400[diff] [blame]3 "$defs": {
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]4 "Pid": {
Alexander Hansen3b7d5cf2025-04-16 16:59:46 +0200[diff] [blame]5 "additionalProperties": false,
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]6 "type": "object",
7 "properties": {
Delphine CC Chiu56754962024-05-22 09:28:50 +0800[diff] [blame]8 "CheckHysteresisWithSetpoint": {
9 "type": "boolean"
10 },
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]11 "Class": {
12 "type": "string"
13 },
Bonnie Lo53172a62022-12-06 13:52:15 +0800[diff] [blame]14 "DCoefficient": {
15 "type": "number"
16 },
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]17 "FFGainCoefficient": {
18 "type": "number"
19 },
20 "FFOffCoefficient": {
21 "type": "number"
22 },
23 "ICoefficient": {
24 "type": "number"
25 },
26 "ILimitMax": {
27 "type": "number"
28 },
29 "ILimitMin": {
30 "type": "number"
31 },
32 "Inputs": {
33 "type": "array",
34 "items": {
35 "type": "string"
36 }
37 },
Josh Lehanaca73882023-02-21 23:59:54 -0800[diff] [blame]38 "InputUnavailableAsFailed": {
39 "type": "boolean"
40 },
41 "MissingIsAcceptable": {
42 "type": "array",
43 "items": {
44 "type": "string"
45 }
46 },
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]47 "Name": {
48 "type": "string"
49 },
Josh Lehan0422a242023-02-22 00:23:58 -0800[diff] [blame]50 "NegativeHysteresis": {
51 "type": "number"
52 },
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]53 "OutLimitMax": {
54 "type": "number"
55 },
56 "OutLimitMin": {
57 "type": "number"
58 },
59 "Outputs": {
60 "type": "array",
61 "items": {
62 "type": "string"
63 }
64 },
65 "PCoefficient": {
66 "type": "number"
67 },
Josh Lehan0422a242023-02-22 00:23:58 -0800[diff] [blame]68 "PositiveHysteresis": {
69 "type": "number"
70 },
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]71 "Profiles": {
72 "type": "array",
73 "items": {
74 "type": "string"
75 }
76 },
77 "SlewNeg": {
78 "type": "number"
79 },
80 "SlewPos": {
81 "type": "number"
82 },
Josh Lehanaca73882023-02-21 23:59:54 -0800[diff] [blame]83 "TempToMargin": {
84 "type": "array",
85 "items": {
86 "type": "number"
87 }
88 },
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]89 "Type": {
Alexander Hansen3b7d5cf2025-04-16 16:59:46 +0200[diff] [blame]90 "const": "Pid"
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]91 },
92 "Zones": {
93 "type": "array",
94 "items": {
95 "type": "string"
96 }
97 },
98 "SetPoint": {
99 "type": "number"
100 },
101 "SetPointOffset": {
102 "type": "string"
Alexander Hansen3b7d5cf2025-04-16 16:59:46 +0200[diff] [blame]103 },
104 "samplePeriod": {
105 "type": "number",
106 "minimum": 0
107 },
108 "FailSafePercent": {
109 "type": "number",
110 "minimum": 0,
111 "maximum": 100
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]112 }
113 },
114 "required": [
115 "Class",
116 "FFGainCoefficient",
117 "FFOffCoefficient",
118 "ICoefficient",
119 "ILimitMax",
120 "ILimitMin",
121 "Inputs",
122 "Name",
123 "OutLimitMax",
124 "OutLimitMin",
125 "PCoefficient",
126 "SlewNeg",
127 "SlewPos",
128 "Type",
129 "Zones"
130 ]
James Feist68500ff2018-08-08 15:40:42 -0700[diff] [blame]131 }
Brad Bishop4fa1d392020-05-07 20:27:15 -0400[diff] [blame]132 }
James Feist68500ff2018-08-08 15:40:42 -0700[diff] [blame]133}