Bumped version to 3.0.0

Author: ArminJo

.github/workflows/PlatformIoPublish.yml

@@ -1,7 +1,7 @@
 # PlatformIoPublish.yml
 # Github workflow script to publish a release to PlatformIo.
 #
-# Copyright (C) 2021  Armin Joachimsmeyer
+# Copyright (C) 2021-2022  Armin Joachimsmeyer
 # https://github.com/ArminJo/Github-Actions
 #
 

README.md

@@ -51,7 +51,7 @@ The expander in turn requires the Arduino Wire library or a [compatible one](htt
 For **ESP32** you need to install the Arduino ESP32Servo library.<br/>
 <br/>
 If you require only one or two servos, you may want to use the included [LightweightServo library](https://github.com/ArminJo/LightweightServo) (only for **AVR**), instead of the Arduino Servo library.
-The LightweightServo library uses the internal Timer1 with no software overhead and therefore has no problems with **servo jittering** or interrupt blocking libraries like SoftwareSerial, Adafruit_NeoPixel and DmxSimple.<br/>
+The LightweightServo library uses the internal Timer1 with no software overhead and therefore has no problems with **servo twitching** or interrupt blocking libraries like SoftwareSerial, Adafruit_NeoPixel and DmxSimple.<br/>
 For instructions how to enable these alternatives, see [Compile options / macros](https://github.com/ArminJo/ServoEasing#compile-options--macros-for-this-library).
 
 # Features
@@ -170,16 +170,17 @@ Values for the MG90Sservos servos at 5 volt (4.2 volt with servo active).
 | 45 | 115 ms  | 390 degree per second |
 
 # Why *.hpp files instead of *.cpp files?
-**Every *.cpp file is compiled separately** by a call of the compiler only compiling this file. These calls are managed by the IDE / make system.
-In the Arduino IDE they are issued when you click on *Verify* or *Upload*.<br/>
-The problem is: **How to set [compile options](#compile-options--macros-for-this-library) for all *.cpp files, especially for libraries used?**<br/>
-IDE's like [Sloeber](https://github.com/ArminJo/ServoEasing#modifying-compile-options--macros-with-sloeber-ide) or [PlatformIO](https://github.com/ArminJo/ServoEasing#modifying-compile-options--macros-with-platformio) support this by allowing to set this options per project.
-They in turn add these options to each compiler call e.g. `-DTRACE`.<br/>
+**Every \*.cpp file is compiled separately** by a call of the compiler exclusively for this cpp file. These calls are managed by the IDE / make system.
+In the Arduino IDE the calls are executed when you click on *Verify* or *Upload*.<br/>
+And now our problem with Arduino is: **How to set [compile options](#compile-options--macros-for-this-library) for all *.cpp files, especially for libraries used?**<br/>
+IDE's like [Sloeber](https://github.com/ArminJo/ServoEasing#modifying-compile-options--macros-with-sloeber-ide) or [PlatformIO](https://github.com/ArminJo/ServoEasing#modifying-compile-options--macros-with-platformio) support this by allowing to specify a set of options per project.
+They add these options at each compiler call e.g. `-DTRACE`.<br/>
 But Arduino lacks this feature. So the **workaround** is not to compile all sources separately, but to concatenate them to one huge source file by including them in your source.
 This is done by e.g. `#include "ServoEasing.hpp"`.<br/>
-But why not `#include "ServoEasing.cpp"`? Try it and you will see tons of errors, because each function of the *.cpp file is compiled twice,
+But why not `#include "ServoEasing.cpp"`?<br/>
+Try it and you will see tons of errors, because each function of the *.cpp file is now compiled twice,
 first by compiling the huge file and second by compiling the *.cpp file separately, like described above.
-So the extension *cpp* is not longer possible, and one solution is, to use *hpp* as extension, to show that it is an included *.cpp file.
+So using the extension *cpp* is not longer possible, and one solution is to use *hpp* as extension, to show that it is an included *.cpp file.
 Every other extension e.g. *cinclude* would do, but *hpp* seems to be common sense.
 
 # Using the new *.hpp files / how to avoid `multiple definitions` linker errors
@@ -299,10 +300,19 @@ If you see strange behavior, you can open the library file *ServoEasing.h* and a
 This will print internal information visible in the Arduino *Serial Monitor* which may help finding the reason for it.
 
 # Revision History
-### Version 2.5.0
-- Changed ENABLE_MICROS_AS_DEGREE_PARAMETER to DISABLE_MICROS_AS_DEGREE_PARAMETER thus enabling micros as parameter by default.
+### Version 3.0.0
+- Added target reached callback functionality, to enable multiple movements without loop control.
+- Changed `ENABLE_MICROS_AS_DEGREE_PARAMETER` to `DISABLE_MICROS_AS_DEGREE_PARAMETER` thus enabling micros as parameter by default.
 - Fixed some bugs for micros as parameter.
-- Improved PCA9685 handling.
+- Changed constants for easing types.
+- Additional parameter aUserDataPointer for user easing function.
+- New easing type `PRECISION`.
+- New function `printEasingType()`.
+- Easing functions are converted to static member functions now.
+- Easing types can be disabled individually.
+- Improved PCA9685 handling / support for SoftI2CMaster.
+- Changed default for parameter `doWrite` for `setTrim()` from `false` to `true`.
+- Added min and max constraints for servo write() and `DISABLE_MIN_AND_MAX_CONSTRAINTS`.
 
 ### Version 2.4.1
 - RP2040 support.

examples/QuadrupedControl/IRCommandDispatcher.hpp

@@ -60,7 +60,7 @@ IRCommandDispatcher IRDispatcher;
 #if defined(USE_TINY_IR_RECEIVER)
 #include "TinyIRReceiver.hpp" // included in "IRremote" library
 
-#if defined(INFO)
+#if defined(LOCAL_INFO)
 #define CD_INFO_PRINT(...)      Serial.print(__VA_ARGS__);
 #define CD_INFO_PRINTLN(...)    Serial.println(__VA_ARGS__);
 #else
@@ -149,11 +149,9 @@ void handleReceivedIRData()
 
     if (IRDispatcher.IRReceivedData.address == IR_ADDRESS) {
         IRDispatcher.checkAndCallCommand(true);
-#if defined(INFO)
-        } else {
+    } else {
         CD_INFO_PRINT(F("Wrong address. Expected 0x"));
         CD_INFO_PRINTLN(IR_ADDRESS, HEX);
-#endif
     }
 }
 #endif
@@ -175,14 +173,14 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
             /*
              * Command found
              */
-#if defined(INFO)
+#if defined(LOCAL_INFO)
             const __FlashStringHelper *tCommandName = reinterpret_cast<const __FlashStringHelper*>(IRMapping[i].CommandString);
 #endif
             /*
              * Check for repeat and if it is allowed for the current command
              */
             if (IRReceivedData.isRepeat && !(IRMapping[i].Flags & IR_COMMAND_FLAG_REPEATABLE)) {
-#if defined(DEBUG)
+#if defined(LOCAL_DEBUG)
                 Serial.print(F("Repeats of command \""));
                 Serial.print(tCommandName);
                 Serial.println("\" not accepted");
@@ -194,7 +192,7 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
              * Do not accept recursive call of the same command
              */
             if (currentBlockingCommandCalled == IRReceivedData.command) {
-#if defined(DEBUG)
+#if defined(LOCAL_DEBUG)
                 Serial.print(F("Recursive command \""));
                 Serial.print(tCommandName);
                 Serial.println("\" not accepted");

examples/RobotArmControl/IRCommandDispatcher.hpp

@@ -60,7 +60,7 @@ IRCommandDispatcher IRDispatcher;
 #if defined(USE_TINY_IR_RECEIVER)
 #include "TinyIRReceiver.hpp" // included in "IRremote" library
 
-#if defined(INFO)
+#if defined(LOCAL_INFO)
 #define CD_INFO_PRINT(...)      Serial.print(__VA_ARGS__);
 #define CD_INFO_PRINTLN(...)    Serial.println(__VA_ARGS__);
 #else
@@ -149,11 +149,9 @@ void handleReceivedIRData()
 
     if (IRDispatcher.IRReceivedData.address == IR_ADDRESS) {
         IRDispatcher.checkAndCallCommand(true);
-#if defined(INFO)
-        } else {
+    } else {
         CD_INFO_PRINT(F("Wrong address. Expected 0x"));
         CD_INFO_PRINTLN(IR_ADDRESS, HEX);
-#endif
     }
 }
 #endif
@@ -175,14 +173,14 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
             /*
              * Command found
              */
-#if defined(INFO)
+#if defined(LOCAL_INFO)
             const __FlashStringHelper *tCommandName = reinterpret_cast<const __FlashStringHelper*>(IRMapping[i].CommandString);
 #endif
             /*
              * Check for repeat and if it is allowed for the current command
              */
             if (IRReceivedData.isRepeat && !(IRMapping[i].Flags & IR_COMMAND_FLAG_REPEATABLE)) {
-#if defined(DEBUG)
+#if defined(LOCAL_DEBUG)
                 Serial.print(F("Repeats of command \""));
                 Serial.print(tCommandName);
                 Serial.println("\" not accepted");
@@ -194,7 +192,7 @@ void IRCommandDispatcher::checkAndCallCommand(bool aCallAlsoBlockingCommands) {
              * Do not accept recursive call of the same command
              */
             if (currentBlockingCommandCalled == IRReceivedData.command) {
-#if defined(DEBUG)
+#if defined(LOCAL_DEBUG)
                 Serial.print(F("Recursive command \""));
                 Serial.print(tCommandName);
                 Serial.println("\" not accepted");

library.json

@@ -6,7 +6,7 @@
     "type": "git",
     "url": "https://github.com/ArminJo/ServoEasing"
   },
-  "version": "2.4.1",
+  "version": "3.0.0",
   "exclude": "pictures",
   "authors": {
     "name": "Armin Joachimsmeyer",

library.properties

@@ -1,9 +1,9 @@
 name=ServoEasing
-version=2.4.1
+version=3.0.0
 author=Armin Joachimsmeyer
 maintainer=Armin Joachimsmeyer <[email protected]>
 sentence=Enables smooth servo movement. <br/>Linear as well as other (Cubic, Circular, Bounce, etc.) ease movements for servos are provided. The Arduino Servo library or PCA9685 servo expanders are supported.<br/>
-paragraph=Just use <b>myServo.easeTo()</b> instead of <b>myServo.write()</b> and you have smooth servo movement.<br/><b>Non blocking</b> movement for all servos attached to the Arduino Servo library is implemented by reusing the interrupts of the Arduino servo timer.<br/><b>All servos can move synchronized.</b><br/><br/>Includes the following <b>easing functions</b>:<ul><li><b>Linear</b>, <b>Quadratic</b>, <b>Cubic</b> and <b>Quartic</b></li><li><b>Sine</b>, <b>Circular</b>, <b>Back</b>, <b>Elastic</b> and <b>Bounce</b></li><li><b>User defined</b></li></ul>Each function supports the <b>easing types</b> <b>In</b>, <b>Out</b>, <b>InOut</b> and <b>BouncingOutIn</b><br/>Trim and reverse operations are supported as well as continuous rotating servos.<br/><br/><b>New: </b>RP2040 support.<br/><a href="https://github.com/ArminJo/ServoEasing#revision-history">Revision History</a><br/>
+paragraph=Just use <b>myServo.easeTo()</b> instead of <b>myServo.write()</b> and you have smooth servo movement.<br/><b>Non blocking</b> movement for all servos attached to the Arduino Servo library is implemented by reusing the interrupts of the Arduino servo timer.<br/><b>All servos can move synchronized.</b><br/><br/>Includes the following <b>easing functions</b>:<ul><li><b>Linear</b>, <b>Quadratic</b>, <b>Cubic</b> and <b>Quartic</b></li><li><b>Sine</b>, <b>Circular</b>, <b>Back</b>, <b>Elastic</b> and <b>Bounce</b></li><li><b>User defined</b></li></ul>Each function supports the <b>easing types</b> <b>In</b>, <b>Out</b>, <b>InOut</b> and <b>BouncingOutIn</b><br/>Trim and reverse operations are supported as well as continuous rotating servos.<br/><br/><b>New: </b>New easing type PRECISION. Added min and max constraints for servo write(). Changed constants for easing types. Fixed some bugs for micros as parameter.<br/><a href="https://github.com/ArminJo/ServoEasing#revision-history">Revision History</a><br/>
 category=Device Control
 url=https://github.com/ArminJo/ServoEasing
 architectures=avr,megaavr,sam,samd,esp8266,esp32,stm32,STM32F1,apollo3,mbed,mbed_nano,rp2040

src/ServoEasing.h

@@ -32,7 +32,7 @@
 
 /*
  * Macro to convert 3 version parts into an integer
- * To be used in preprocessor comparisons, such as #if VERSION_SERVO_EASING_HEX >= VERSION_HEX_VALUE(3, 7, 0)
+ * To be used in preprocessor comparisons, such as #if VERSION_SERVO_EASING_HEX >= VERSION_HEX_VALUE(3, 0, 0)
  */
 #define VERSION_HEX_VALUE(major, minor, patch) ((major << 16) | (minor << 8) | (patch))
 #define VERSION_SERVO_EASING_HEX  VERSION_HEX_VALUE(VERSION_SERVO_EASING_MAJOR, VERSION_SERVO_EASING_MINOR, VERSION_SERVO_EASING_PATCH)
@@ -715,9 +715,9 @@ bool checkI2CConnection(uint8_t aI2CAddress, Stream *aSerial); // Print class ha
  * - New function `printEasingType()`.
  * - Easing functions are converted to static member functions now.
  * - Easing types can be disabled individually.
- * - Improved PCA9685 handling.
+ * - Improved PCA9685 handling / support for SoftI2CMaster.
  * - Changed default for parameter `doWrite` for `setTrim()` from `false` to `true`.
- * - Add constraint functionality and `DISABLE_MIN_AND_MAX_CONSTRAINTS`.
+ * - Added min and max constraints for servo write() and `DISABLE_MIN_AND_MAX_CONSTRAINTS`.
  *
  * Version 2.4.1 - 02/2022
  * - RP2040 support added.