James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 1 | #pragma once |
| 2 | |
| 3 | #include "controller.hpp" |
| 4 | #include "ec/pid.hpp" |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 5 | |
Andrew Geissler | e30916c | 2020-05-20 21:27:05 -0500 | [diff] [blame] | 6 | #include <limits> |
Ed Tanous | f8b6e55 | 2025-06-27 13:27:50 -0700 | [diff] [blame^] | 7 | #include <string> |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 8 | |
Patrick Venture | a076487 | 2020-08-08 07:48:43 -0700 | [diff] [blame] | 9 | namespace pid_control |
| 10 | { |
| 11 | |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 12 | class ZoneInterface; |
| 13 | |
| 14 | /* |
| 15 | * Base class for PID controllers. Each PID that implements this needs to |
Patrick Venture | 563a356 | 2018-10-30 09:31:26 -0700 | [diff] [blame] | 16 | * provide an inputProc, setptProc, and outputProc. |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 17 | */ |
| 18 | class PIDController : public Controller |
| 19 | { |
| 20 | public: |
| 21 | PIDController(const std::string& id, ZoneInterface* owner) : |
Nirav Shah | ccc8bb6 | 2022-02-17 21:06:51 -0800 | [diff] [blame] | 22 | Controller(), _owner(owner), _id(id) |
Harvey Wu | 22579ca | 2022-11-07 14:53:37 +0800 | [diff] [blame] | 23 | { |
| 24 | _pid_info.initialized = false; |
Delphine CC Chiu | 9788963 | 2023-11-06 11:32:46 +0800 | [diff] [blame] | 25 | _pid_info.checkHysterWithSetpt = false; |
Harvey Wu | 22579ca | 2022-11-07 14:53:37 +0800 | [diff] [blame] | 26 | _pid_info.ts = static_cast<double>(0.0); |
| 27 | _pid_info.integral = static_cast<double>(0.0); |
| 28 | _pid_info.lastOutput = static_cast<double>(0.0); |
| 29 | _pid_info.proportionalCoeff = static_cast<double>(0.0); |
| 30 | _pid_info.integralCoeff = static_cast<double>(0.0); |
Josh Lehan | 31058fd | 2023-01-13 11:06:16 -0800 | [diff] [blame] | 31 | _pid_info.derivativeCoeff = static_cast<double>(0.0); |
Harvey Wu | 22579ca | 2022-11-07 14:53:37 +0800 | [diff] [blame] | 32 | _pid_info.feedFwdOffset = static_cast<double>(0.0); |
| 33 | _pid_info.feedFwdGain = static_cast<double>(0.0); |
| 34 | _pid_info.integralLimit.min = static_cast<double>(0.0); |
| 35 | _pid_info.integralLimit.max = static_cast<double>(0.0); |
| 36 | _pid_info.outLim.min = static_cast<double>(0.0); |
| 37 | _pid_info.outLim.max = static_cast<double>(0.0); |
| 38 | _pid_info.slewNeg = static_cast<double>(0.0); |
| 39 | _pid_info.slewPos = static_cast<double>(0.0); |
| 40 | _pid_info.negativeHysteresis = static_cast<double>(0.0); |
| 41 | _pid_info.positiveHysteresis = static_cast<double>(0.0); |
| 42 | } |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 43 | |
Ed Tanous | d2768c5 | 2025-06-26 11:42:57 -0700 | [diff] [blame] | 44 | ~PIDController() override = default; |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 45 | |
Ed Tanous | d2768c5 | 2025-06-26 11:42:57 -0700 | [diff] [blame] | 46 | double inputProc(void) override = 0; |
Patrick Venture | 5f59c0f | 2018-11-11 12:55:14 -0800 | [diff] [blame] | 47 | virtual double setptProc(void) = 0; |
Ed Tanous | d2768c5 | 2025-06-26 11:42:57 -0700 | [diff] [blame] | 48 | void outputProc(double value) override = 0; |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 49 | |
Patrick Venture | ee30648 | 2018-10-30 13:35:37 -0700 | [diff] [blame] | 50 | void process(void) override; |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 51 | |
Patrick Venture | ee30648 | 2018-10-30 13:35:37 -0700 | [diff] [blame] | 52 | std::string getID(void) override |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 53 | { |
| 54 | return _id; |
| 55 | } |
Patrick Venture | 5f59c0f | 2018-11-11 12:55:14 -0800 | [diff] [blame] | 56 | double getSetpoint(void) |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 57 | { |
| 58 | return _setpoint; |
| 59 | } |
Patrick Venture | 5f59c0f | 2018-11-11 12:55:14 -0800 | [diff] [blame] | 60 | void setSetpoint(double setpoint) |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 61 | { |
| 62 | _setpoint = setpoint; |
| 63 | } |
| 64 | |
Patrick Venture | 563a356 | 2018-10-30 09:31:26 -0700 | [diff] [blame] | 65 | ec::pid_info_t* getPIDInfo(void) |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 66 | { |
| 67 | return &_pid_info; |
| 68 | } |
| 69 | |
James Feist | 572c43d | 2019-01-31 15:52:22 -0800 | [diff] [blame] | 70 | double getLastInput(void) |
| 71 | { |
| 72 | return lastInput; |
| 73 | } |
| 74 | |
Delphine CC Chiu | 9788963 | 2023-11-06 11:32:46 +0800 | [diff] [blame] | 75 | double calPIDOutput(double setpt, double input, ec::pid_info_t* info); |
| 76 | |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 77 | protected: |
| 78 | ZoneInterface* _owner; |
Nirav Shah | ccc8bb6 | 2022-02-17 21:06:51 -0800 | [diff] [blame] | 79 | std::string _id; |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 80 | |
| 81 | private: |
| 82 | // parameters |
| 83 | ec::pid_info_t _pid_info; |
Nirav Shah | ccc8bb6 | 2022-02-17 21:06:51 -0800 | [diff] [blame] | 84 | double _setpoint = 0; |
James Feist | 572c43d | 2019-01-31 15:52:22 -0800 | [diff] [blame] | 85 | double lastInput = std::numeric_limits<double>::quiet_NaN(); |
James Feist | 22c257a | 2018-08-31 14:07:12 -0700 | [diff] [blame] | 86 | }; |
Patrick Venture | a076487 | 2020-08-08 07:48:43 -0700 | [diff] [blame] | 87 | |
| 88 | } // namespace pid_control |