0.1.5 PID_RT

libraries/PID_RT/.arduino-ci.yml

@@ -1,3 +1,18 @@
+platforms:
+  rpipico:
+    board: rp2040:rp2040:rpipico
+    package: rp2040:rp2040
+    gcc:
+      features:
+      defines:
+        - ARDUINO_ARCH_RP2040
+      warnings:
+      flags:
+
+packages:
+  rp2040:rp2040:
+    url: https://github.com/earlephilhower/arduino-pico/releases/download/global/package_rp2040_index.json
+
 compile:
   # Choosing to run compilation tests on 2 different Arduino platforms
   platforms:
@@ -9,3 +24,4 @@ compile:
     - esp32
     # - esp8266
     # - mega2560
+    - rpipico

libraries/PID_RT/CHANGELOG.md

@@ -0,0 +1,36 @@
+# Change Log PID_RT
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](http://keepachangelog.com/)
+and this project adheres to [Semantic Versioning](http://semver.org/).
+
+
+## [0.1.5] - 2022-10-23
+- add RP2040 to build-CI
+- add changelog.md
+- minor edits readme.md
+
+
+## [0.1.4] - 2021-12-23
+- update library.json, license, 
+- minor edits
+
+## [0.1.3] - 2021-11-12
+- update build-CI, update readme
+- renamed variables for readability
+- added history
+- fixed bug in setK
+
+## [0.1.2] - 2021-05-28
+- minor edits
+
+## [0.1.1] - 2021-05-27
+- add json check
+- add lint check
+
+## [0.1.0] - 2020-12-15
+- update readme, fix unit test, 
+- fix library.json
+- add 2nd constructor
+

libraries/PID_RT/PID_RT.cpp

@@ -1,21 +1,9 @@
 //
-//    FILE: PID_RT.h
+//    FILE: PID_RT.cpp
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.4
+// VERSION: 0.1.5
 // PURPOSE: PID library for Arduino
 //     URL: https://github.com/RobTillaart/PID
-//
-//  HISTORY
-//  0.1.0  2020-12-15  update readme, fix unit test, 
-//                     fix library.json
-//                     add 2nd constructor
-//  0.1.1  2021-05-27  add json check, add lint check
-//  0.1.2  2021-05-28  minor edits
-//  0.1.3  2021-11-12  update build-CI, update readme
-//                     renamed variables for readability
-//                     added history
-//                     fixed bug in setK
-//  0.1.4  2021-12-23  update library.json, license, minor edits
 
 
 #include "PID_RT.h"

libraries/PID_RT/PID_RT.h

@@ -2,7 +2,7 @@
 //
 //    FILE: PID_RT.h
 //  AUTHOR: Rob Tillaart
-// VERSION: 0.1.4
+// VERSION: 0.1.5
 // PURPOSE: PID library for Arduino
 //     URL: https://github.com/RobTillaart/PID_RT
 
@@ -10,7 +10,7 @@
 #include "Arduino.h"
 
 
-#define PID_LIB_VERSION               (F("0.1.4"))
+#define PID_LIB_VERSION               (F("0.1.5"))
 
 
 class PID_RT

libraries/PID_RT/README.md

@@ -44,7 +44,7 @@ Overwrites the values set in the constructor.
 - **bool isRunning()** return the enable/disable flag.
 
 
-### Additional parameters
+### Behaviour parameters
 
 - **bool setInterval(uint32_t interval)** set the interval between two **compute()** calls. 
 Returns **true** if changed, otherwise **false**.
@@ -54,12 +54,20 @@ Returns **true** if changed, otherwise **false**.
 - **float getOutputMax()** read back setting rangeMax.
 - **void setReverse(bool reverse)** reverse behaviour, seldom needed.
 - **bool getReverse()** read back the setting.
+
+
+### K-parameters
+
 - **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.
+
+
+### Proportional
+
 - **void setPropOnInput()** this is default behaviour.
 - **void setPropOnError()** alternative.
 - **bool isPropOnInput()** read back setting.
@@ -83,8 +91,20 @@ See examples.
 
 ## Future
 
-- update documentation
+#### must
+
+- update / improve documentation
+- more testing
+
+#### should
+
 - add examples to test more
 - improve unit test
-- 
+- move all code to .cpp
+
+#### could
+
+- add reference to PID book / website?
+- investigate if it works as PI or P controller too.
+  - PI as derived or base class?
 

libraries/PID_RT/examples/PID_basic/PID_basic.ino

@@ -2,7 +2,6 @@
 //    FILE: PID_basic.ino
 //  AUTHOR: Rob Tillaart
 // PURPOSE: demo
-//    DATE: 2020-12-15
 //
 //  connect an LED to the PWM pin
 //  connect a potentiometer to A0
@@ -15,7 +14,7 @@ PID_RT PID;
 
 const int PWM_PIN = 3;  // UNO PWM pin
 
-int op = 0;;
+int op = 0;
 float input = 0;
 
 

libraries/PID_RT/library.json

@@ -15,7 +15,7 @@
     "type": "git",
     "url": "https://github.com/RobTillaart/PID_RT"
   },
-  "version": "0.1.4",
+  "version": "0.1.5",
   "license": "MIT",
   "frameworks": "arduino",
   "platforms": "*",

libraries/PID_RT/library.properties

@@ -1,5 +1,5 @@
 name=PID_RT
-version=0.1.4
+version=0.1.5
 author=Rob Tillaart <rob.tillaart@gmail.com>
 maintainer=Rob Tillaart <rob.tillaart@gmail.com>
 sentence=Arduino PID library