v.2.0 to convert to h-only library, etc

khoih-prog · web-flow · commit 60aa83a0db13 · 2022-03-06T22:40:25.000-05:00
### Releases v1.2.0

1. Add support to new `ESP32-S3` (ESP32S3_DEV, ESP32_S3_BOX, UM TINYS3, UM PROS3, UM FEATHERS3, etc.)
2. Add support to new `ESP32-S2` (ESP32S2_DEV, etc.)
3. Add support to new `ESP32-C3` (ESP32C3_DEV, etc.)
4. Convert to h-only library.
5. Optimize library code by using `reference-passing` instead of `value-passing`
6. Improve accuracy by using `float`, instead of `uint32_t` for `position` in degrees
7. Add example [multiFileProject](examples/multiFileProject) to demo for multiple-file project
diff --git a/examples/ESP32_ISR_MultiServos/ESP32_ISR_MultiServos.ino b/examples/ESP32_ISR_MultiServos/ESP32_ISR_MultiServos.ino
@@ -26,15 +26,6 @@
    if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
    If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
    or the entire sequence of your code which accesses the data.
-
-   Version: 1.1.0
-
-   Version Modified By   Date      Comments
-   ------- -----------  ---------- -----------
-    1.0.0   K Hoang      12/12/2019 Initial coding
-    1.0.1   K Hoang      13/12/2019 Add more features getPosition and getPulseWidth. Optimize.
-    1.0.2   K Hoang      20/12/2019 Add more Blynk examples.Change example names to avoid duplication.
-    1.1.0   K Hoang      03/01/2021 Fix bug. Add TOC and Version String.
 *****************************************************************************************************************************/
 
 /****************************************************************************************************************************
@@ -88,6 +79,7 @@
 // Select different ESP32 timer number (0-3) to avoid conflict
 #define USE_ESP32_TIMER_NO          3
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32_ISR_Servo.h"
 
 //See file .../hardware/espressif/esp32/variants/(esp32|doitESP32devkitV1)/pins_arduino.h
@@ -157,8 +149,8 @@ void setup()
   //Select ESP32 timer USE_ESP32_TIMER_NO
   ESP32_ISR_Servos.useTimer(USE_ESP32_TIMER_NO);
 
-  servoIndex1 = ESP32_ISR_Servos.setupServo(PIN_D25, MIN_MICROS, MAX_MICROS);
-  servoIndex2 = ESP32_ISR_Servos.setupServo(PIN_D26, MIN_MICROS, MAX_MICROS);
+  servoIndex1 = ESP32_ISR_Servos.setupServo(PIN_D3, MIN_MICROS, MAX_MICROS);
+  servoIndex2 = ESP32_ISR_Servos.setupServo(PIN_D4, MIN_MICROS, MAX_MICROS);
 
   if (servoIndex1 != -1)
     Serial.println(F("Setup Servo1 OK"));
diff --git a/examples/ESP32_MultipleRandomServos/ESP32_MultipleRandomServos.ino b/examples/ESP32_MultipleRandomServos/ESP32_MultipleRandomServos.ino
@@ -26,15 +26,6 @@
    if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
    If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
    or the entire sequence of your code which accesses the data.
-
-   Version: 1.1.0
-
-   Version Modified By   Date      Comments
-   ------- -----------  ---------- -----------
-    1.0.0   K Hoang      12/12/2019 Initial coding
-    1.0.1   K Hoang      13/12/2019 Add more features getPosition and getPulseWidth. Optimize.
-    1.0.2   K Hoang      20/12/2019 Add more Blynk examples.Change example names to avoid duplication.
-    1.1.0   K Hoang      03/01/2021 Fix bug. Add TOC and Version String.
  *****************************************************************************************************************************/
 /****************************************************************************************************************************
    This example will demonstrate the nearly perfect accuracy compared to software timers by printing the actual elapsed millisecs.
@@ -86,6 +77,7 @@
 // Select different ESP32 timer number (0-3) to avoid conflict
 #define USE_ESP32_TIMER_NO          3
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32_ISR_Servo.h"
 
 //See file .../hardware/espressif/esp32/variants/(esp32|doitESP32devkitV1)/pins_arduino.h
@@ -149,7 +141,7 @@ typedef struct
 
 ISR_servo_t ISR_servo[NUM_SERVOS] =
 {
-  { -1, PIN_D21 }, { -1, PIN_D22 }, { -1, PIN_D23 }, { -1, PIN_D24 }, { -1, PIN_D25 }, { -1, PIN_D26 }
+  { -1, PIN_D1 }, { -1, PIN_D2 }, { -1, PIN_D3 }, { -1, PIN_D4 }, { -1, PIN_D5 }, { -1, PIN_D6 }
 };
 
 void setup()
diff --git a/examples/ESP32_MultipleServos/ESP32_MultipleServos.ino b/examples/ESP32_MultipleServos/ESP32_MultipleServos.ino
@@ -26,15 +26,6 @@
    if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
    If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
    or the entire sequence of your code which accesses the data.
-
-   Version: 1.1.0
-
-   Version Modified By   Date      Comments
-   ------- -----------  ---------- -----------
-    1.0.0   K Hoang      12/12/2019 Initial coding
-    1.0.1   K Hoang      13/12/2019 Add more features getPosition and getPulseWidth. Optimize.
-    1.0.2   K Hoang      20/12/2019 Add more Blynk examples.Change example names to avoid duplication.
-    1.1.0   K Hoang      03/01/2021 Fix bug. Add TOC and Version String.
 *****************************************************************************************************************************/
 
 /****************************************************************************************************************************
@@ -78,7 +69,7 @@
    Experimentally, 550 and 2350 are pretty close to 0 and 180.
 *****************************************************************************************************************************/
 #ifndef ESP32
