diff options
| author | Patrick Venture <venture@google.com> | 2019-06-26 08:47:10 -0700 |
|---|---|---|
| committer | Patrick Venture <venture@google.com> | 2019-06-26 08:47:10 -0700 |
| commit | e7f4a5d5c93b8ee7e91351c6f7c3e66f03cb40f5 (patch) | |
| tree | 75e16f19c0f3118d2bd660c895179ef8da61aef3 /configure.md | |
| parent | 55845439f3a34b205420d6bf0e7ef0baf44e14df (diff) | |
| download | phosphor-pid-control-e7f4a5d5c93b8ee7e91351c6f7c3e66f03cb40f5.tar.gz phosphor-pid-control-e7f4a5d5c93b8ee7e91351c6f7c3e66f03cb40f5.zip | |
README: configure: fixup markdown
The tool used to write this implemented features not available in the
makrdown used by github. Therefore, this removes those features.
Signed-off-by: Patrick Venture <venture@google.com>
Change-Id: I3a3eed1c8f298fe88f0ddbcb43aa897ec4d6f623
Diffstat (limited to 'configure.md')
| -rw-r--r-- | configure.md | 27 |
1 files changed, 8 insertions, 19 deletions
diff --git a/configure.md b/configure.md index c6431ca..a027282 100644 --- a/configure.md +++ b/configure.md @@ -134,13 +134,8 @@ Each zone has its own fields, and a list of PIDs. | field | type | meaning | | ------------------ | --------- | ----------------------------------------- | | `id` | `int64_t` | This is a unique identifier for the zone. | -| `minThermalOutput` | `double` | This is the minimum value that should be | -: : : considered from the thermal outputs. : -: : : Commonly used as the minimum fan RPM. : -| `failsafePercent` | `double` | If there is a fan PID, it will use this | -: : : value if the zone goes into fail-safe as : -: : : the output value written to the fan's : -: : : sensors. : +| `minThermalOutput` | `double` | This is the minimum value that should be considered from the thermal outputs. Commonly used as the minimum fan RPM.| +| `failsafePercent` | `double` | If there is a fan PID, it will use this value if the zone goes into fail-safe as the output value written to the fan's sensors.| The `id` field here is used in the d-bus path to talk to the `xyz.openbmc_project.Control.Mode` interface. @@ -175,8 +170,7 @@ If the PID `type` is not `stepwise` then the PID field is defined as follows: | field | type | meaning | | -------------------- | -------- | ----------------------------------------- | -| `samplePeriod` | `double` | How frequently the value is sampled. 0.1 | -: : : for fans, 1.0 for temperatures. : +| `samplePeriod` | `double` | How frequently the value is sampled. 0.1 for fans, 1.0 for temperatures.| | `proportionalCoeff` | `double` | The proportional coefficient. | | `integralCoeff` | `double` | The integral coefficient. | | `feedFwdOffsetCoeff` | `double` | The feed forward offset coefficient. | @@ -217,11 +211,9 @@ The type `fan` builds a `FanController` PID. | field | type | meaning | | ---------- | ----------------- | ------------------------------------------- | -| `name` | `string` | The name of the PID. This is just for | -: : : humans and logging. : +| `name` | `string` | The name of the PID. This is just for humans and logging.| | `type` | `string` | `fan` | -| `inputs` | `list of strings` | The names of the sensor(s) that are used as | -: : : input and output for the PID loop. : +| `inputs` | `list of strings` | The names of the sensor(s) that are used as input and output for the PID loop.| | `setpoint` | `double` | Presently UNUSED | | `pid` | `dictionary` | A PID dictionary detailed above. | @@ -245,13 +237,10 @@ The type `margin` builds a `ThermalController` PID. | field | type | meaning | | ---------- | ----------------- | ------------------------------------------- | -| `name` | `string` | The name of the PID. This is just for | -: : : humans and logging. : +| `name` | `string` | The name of the PID. This is just for humans and logging.| | `type` | `string` | `margin` | -| `inputs` | `list of strings` | The names of the sensor(s) that are used as | -: : : input for the PID loop. : -| `setpoint` | `double` | The setpoint value for the thermal PID. The | -: : : setpoint for the margin sensors. : +| `inputs` | `list of strings` | The names of the sensor(s) that are used as input for the PID loop.| +| `setpoint` | `double` | The setpoint value for the thermal PID. The setpoint for the margin sensors.| | `pid` | `dictionary` | A PID dictionary detailed above. | The output of a `margin` PID loop is that it sets the setpoint value for the |
