Added MIT license, POn default = 1

Author: Dlloydev

LICENSE

@@ -0,0 +1,19 @@
+Copyright 2011-2017 Brett Beauregard <[email protected]> brettbeauregard.com
+Copyright 2021 David Lloyd <[email protected]>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+the Software, and to permit persons to whom the Software is furnished to do so,
+subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

QuickPID.cpp

@@ -1,5 +1,5 @@
 /**********************************************************************************
-   QuickPID Library for Arduino - Version 2.0.4
+   QuickPID Library for Arduino - Version 2.0.5
    by dlloydev https://github.com/Dlloydev/QuickPID
    Based on the Arduino PID Library by Brett Beauregard
 
@@ -19,7 +19,7 @@
    reliable defaults, so we need to have the user set them.
  **********************************************************************************/
 QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
-                   float Kp, float Ki, float Kd, float POn, bool ControllerDirection)
+                   float Kp, float Ki, float Kd, float POn = 1, bool ControllerDirection = 0)
 {
   myOutput = Output;
   myInput = Input;
@@ -28,6 +28,7 @@ QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
 
   QuickPID::SetOutputLimits(0, 255);  // default is same as the arduino PWM limit
   SampleTimeUs = 100000;              // default is 0.1 seconds
+
   QuickPID::SetControllerDirection(ControllerDirection);
   QuickPID::SetTunings(Kp, Ki, Kd, POn);
 
@@ -41,7 +42,7 @@ QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
 
 QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
                    float Kp, float Ki, float Kd, bool ControllerDirection)
-  : QuickPID::QuickPID(Input, Output, Setpoint, Kp, Ki, Kd, POn, ControllerDirection)
+  : QuickPID::QuickPID(Input, Output, Setpoint, Kp, Ki, Kd, pOn = 1, ControllerDirection = 0)
 {
 
 }
@@ -85,12 +86,11 @@ bool QuickPID::Compute()
    it's called automatically from the constructor, but tunings can also
    be adjusted on the fly during normal operation
  ******************************************************************************/