-#error This code is designed to run on ESP32 platform, not Arduino nor ESP8266! Please check your Tools->Board setting.
+  #error This code is designed to run on ESP32 platform, not Arduino nor ESP8266! Please check your Tools->Board setting.
 #endif
 
 #define TIMER_INTERRUPT_DEBUG       1
@@ -87,6 +78,7 @@
 // Select different ESP32 timer number (0-3) to avoid conflict
 #define USE_ESP32_TIMER_NO          3
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32_ISR_Servo.h"
 
 //See file .../hardware/espressif/esp32/variants/(esp32|doitESP32devkitV1)/pins_arduino.h
@@ -150,7 +142,7 @@ typedef struct
 
 ISR_servo_t ISR_servo[NUM_SERVOS] =
 {
-  { -1, PIN_D21 }, { -1, PIN_D22 }, { -1, PIN_D23 }, { -1, PIN_D24 }, { -1, PIN_D25 }, { -1, PIN_D26 }
+  { -1, PIN_D1 }, { -1, PIN_D2 }, { -1, PIN_D3 }, { -1, PIN_D4 }, { -1, PIN_D5 }, { -1, PIN_D6 }
 };
 
 void setup()
diff --git a/examples/ISR_MultiServos/ISR_MultiServos.ino b/examples/ISR_MultiServos/ISR_MultiServos.ino
@@ -26,15 +26,6 @@
    if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
    If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
    or the entire sequence of your code which accesses the data.
