From d46dded42d8fcb623b661de1c4dab226b74dddd4 Mon Sep 17 00:00:00 2001 From: Brett Beauregard Date: Mon, 20 Apr 2015 19:30:29 -0400 Subject: [PATCH] moved library code back to root from sub-folder when github was adding a hash to the library download zip, there was confusion from beginners about needing to rename the unzipped folder before moving into the arduino ide. this library has been prepped (thijse) for the arduino library manager, which requires the library to be in the root directory. Having the library in the manager also removes the "beginner user hash" concern. --- PID_v1/PID_v1.cpp => PID_v1.cpp | 2 +- PID_v1/PID_v1.h => PID_v1.h | 2 +- PID_v1/library.properties | 9 --------- README.txt | 12 ++++-------- .../PID_AdaptiveTunings/PID_AdaptiveTunings.ino | 0 .../examples => examples}/PID_Basic/PID_Basic.ino | 0 .../PID_RelayOutput/PID_RelayOutput.ino | 0 PID_v1/keywords.txt => keywords.txt | 0 PID_v1/library.json => library.json | 2 +- library.properties | 9 +++++++++ 10 files changed, 16 insertions(+), 20 deletions(-) rename PID_v1/PID_v1.cpp => PID_v1.cpp (99%) rename PID_v1/PID_v1.h => PID_v1.h (99%) delete mode 100644 PID_v1/library.properties rename {PID_v1/examples => examples}/PID_AdaptiveTunings/PID_AdaptiveTunings.ino (100%) rename {PID_v1/examples => examples}/PID_Basic/PID_Basic.ino (100%) rename {PID_v1/examples => examples}/PID_RelayOutput/PID_RelayOutput.ino (100%) rename PID_v1/keywords.txt => keywords.txt (100%) rename PID_v1/library.json => library.json (62%) create mode 100644 library.properties diff --git a/PID_v1/PID_v1.cpp b/PID_v1.cpp similarity index 99% rename from PID_v1/PID_v1.cpp rename to PID_v1.cpp index 6c95895..09b9261 100644 --- a/PID_v1/PID_v1.cpp +++ b/PID_v1.cpp @@ -1,5 +1,5 @@ /********************************************************************************************** - * Arduino PID Library - Version 1.0.1 + * Arduino PID Library - Version 1.1.1 * by Brett Beauregard brettbeauregard.com * * This Library is licensed under a GPLv3 License diff --git a/PID_v1/PID_v1.h b/PID_v1.h similarity index 99% rename from PID_v1/PID_v1.h rename to PID_v1.h index 6f86697..77b3e4b 100644 --- a/PID_v1/PID_v1.h +++ b/PID_v1.h @@ -1,6 +1,6 @@ #ifndef PID_v1_h #define PID_v1_h -#define LIBRARY_VERSION 1.0.0 +#define LIBRARY_VERSION 1.1.1 class PID { diff --git a/PID_v1/library.properties b/PID_v1/library.properties deleted file mode 100644 index 0df2127..0000000 --- a/PID_v1/library.properties +++ /dev/null @@ -1,9 +0,0 @@ -name=PID -version=1.0.1 -author=Brett Beauregard -maintainer=Brett Beauregard -sentence=PID controller -paragraph=A PID controller calculates an 'error' value as the difference between a measured input and a desired setpoint. The controller attempts to minimize the error by adjusting an output. -category=Signal Input/Output -url=http://playground.arduino.cc/Code/PIDLibrary -architectures=* diff --git a/README.txt b/README.txt index e36aedd..61f4be2 100644 --- a/README.txt +++ b/README.txt @@ -1,15 +1,11 @@ *************************************************************** -* Arduino PID Library - Version 1.1.0 - +* Arduino PID Library - Version 1.1.1 * by Brett Beauregard brettbeauregard.com - * - * This Library is licensed under a GPLv3 License - *************************************************************** - - To Use, copy the PID_v1 folder into the Arduino\Libraries directory - - For an ultra-detailed explanation of why the code is the way it is, please visit: - http://brettbeauregard.com/blog/2011/04/improving-the-beginners-pid-introduction/ \ No newline at end of file + http://brettbeauregard.com/blog/2011/04/improving-the-beginners-pid-introduction/ + + - For function documentation see: http://playground.arduino.cc/Code/PIDLibrary diff --git a/PID_v1/examples/PID_AdaptiveTunings/PID_AdaptiveTunings.ino b/examples/PID_AdaptiveTunings/PID_AdaptiveTunings.ino similarity index 100% rename from PID_v1/examples/PID_AdaptiveTunings/PID_AdaptiveTunings.ino rename to examples/PID_AdaptiveTunings/PID_AdaptiveTunings.ino diff --git a/PID_v1/examples/PID_Basic/PID_Basic.ino b/examples/PID_Basic/PID_Basic.ino similarity index 100% rename from PID_v1/examples/PID_Basic/PID_Basic.ino rename to examples/PID_Basic/PID_Basic.ino diff --git a/PID_v1/examples/PID_RelayOutput/PID_RelayOutput.ino b/examples/PID_RelayOutput/PID_RelayOutput.ino similarity index 100% rename from PID_v1/examples/PID_RelayOutput/PID_RelayOutput.ino rename to examples/PID_RelayOutput/PID_RelayOutput.ino diff --git a/PID_v1/keywords.txt b/keywords.txt similarity index 100% rename from PID_v1/keywords.txt rename to keywords.txt diff --git a/PID_v1/library.json b/library.json similarity index 62% rename from PID_v1/library.json rename to library.json index 1d93206..cf2510c 100644 --- a/PID_v1/library.json +++ b/library.json @@ -1,7 +1,7 @@ { "name": "PID", "keywords": "PID, controller, signal", - "description": "PID controller calculates an 'error' value as the difference between a measured input and a desired setpoint. The controller attempts to minimize the error by adjusting an output.", + "description": "A PID controller seeks to keep some input variable close to a desired setpoint by adjusting an output. The way in which it does this can be 'tuned' by adjusting three parameters (P,I,D).", "url": "http://playground.arduino.cc/Code/PIDLibrary", "include": "PID_v1", "authors": diff --git a/library.properties b/library.properties new file mode 100644 index 0000000..9a316b0 --- /dev/null +++ b/library.properties @@ -0,0 +1,9 @@ +name=PID +version=1.1.1 +author=Brett Beauregard +maintainer=Brett Beauregard +sentence=PID controller +paragraph=A PID controller seeks to keep some input variable close to a desired setpoint by adjusting an output. The way in which it does this can be 'tuned' by adjusting three parameters (P,I,D). +category=Signal Input/Output +url=http://playground.arduino.cc/Code/PIDLibrary +architectures=*