{"id":2342,"date":"2017-06-20T10:32:30","date_gmt":"2017-06-20T14:32:30","guid":{"rendered":"http:\/\/brettbeauregard.com\/blog\/?p=2342"},"modified":"2024-06-03T20:58:26","modified_gmt":"2024-06-04T00:58:26","slug":"proportional-on-measurement-the-code","status":"publish","type":"post","link":"http:\/\/brettbeauregard.com\/blog\/2017\/06\/proportional-on-measurement-the-code\/","title":{"rendered":"Proportional on Measurement – The Code"},"content":{"rendered":"

In the previous post<\/a> I spent all my time explaining the benefits of Proportional on Measurement. In this post I’ll explain the code. People seemed to appreciate the step-by-step way I explained things last time,<\/a> so that’s what I’ll do here. The 3 passes below detail how I went about adding PonM to the PID library.<\/p>\n

First Pass – Initial Input and Proportional-Mode selection<\/h3>\n
\n
\r\n\/*working variables*\/\r\nunsigned long lastTime;\r\ndouble Input, Output, Setpoint;\r\ndouble ITerm, lastInput;\r\ndouble kp, ki, kd;\r\nint SampleTime = 1000; \/\/1 sec\r\ndouble outMin, outMax;\r\nbool inAuto = false;\r\n \r\n#define MANUAL 0\r\n#define AUTOMATIC 1\r\n \r\n#define DIRECT 0\r\n#define REVERSE 1\r\nint controllerDirection = DIRECT;\r\n \r\n#define P_ON_M 0\r\n#define P_ON_E 1\r\nbool pOnE = true;\r\ndouble initInput;\r\n\r\nvoid Compute()\r\n{\r\n   if(!inAuto) return;\r\n   unsigned long now = millis();\r\n   int timeChange = (now - lastTime);\r\n   if(timeChange>=SampleTime)\r\n   {\r\n      \/*Compute all the working error variables*\/\r\n      double error = Setpoint - Input;\r\n      ITerm+= (ki * error);\r\n      if(ITerm > outMax) ITerm= outMax;\r\n      else if(ITerm < outMin) ITerm= outMin;\r\n      double dInput = (Input - lastInput);\r\n \r\n      \/*Compute P-Term*\/ \r\n      if(pOnE) Output = kp * error;\r\n      else Output = -kp * (Input-initInput); \r\n\r\n      \/*Compute Rest of PID Output*\/ \r\n      Output += ITerm - kd * dInput;\r\n      if(Output > outMax) Output = outMax;\r\n      else if(Output < outMin) Output = outMin;\r\n \r\n      \/*Remember some variables for next time*\/\r\n      lastInput = Input;\r\n      lastTime = now;\r\n   }\r\n}\r\n \r\nvoid SetTunings(double Kp, double Ki, double Kd, int pOn)\r\n{\r\n   if (Kp<0 || Ki<0|| Kd<0) return;\r\n \r\n   pOnE = pOn == P_ON_E;\r\n  \r\n   double SampleTimeInSec = ((double)SampleTime)\/1000;\r\n   kp = Kp;\r\n   ki = Ki * SampleTimeInSec;\r\n   kd = Kd \/ SampleTimeInSec;\r\n \r\n  if(controllerDirection ==REVERSE)\r\n   {\r\n      kp = (0 - kp);\r\n      ki = (0 - ki);\r\n      kd = (0 - kd);\r\n   }\r\n}\r\n \r\nvoid SetSampleTime(int NewSampleTime)\r\n{\r\n   if (NewSampleTime > 0)\r\n   {\r\n      double ratio  = (double)NewSampleTime\r\n                      \/ (double)SampleTime;\r\n      ki *= ratio;\r\n      kd \/= ratio;\r\n      SampleTime = (unsigned long)NewSampleTime;\r\n   }\r\n}\r\n \r\nvoid SetOutputLimits(double Min, double Max)\r\n{\r\n   if(Min > Max) return;\r\n   outMin = Min;\r\n   outMax = Max;\r\n \r\n   if(Output > outMax) Output = outMax;\r\n   else if(Output < outMin) Output = outMin;\r\n \r\n   if(ITerm > outMax) ITerm= outMax;\r\n   else if(ITerm < outMin) ITerm= outMin;\r\n}\r\n \r\nvoid SetMode(int Mode)\r\n{\r\n    bool newAuto = (Mode == AUTOMATIC);\r\n    if(newAuto == !inAuto)\r\n    {  \/*we just went from manual to auto*\/\r\n        Initialize();\r\n    }\r\n    inAuto = newAuto;\r\n}\r\n \r\nvoid Initialize()\r\n{\r\n   lastInput = Input;\r\n   initInput = Input;\r\n   ITerm = Output;\r\n   if(ITerm > outMax) ITerm= outMax;\r\n   else if(ITerm < outMin) ITerm= outMin;\r\n}\r\n \r\nvoid SetControllerDirection(int Direction)\r\n{\r\n   controllerDirection = Direction;\r\n}\r\n<\/pre>\n<\/div>\n
Proportional on Measurement provides increasing resistance as the input changes, but without a frame of reference our performance would be a little wonky. If the PID Input is 10000 when we first turn on the controller, do we really want to start resisting with Kp*10000? No. We want to use our initial input as a reference point (line 108,) the increase or decrease resistance as the input changes from there (line 38.)<\/p>\n
The other thing we need to do is allow the user to select whether they want to do Proportional on Error or Measurement. After the last post<\/a> it might seem like PonE is useless, but it’s important to remember that for many loops it works well. As such, we need to let the user choose which mode they want (lines 51&55) and then act accordingly in the calculation (lines 37&38).<\/p>\n
Second Pass – On-the-fly tuning changes<\/h3>\n
While the code above does indeed work, it has a problem that we’ve seen before. When tuning parameters are changed at runtime, we get an undesirable blip.<\/p>\n
\"PonM-blip\"<\/a><\/p>\n
Why is this happening?<\/p>\n
\"PonM-blip-math\"<\/a><\/p>\n
The last time we saw this,<\/a> it was that the integral was being rescaled by a new Ki. This time, it’s that (Input – initInput) is being rescaled by Kp. the solution I chose is similar to what I did for Ki: instead of treating the Input – initInput as a monolithic unit multiplied by the current Kp, I broke it into individual steps multiplied by the Kp at that time:<\/p>\n
\"PonM<\/a><\/p>\n
\n
\r\n\/*working variables*\/\r\nunsigned long lastTime;\r\ndouble Input, Output, Setpoint;\r\ndouble ITerm, lastInput;\r\ndouble kp, ki, kd;\r\nint SampleTime = 1000; \/\/1 sec\r\ndouble outMin, outMax;\r\nbool inAuto = false;\r\n \r\n#define MANUAL 0\r\n#define AUTOMATIC 1\r\n \r\n#define DIRECT 0\r\n#define REVERSE 1\r\nint controllerDirection = DIRECT;\r\n \r\n#define P_ON_M 0\r\n#define P_ON_E 1\r\nbool pOnE = true;\r\ndouble PTerm;\r\n\r\nvoid Compute()\r\n{\r\n   if(!inAuto) return;\r\n   unsigned long now = millis();\r\n   int timeChange = (now - lastTime);\r\n   if(timeChange>=SampleTime)\r\n   {\r\n   \r\n      \/*Compute all the working error variables*\/\t \t\r\n      double error = Setpoint - Input;\t \r\n      ITerm+= (ki * error);\t \r\n      if(ITerm > outMax) ITerm= outMax;\t \t\r\n      else if(ITerm < outMin) ITerm= outMin;  \r\n      double dInput = (Input - lastInput);\r\n\r\n   \t  \/*Compute P-Term*\/ \r\n   \t  if(pOnE) Output = kp * error; \r\n   \t  else \r\n   \t  { \r\n   \t     PTerm -= kp * dInput; \r\n   \t     Output = PTerm; \r\n   \t  } \r\n   \t  \r\n   \t  \/*Compute Rest of PID Output*\/ \r\n   \t  Output += ITerm - kd * dInput; \r\n   \r\n      if(Output > outMax) Output = outMax;\r\n      else if(Output < outMin) Output = outMin;\r\n \r\n      \/*Remember some variables for next time*\/\r\n      lastInput = Input;\r\n      lastTime = now;\r\n   }\r\n}\r\n \r\nvoid SetTunings(double Kp, double Ki, double Kd, int pOn)\r\n{\r\n   if (Kp<0 || Ki<0|| Kd<0) return;\r\n \r\n   pOnE = pOn == P_ON_E;\r\n  \r\n   double SampleTimeInSec = ((double)SampleTime)\/1000;\r\n   kp = Kp;\r\n   ki = Ki * SampleTimeInSec;\r\n   kd = Kd \/ SampleTimeInSec;\r\n \r\n  if(controllerDirection ==REVERSE)\r\n   {\r\n      kp = (0 - kp);\r\n      ki = (0 - ki);\r\n      kd = (0 - kd);\r\n   }\r\n}\r\n \r\nvoid SetSampleTime(int NewSampleTime)\r\n{\r\n   if (NewSampleTime > 0)\r\n   {\r\n      double ratio  = (double)NewSampleTime\r\n                      \/ (double)SampleTime;\r\n      ki *= ratio;\r\n      kd \/= ratio;\r\n      SampleTime = (unsigned long)NewSampleTime;\r\n   }\r\n}\r\n \r\nvoid SetOutputLimits(double Min, double Max)\r\n{\r\n   if(Min > Max) return;\r\n   outMin = Min;\r\n   outMax = Max;\r\n \r\n   if(Output > outMax) Output = outMax;\r\n   else if(Output < outMin) Output = outMin;\r\n \r\n   if(ITerm > outMax) ITerm= outMax;\r\n   else if(ITerm < outMin) ITerm= outMin;\r\n}\r\n \r\nvoid SetMode(int Mode)\r\n{\r\n    bool newAuto = (Mode == AUTOMATIC);\r\n    if(newAuto == !inAuto)\r\n    {  \/*we just went from manual to auto*\/\r\n        Initialize();\r\n    }\r\n    inAuto = newAuto;\r\n}\r\n \r\nvoid Initialize()\r\n{\r\n   lastInput = Input;\r\n   PTerm = 0;\r\n   ITerm = Output;\r\n   if(ITerm > outMax) ITerm= outMax;\r\n   else if(ITerm < outMin) ITerm= outMin;\r\n}\r\n \r\nvoid SetControllerDirection(int Direction)\r\n{\r\n   controllerDirection = Direction;\r\n}\r\n<\/pre>\n<\/div>\n
Instead of multiplying the entirety of Input-initInput by Kp, we now keep a working sum, PTerm. At each step we multiply just the current input change by Kp and subtract it from PTerm (line 41.) Here we can see the impact of the change:<\/p>\n
\"PonM-no-blip\"<\/a><\/p>\n
\"PonM-no-blip-math\"<\/a><\/p>\n
Because the old Kps are “in the bank”, the change in tuning parameters only affects us moving forward<\/p>\n
Final Pass – Sum problems.<\/h3>\n
I won’t go into complete detail (fancy trends etc) as to what wrong with the above code. It’s pretty good, but there are still major issues with it. For example:<\/p>\n
    \n
  1. Windup, sort of<\/strong>: While the final output is limited between outMin and outMax, it’s possible for PTerm to grow when it shouldn’t. It wouldn’t be as bad as integral windup<\/a>, but it still wouldn’t be acceptable<\/li>\n
  2. On-the-fly changes<\/strong>: If the user were to change from P_ON_M to P_ON_E while running, then after some time return back, PTerm wouldn’t be property initialized and it would cause an output bump<\/li>\n<\/ol>\n
    There are more, but just these are enough to see what the real issue is. We’ve dealt with all of these before, back when we created ITerm. Rather than go through and re-implement the same solutions for PTerm, I decided on a more aesthetically-pleasing solution.<\/p>\n
    By merging PTerm and ITerm into a single variable called “outputSum”, the P_ON_M code then benefits from the all the ITerm fixes that are already in place, and because there aren’t two sums in the code there isn’t needless redundancy.<\/p>\n
    \n
    \r\n\/*working variables*\/\r\nunsigned long lastTime;\r\ndouble Input, Output, Setpoint;\r\ndouble outputSum, lastInput;\r\ndouble kp, ki, kd;\r\nint SampleTime = 1000; \/\/1 sec\r\ndouble outMin, outMax;\r\nbool inAuto = false;\r\n \r\n#define MANUAL 0\r\n#define AUTOMATIC 1\r\n \r\n#define DIRECT 0\r\n#define REVERSE 1\r\nint controllerDirection = DIRECT;\r\n \r\n#define P_ON_M 0\r\n#define P_ON_E 1\r\nbool pOnE = true;\r\n\r\n\r\nvoid Compute()\r\n{\r\n   if(!inAuto) return;\r\n   unsigned long now = millis();\r\n   int timeChange = (now - lastTime);\r\n   if(timeChange>=SampleTime)\r\n   {\r\n   \r\n      \/*Compute all the working error variables*\/\t \t\r\n      double error = Setpoint - Input;\t \r\n      double dInput = (Input - lastInput);\r\n      outputSum+= (ki * error);\t \r\n\t  \r\n\t  \/*Add Proportional on Measurement, if P_ON_M is specified*\/\r\n\t  if(!pOnE) outputSum-= kp * dInput\r\n\t  \r\n      if(outputSum > outMax) outputSum= outMax;\t \t\r\n      else if(outputSum < outMin) outputSum= outMin;  \r\n   \t\r\n   \t  \/*Add Proportional on Error, if P_ON_E is specified*\/ \r\n\t  if(pOnE) Output = kp * error; \r\n\t  else Output = 0;\r\n   \t  \r\n   \t  \/*Compute Rest of PID Output*\/ \r\n   \t  Output += outputSum - kd * dInput; \r\n   \r\n      if(Output > outMax) Output = outMax;\r\n      else if(Output < outMin) Output = outMin;\r\n \r\n      \/*Remember some variables for next time*\/\r\n      lastInput = Input;\r\n      lastTime = now;\r\n   }\r\n}\r\n \r\nvoid SetTunings(double Kp, double Ki, double Kd, int pOn)\r\n{\r\n   if (Kp<0 || Ki<0|| Kd<0) return;\r\n \r\n   pOnE = pOn == P_ON_E;\r\n  \r\n   double SampleTimeInSec = ((double)SampleTime)\/1000;\r\n   kp = Kp;\r\n   ki = Ki * SampleTimeInSec;\r\n   kd = Kd \/ SampleTimeInSec;\r\n \r\n  if(controllerDirection ==REVERSE)\r\n   {\r\n      kp = (0 - kp);\r\n      ki = (0 - ki);\r\n      kd = (0 - kd);\r\n   }\r\n}\r\n \r\nvoid SetSampleTime(int NewSampleTime)\r\n{\r\n   if (NewSampleTime > 0)\r\n   {\r\n      double ratio  = (double)NewSampleTime\r\n                      \/ (double)SampleTime;\r\n      ki *= ratio;\r\n      kd \/= ratio;\r\n      SampleTime = (unsigned long)NewSampleTime;\r\n   }\r\n}\r\n \r\nvoid SetOutputLimits(double Min, double Max)\r\n{\r\n   if(Min > Max) return;\r\n   outMin = Min;\r\n   outMax = Max;\r\n \r\n   if(Output > outMax) Output = outMax;\r\n   else if(Output < outMin) Output = outMin;\r\n \r\n   if(outputSum > outMax) outputSum= outMax;\r\n   else if(outputSum < outMin) outputSum= outMin;\r\n}\r\n \r\nvoid SetMode(int Mode)\r\n{\r\n    bool newAuto = (Mode == AUTOMATIC);\r\n    if(newAuto == !inAuto)\r\n    {  \/*we just went from manual to auto*\/\r\n        Initialize();\r\n    }\r\n    inAuto = newAuto;\r\n}\r\n \r\nvoid Initialize()\r\n{\r\n   lastInput = Input;\r\n   \r\n   outputSum = Output;\r\n   if(outputSum > outMax) outputSum= outMax;\r\n   else if(outputSum < outMin) outputSum= outMin;\r\n}\r\n \r\nvoid SetControllerDirection(int Direction)\r\n{\r\n   controllerDirection = Direction;\r\n}<\/pre>\n<\/div>\n
    And there you have it. The above functionality is what is now present in v1.2.0 of the Arduino PID.<\/p>\n
    But wait, there’s more: Setpoint Weighting.<\/h3>\n
    I didn’t add the following to the Arduino library code, but this is a feature that might be of some interest if you want to roll your own. Setpoint Weighting is, at it’s core, a way to have both PonE and PonM at the same time. By specifying a ratio between 0 and 1, you can have 100% PonM, 100% PonE (respectively) or some ratio in between. This can be helpful if you have a process that’s not perfectly integrating (like a reflow oven) and want to account for this.<\/p>\n
    Ultimately I decided not to add it to the library at this time, as it winds up being ANOTHER parameter to adjust\/explain, and I didn’t think the resulting benefit was worth it. At any rate, here is the code if you’d like to modify the code to have Setpoint Weighting instead of just pure PonM\/PonE selection:<\/p>\n
    \n
    \r\n\/*working variables*\/\r\nunsigned long lastTime;\r\ndouble Input, Output, Setpoint;\r\ndouble outputSum, lastInput;\r\ndouble kp, ki, kd;\r\nint SampleTime = 1000; \/\/1 sec\r\ndouble outMin, outMax;\r\nbool inAuto = false;\r\n \r\n#define MANUAL 0\r\n#define AUTOMATIC 1\r\n \r\n#define DIRECT 0\r\n#define REVERSE 1\r\nint controllerDirection = DIRECT;\r\n \r\n#define P_ON_M 0\r\n#define P_ON_E 1\r\nbool pOnE = true, pOnM = false;\r\ndouble pOnEKp, pOnMKp;\r\n\r\n\r\nvoid Compute()\r\n{\r\n   if(!inAuto) return;\r\n   unsigned long now = millis();\r\n   int timeChange = (now - lastTime);\r\n   if(timeChange>=SampleTime)\r\n   {\r\n   \r\n      \/*Compute all the working error variables*\/\t \t\r\n      double error = Setpoint - Input;\t \r\n      double dInput = (Input - lastInput);\r\n      outputSum+= (ki * error);\t \r\n\t  \r\n\t  \/*Add Proportional on Measurement, if P_ON_M is specified*\/\r\n\t  if(pOnM) outputSum-= pOnMKp * dInput\r\n\t  \r\n      if(outputSum > outMax) outputSum= outMax;\t \t\r\n      else if(outputSum < outMin) outputSum= outMin;  \r\n   \t\r\n   \t  \/*Add Proportional on Error, if P_ON_E is specified*\/ \r\n\t  if(pOnE) Output = pOnEKp * error; \r\n\t  else Output = 0;\r\n   \t  \r\n   \t  \/*Compute Rest of PID Output*\/ \r\n   \t  Output += outputSum - kd * dInput; \r\n   \r\n      if(Output > outMax) Output = outMax;\r\n      else if(Output < outMin) Output = outMin;\r\n \r\n      \/*Remember some variables for next time*\/\r\n      lastInput = Input;\r\n      lastTime = now;\r\n   }\r\n}\r\n \r\nvoid SetTunings(double Kp, double Ki, double Kd, double pOn)\r\n{\r\n   if (Kp<0 || Ki<0|| Kd<0 || pOn<0 || pOn>1) return;\r\n \r\n   pOnE = pOn>0; \/\/some p on error is desired;\r\n   pOnM = pOn<1; \/\/some p on measurement is desired;  \r\n  \r\n   double SampleTimeInSec = ((double)SampleTime)\/1000;\r\n   kp = Kp;\r\n   ki = Ki * SampleTimeInSec;\r\n   kd = Kd \/ SampleTimeInSec;\r\n \r\n  if(controllerDirection ==REVERSE)\r\n   {\r\n      kp = (0 - kp);\r\n      ki = (0 - ki);\r\n      kd = (0 - kd);\r\n   }\r\n   \r\n   pOnEKp = pOn * kp; \r\n   pOnMKp = (1 - pOn) * kp;\r\n}\r\n \r\nvoid SetSampleTime(int NewSampleTime)\r\n{\r\n   if (NewSampleTime > 0)\r\n   {\r\n      double ratio  = (double)NewSampleTime\r\n                      \/ (double)SampleTime;\r\n      ki *= ratio;\r\n      kd \/= ratio;\r\n      SampleTime = (unsigned long)NewSampleTime;\r\n   }\r\n}\r\n \r\nvoid SetOutputLimits(double Min, double Max)\r\n{\r\n   if(Min > Max) return;\r\n   outMin = Min;\r\n   outMax = Max;\r\n \r\n   if(Output > outMax) Output = outMax;\r\n   else if(Output < outMin) Output = outMin;\r\n \r\n   if(outputSum > outMax) outputSum= outMax;\r\n   else if(outputSum < outMin) outputSum= outMin;\r\n}\r\n \r\nvoid SetMode(int Mode)\r\n{\r\n    bool newAuto = (Mode == AUTOMATIC);\r\n    if(newAuto == !inAuto)\r\n    {  \/*we just went from manual to auto*\/\r\n        Initialize();\r\n    }\r\n    inAuto = newAuto;\r\n}\r\n \r\nvoid Initialize()\r\n{\r\n   lastInput = Input;\r\n   outputSum = Output;\r\n   if(outputSum > outMax) outputSum= outMax;\r\n   else if(outputSum < outMin) outputSum= outMin;\r\n}\r\n \r\nvoid SetControllerDirection(int Direction)\r\n{\r\n   controllerDirection = Direction;\r\n}\r\n<\/pre>\n<\/div>\n
    Instead of setting pOn as an integer, it now comes in as a double which allows for a ratio (line 58.) In addition to some flags (lines 62&63) weighted Kp terms are computed on lines 77-78. Then on lines 37 and 43 the weighted PonM and PonE contributions are added to the overall PID output.<\/p>\n","protected":false},"excerpt":{"rendered":"
    In the previous post I spent all my time explaining the benefits of Proportional on Measurement. In this post I’ll explain the code. People seemed to appreciate the step-by-step way I explained things last time, so that’s what I’ll do … Continue reading →<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"_monsterinsights_skip_tracking":false,"_monsterinsights_sitenote_active":false,"_monsterinsights_sitenote_note":"","_monsterinsights_sitenote_category":0,"footnotes":""},"categories":[31,7],"tags":[],"class_list":["post-2342","post","type-post","status-publish","format-standard","hentry","category-coding","category-pid"],"_links":{"self":[{"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/posts\/2342","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/comments?post=2342"}],"version-history":[{"count":84,"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/posts\/2342\/revisions"}],"predecessor-version":[{"id":2476,"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/posts\/2342\/revisions\/2476"}],"wp:attachment":[{"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/media?parent=2342"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/categories?post=2342"},{"taxonomy":"post_tag","embeddable":true,"href":"http:\/\/brettbeauregard.com\/blog\/wp-json\/wp\/v2\/tags?post=2342"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}