-
-   Version: 1.1.0
-
-   Version Modified By   Date      Comments
-   ------- -----------  ---------- -----------
-    1.0.0   K Hoang      12/12/2019 Initial coding
-    1.0.1   K Hoang      13/12/2019 Add more features getPosition and getPulseWidth. Optimize.
-    1.0.2   K Hoang      20/12/2019 Add more Blynk examples.Change example names to avoid duplication.
-    1.1.0   K Hoang      03/01/2021 Fix bug. Add TOC and Version String.
 *****************************************************************************************************************************/
 
 /****************************************************************************************************************************
@@ -88,6 +79,7 @@
 // Select different ESP32 timer number (0-3) to avoid conflict
 #define USE_ESP32_TIMER_NO          3
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32_ISR_Servo.h"
 
 //See file .../hardware/espressif/esp32/variants/(esp32|doitESP32devkitV1)/pins_arduino.h
@@ -157,8 +149,8 @@ void setup()
   //Select ESP32 timer USE_ESP32_TIMER_NO
   ESP32_ISR_Servos.useTimer(USE_ESP32_TIMER_NO);
 
-  servoIndex1 = ESP32_ISR_Servos.setupServo(PIN_D25, MIN_MICROS, MAX_MICROS);
-  servoIndex2 = ESP32_ISR_Servos.setupServo(PIN_D26, MIN_MICROS, MAX_MICROS);
+  servoIndex1 = ESP32_ISR_Servos.setupServo(PIN_D5, MIN_MICROS, MAX_MICROS);
+  servoIndex2 = ESP32_ISR_Servos.setupServo(PIN_D6, MIN_MICROS, MAX_MICROS);
 
   if (servoIndex1 != -1)
     Serial.println(F("Setup Servo1 OK"));
diff --git a/examples/MultipleRandomServos/MultipleRandomServos.ino b/examples/MultipleRandomServos/MultipleRandomServos.ino
@@ -26,15 +26,6 @@
    if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
    If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
    or the entire sequence of your code which accesses the data.
-
-   Version: 1.1.0
-
-   Version Modified By   Date      Comments
-   ------- -----------  ---------- -----------
-    1.0.0   K Hoang      12/12/2019 Initial coding
-    1.0.1   K Hoang      13/12/2019 Add more features getPosition and getPulseWidth. Optimize.
-    1.0.2   K Hoang      20/12/2019 Add more Blynk examples.Change example names to avoid duplication.
-    1.1.0   K Hoang      03/01/2021 Fix bug. Add TOC and Version String.
 *****************************************************************************************************************************/
 
 /****************************************************************************************************************************
@@ -87,6 +78,7 @@
 // Select different ESP32 timer number (0-3) to avoid conflict
 #define USE_ESP32_TIMER_NO          3
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32_ISR_Servo.h"
 
 //See file .../hardware/espressif/esp32/variants/(esp32|doitESP32devkitV1)/pins_arduino.h
@@ -150,7 +142,7 @@ typedef struct
 
 ISR_servo_t ISR_servo[NUM_SERVOS] =
 {
-  { -1, PIN_D21 }, { -1, PIN_D22 }, { -1, PIN_D23 }, { -1, PIN_D24 }, { -1, PIN_D25 }, { -1, PIN_D26 }
+  { -1, PIN_D1 }, { -1, PIN_D2 }, { -1, PIN_D3 }, { -1, PIN_D4 }, { -1, PIN_D5 }, { -1, PIN_D6 }
 };
 
 void setup()
diff --git a/examples/MultipleServos/MultipleServos.ino b/examples/MultipleServos/MultipleServos.ino
@@ -26,15 +26,6 @@
    if the interrupt changes a multi-byte variable between a sequence of instructions, it can be read incorrectly.
    If your data is multiple variables, such as an array and a count, usually interrupts need to be disabled
    or the entire sequence of your code which accesses the data.
-
-   Version: 1.1.0
-
-   Version Modified By   Date      Comments
-   ------- -----------  ---------- -----------
-    1.0.0   K Hoang      12/12/2019 Initial coding
-    1.0.1   K Hoang      13/12/2019 Add more features getPosition and getPulseWidth. Optimize.
-    1.0.2   K Hoang      20/12/2019 Add more Blynk examples.Change example names to avoid duplication.
-    1.1.0   K Hoang      03/01/2021 Fix bug. Add TOC and Version String.
 *****************************************************************************************************************************/
 
 /****************************************************************************************************************************
@@ -78,7 +69,7 @@
    Experimentally, 550 and 2350 are pretty close to 0 and 180.
 *****************************************************************************************************************************/
 #ifndef ESP32