-void QuickPID::SetTunings(float Kp, float Ki, float Kd, float POn)
+void QuickPID::SetTunings(float Kp, float Ki, float Kd, float POn = 1)
 {
   if (Kp < 0 || Ki < 0 || Kd < 0) return;
 
   pOn = POn;
-
   dispKp = Kp; dispKi = Ki; dispKd = Kd;
 
   float SampleTimeSec = (float)SampleTimeUs / 1000000;
@@ -112,7 +112,7 @@ void QuickPID::SetTunings(float Kp, float Ki, float Kd, float POn)
    Set Tunings using the last remembered POn setting.
  ******************************************************************************/
 void QuickPID::SetTunings(float Kp, float Ki, float Kd) {
-  SetTunings(Kp, Ki, Kd, POn);
+  SetTunings(Kp, Ki, Kd, pOn);
 }
 
 /* SetSampleTime(...) *********************************************************

QuickPID.h

@@ -69,7 +69,7 @@ class QuickPID
     float dispKi;
     float dispKd;
 
-    float pOn;             // proportional mode (0-1) default 1 (100% on Error, 0% on Measurement)
+    float pOn;             // proportional mode (0-1) default = 1, 100% Proportional on Error
     float kp;              // (P)roportional Tuning Parameter
     float ki;              // (I)ntegral Tuning Parameter
     float kd;              // (D)erivative Tuning Parameter

README.md

@@ -56,7 +56,7 @@ QuickPID::QuickPID(int16_t* Input, int16_t* Output, int16_t* Setpoint,
 
 - `Input`, `Output`, and `Setpoint` are pointers to the variables holding these values.
 - `Kp`, `Ki`, and `Kd` are the PID proportional, integral, and derivative gains.
-- `POn` is the Proportional on Error weighting value (0.0-1.0). This controls the mix of Proportional on Error (PonE) and  Proportional on Measurement (PonM) that's used in the compute algorithm. Note that POn controls the PonE amount, where the remainder (1-PonE) is the PonM amount. Also, the default POn is 0 (100% PonM, 0% PonE).
+- `POn` is the Proportional on Error weighting value (0.0-1.0). This controls the mix of Proportional on Error (PonE) and  Proportional on Measurement (PonM) that's used in the compute algorithm. Note that POn controls the PonE amount, where the remainder (1-PonE) is the PonM amount. Also, the default POn is 1
 
 ![POn](https://user-images.githubusercontent.com/63488701/104958919-fe3c4680-599e-11eb-851e-73f26291d3e5.gif)
 
@@ -164,6 +164,11 @@ A faster configuration of `analogRead()`where a preset of 32 is used. Works with
 
 ### Change Log
 
+#### Version 2.0.5 (latest)
+
+- Added MIT license text file
+- POn defaults to 1
+
 #### Version 2.0.4
 
 - Added `QuickPID_AdaptiveTunings.ino`, `QuickPID_Basic.ino`, `QuickPID_PonM.ino` and `QuickPID_RelayOutput.ino` to the examples folder.

examples/QuickPID_AdaptiveTunings/QuickPID_AdaptiveTunings.ino

@@ -9,7 +9,7 @@
    Parameters when we're farther away.
  ********************************************************/
 
-#include <QuickPID.h>
+#include "QuickPID.h"
 
 #define PIN_INPUT 0
 #define PIN_OUTPUT 3

examples/QuickPID_Basic/QuickPID_Basic.ino

@@ -3,7 +3,7 @@
    Reading analog input 0 to control analog PWM output 3
  ********************************************************/
 
-#include <QuickPID.h>
+#include "QuickPID.h"
 
 #define PIN_INPUT 0
 #define PIN_OUTPUT 3
@@ -13,9 +13,8 @@ int Setpoint, Input, Output;
 
 //Specify the links and initial tuning parameters
 float Kp = 2, Ki = 5, Kd = 1;
-float POn = 1.0; // Range is 0.0 to 1.0 (1.0 is 100% P on Error, 0% P on Measurement)
 
-QuickPID myQuickPID(&Input, &Output, &Setpoint, Kp, Ki, Kd, POn, DIRECT);
+QuickPID myQuickPID(&Input, &Output, &Setpoint, Kp, Ki, Kd, DIRECT);
 
 void setup()
 {

examples/QuickPID_PonM/QuickPID_PonM.ino

@@ -6,7 +6,7 @@
    in certain processes like sous-vides.
  ********************************************************/
 
-#include <QuickPID.h>
+#include "QuickPID.h"
 
 //Define Variables we'll be connecting to
 int Setpoint, Input, Output;

examples/QuickPID_RC_Filter/QuickPID_RC_Filter.ino

@@ -6,7 +6,7 @@
    https://github.com/Dlloydev/QuickPID/wiki/QuickPID_RC_Filter
  **************************************************************/
 
-#include <QuickPID.h>
+#include "QuickPID.h"
 
 #define PIN_INPUT   0
 #define PIN_OUTPUT  3

examples/QuickPID_RelayOutput/QuickPID_RelayOutput.ino

@@ -16,7 +16,7 @@
    be on for a minimum amount of time.
  ********************************************************/
 
-#include <QuickPID.h>
+#include "QuickPID.h"
 
 #define PIN_INPUT 0
 #define RELAY_PIN 6

library.json

@@ -1,7 +1,7 @@
 {
   "name": "QuickPID",
   "keywords": "PID, controller, signal",
-  "description": "QuickPID controller - a faster implementation of the Arduino PID Library with more features. This hybrid fixed/floating point controller seeks to keep an output close to a desired setpoint  by adjusting four parameters (P,I,D) and POn (PonE, PonM setpoint weighting).",
+  "description": "QuickPID controller - a faster implementation of the Arduino PID Library with more features. This hybrid fixed/floating point controller seeks to keep an output close to a desired setpoint by adjusting four parameters (P,I,D) and proportional setpoint weighting (POn).",
   "url": "https://github.com/Dlloydev/QuickPID",
   "include": "QuickPID",
   "authors":