alex/GY-63_MS5611
1
0
Fork 0
mirror of https://github.com/RobTillaart/Arduino.git synced 2024-10-03 18:09:02 -04:00
Code Issues Actions Packages Projects Releases Wiki Activity
ef99b9be5f
GY-63_MS5611/libraries/PID_RT/README.md
rob tillaart d163d90937 0.1.3 PID_RT
2021-11-12 13:52:09 +01:00

3.4 KiB
Raw Blame History

Arduino CI Arduino-lint JSON check License: MIT GitHub release

PID_RT

Arduino library for PID controller.

Description

The PID_RT class allows the user to instantiate a PID controller.

Interface

Constructor

  • PID_RT() minimal constructor.
  • PID_RT(float sp, float Kp, float Ki, float Kd) constructor that sets minimal parameters to get started.

Core

  • void reset() resets internals to startup.
  • void setPoint(float sp) sets setPoint, that needs to be reached.
  • float getSetPoint() read back setPoint.
  • bool compute(float input) does one iteration of the PID controller. Returns true after calculation. Returns false if not computed, either due to stop flag or not yet time to do the calculation.
  • float getOutput() get the last calculated output value.
  • bool setK(float Kp, float Ki, float Kd) Set the initial P I D parameters as a group. Overwrites the values set in the constructor.

Start Stop

  • void start() enable the PID controller to compute() new output values.
  • void stop() disable the PID controller, see compute().
  • bool isRunning() return the enable/disable flag.

Additional parameters

  • bool setInterval(uint32_t interval) set the interval between two compute() calls. Returns true if changed, otherwise false.
  • uint32_t getInterval() read back interval set.
  • void setOutputRange(float rangeMin, float rangeMax) tune the output range, default 0..100
  • float getOutputMin() read back setting rangeMin.
  • float getOutputMax() read back setting rangeMax.
  • void setReverse(bool reverse) reverse behaviour, seldom needed.
  • bool getReverse() read back the setting.
  • bool setKp(float Kp) runtime updates are allowed - at your own risk.
  • bool setKi(float Ki) runtime updates are allowed - at your own risk.
  • bool setKd(float Kd) runtime updates are allowed - at your own risk.
  • float getKp() read back setting.
  • float getKi() read back setting.
  • float getKd() read back setting.
  • void setPropOnInput() this is default behaviour.
  • void setPropOnError() alternative.
  • bool isPropOnInput() read back setting.
  • bool isPropOnError() read back setting.

debugging calls

  • float getInput() read last input.
  • float getLastError() read the last error.
  • uint32_t getLastTime() get the last time compute() was called. Note this value is incremented with Interval every iteration so it may have some offset of the actual time. This is chosen as this way it is almost sure that no iterations are missed.

Operations

See examples.

Future

  • update documentation
  • add examples to test more
  • improve unit test