-#error This code is designed to run on ESP32 platform, not Arduino nor ESP8266! Please check your Tools->Board setting.
+  #error This code is designed to run on ESP32 platform, not Arduino nor ESP8266! Please check your Tools->Board setting.
 #endif
 
 #define TIMER_INTERRUPT_DEBUG       1
@@ -87,6 +78,7 @@
 // Select different ESP32 timer number (0-3) to avoid conflict
 #define USE_ESP32_TIMER_NO          3
 
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP32_ISR_Servo.h"
 
 //See file .../hardware/espressif/esp32/variants/(esp32|doitESP32devkitV1)/pins_arduino.h
@@ -150,7 +142,7 @@ typedef struct
 
 ISR_servo_t ISR_servo[NUM_SERVOS] =
 {
-  { -1, PIN_D21 }, { -1, PIN_D22 }, { -1, PIN_D23 }, { -1, PIN_D24 }, { -1, PIN_D25 }, { -1, PIN_D26 }
+  { -1, PIN_D1 }, { -1, PIN_D2 }, { -1, PIN_D3 }, { -1, PIN_D4 }, { -1, PIN_D5 }, { -1, PIN_D6 }
 };
 
 void setup()
diff --git a/examples/multiFileProject/multiFileProject.cpp b/examples/multiFileProject/multiFileProject.cpp
@@ -0,0 +1,12 @@
+/****************************************************************************************************************************
+  multiFileProject.cpp
+  For ESP32 boards
+  Written by Khoi Hoang
+  
+  Built by Khoi Hoang https://github.com/khoih-prog/ESP32_ISR_Servo
+  Licensed under MIT license
+*****************************************************************************************************************************/
+
+// To demo how to include files in multi-file Projects
+
+#include "multiFileProject.h"
diff --git a/examples/multiFileProject/multiFileProject.h b/examples/multiFileProject/multiFileProject.h
@@ -0,0 +1,15 @@
+/****************************************************************************************************************************
+  multiFileProject.h
+  For ESP32 boards
+  Written by Khoi Hoang
+  
+  Built by Khoi Hoang https://github.com/khoih-prog/ESP32_ISR_Servo
+  Licensed under MIT license
+*****************************************************************************************************************************/
+
+// To demo how to include files in multi-file Projects
+
+#pragma once
+
+// Can be included as many times as necessary, without `Multiple Definitions` Linker Error
+#include "ESP32_ISR_Servo.hpp"
diff --git a/examples/multiFileProject/multiFileProject.ino b/examples/multiFileProject/multiFileProject.ino
@@ -0,0 +1,44 @@
+/****************************************************************************************************************************
+  multiFileProject.ino
+  For ESP32 boards
+  Written by Khoi Hoang
+  
+  Built by Khoi Hoang https://github.com/khoih-prog/ESP32_ISR_Servo
+  Licensed under MIT license
+*****************************************************************************************************************************/
+
+// To demo how to include files in multi-file Projects
+
+#ifndef ESP32
+  #error This code is designed to run on ESP32 platform, not Arduino nor ESP32! Please check your Tools->Board setting.
+#endif
+
+#define ESP32_ISR_SERVO_VERSION_MIN_TARGET      "ESP32_ISR_Servo v1.2.0"
+#define ESP32_ISR_SERVO_VERSION_MIN             1002000
+
+#include "multiFileProject.h"
+
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
+#include "ESP32_ISR_Servo.h"
+
+void setup() 
+{
+  Serial.begin(115200);
+  while (!Serial);
+  
+  Serial.println("\nStart multiFileProject");
+  Serial.println(ESP32_ISR_SERVO_VERSION);
+
+#if defined(ESP32_ISR_SERVO_VERSION_MIN)
+  if (ESP32_ISR_SERVO_VERSION_INT < ESP32_ISR_SERVO_VERSION_MIN)
+  {
+    Serial.print("Warning. Must use this example on Version equal or later than : ");
+    Serial.println(ESP32_ISR_SERVO_VERSION_MIN_TARGET);
+  }
+#endif
+}
+
+void loop() 
+{
+  // put your main code here, to run repeatedly:
+}
