v1.1.0 to fix multiple-definitions linker error

### Releases v1.1.0

1. Fix `multiple-definitions` linker error. Drop `src_cpp` and `src_h` directories

Author: khoih-prog

CONTRIBUTING.md

@@ -14,9 +14,9 @@ If you don't find anything, please [open a new issue](https://github.com/khoih-p
 
 Please ensure to specify the following:
 
-* Arduino IDE version (e.g. 1.8.16) or Platform.io version
-* `ESP32` Core Version (e.g. ESP32 core v2.0.1)
-* `ESP32` Board type (e.g. ESP32_DEV Module, ESP32_S2_DEV, etc.)
+* Arduino IDE version (e.g. 1.8.19) or Platform.io version
+* `ESP32` Core Version (e.g. ESP32 core v2.0.2)
+* `ESP32` Board type (e.g. ESP32_DEV Module, ESP32_S2_DEV, ESP32_C3_DEV, etc.)
 * Contextual information (e.g. what you were trying to achieve)
 * Simplest possible steps to reproduce
 * Anything that might be relevant in your opinion, such as:
@@ -27,11 +27,11 @@ Please ensure to specify the following:
 ### Example
 
 ```
-Arduino IDE version: 1.8.16
-ESP32 Core Version 2.0.1
+Arduino IDE version: 1.8.19
+ESP32 Core Version 2.0.2
 ESP32S2_DEV Module
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.4.0-90-generic #101-Ubuntu SMP Fri Oct 15 20:00:55 UTC 2021 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.4.0-96-generic #109-Ubuntu SMP Wed Jan 12 16:49:16 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
 I encountered a crash while using ESP32_New_TimerInterrupt.

README.md

@@ -47,7 +47,6 @@
   * [5. ISR_16_Timers_Array on ESP32S2_DEV](#5-isr_16_timers_array-on-esp32s2_dev)
 * [Debug](#debug)
 * [Troubleshooting](#troubleshooting)
-* [Releases](#releases)
 * [Issues](#issues)
 * [TO DO](#to-do)
 * [DONE](#done)
@@ -64,7 +63,7 @@
 ### Important Notes
 
 1. Avoid using `PIN_D1 (GPIO1)` in your code due to issue with core v2.0.0 and v2.0.1. Check [ESP32 Core v2.0.1 / 2.0.1 RC1 crashes if using pinMode with GPIO1 #5868](https://github.com/espressif/arduino-esp32/issues/5868). Only OK with core v1.0.6-
-2. Don't use `float` in `ISR` due to issue with core v2.0.0 and v2.0.1. Only OK with core v1.0.6-.
+2. Don't use `float` in `ISR` due to issue with core v2.0.0 and v2.0.1. Check [ESP32 Core v2.0.1 / 2.0.1 RC1 crashes if using float in ISR #5892](https://github.com/espressif/arduino-esp32/issues/5892). Only OK with core v1.0.6-.
 
 ### Features
 
@@ -127,8 +126,8 @@ The catch is **your function is now part of an ISR (Interrupt Service Routine),
 
 ## Prerequisites
 
-1. [`Arduino IDE 1.8.16+` for Arduino](https://www.arduino.cc/en/Main/Software)
-2. [`ESP32 Core 2.0.1+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards (ESP32, ESP32_S2 and ESP32_C3). [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/).
+1. [`Arduino IDE 1.8.19+` for Arduino](https://github.com/arduino/Arduino). [![GitHub release](https://img.shields.io/github/release/arduino/Arduino.svg)](https://github.com/arduino/Arduino/releases/latest)
+2. [`ESP32 Core 2.0.2+`](https://github.com/espressif/arduino-esp32) for ESP32-based boards (ESP32, ESP32_S2 and ESP32_C3). [![Latest release](https://img.shields.io/github/release/espressif/arduino-esp32.svg)](https://github.com/espressif/arduino-esp32/releases/latest/).
 
 ---
 ---
@@ -167,24 +166,20 @@ Another way to install is to:
 
 ### HOWTO Fix `Multiple Definitions` Linker Error
 
-The current library implementation, using **xyz-Impl.h instead of standard xyz.cpp**, possibly creates certain `Multiple Definitions` Linker error in certain use cases. Although it's simple to just modify several lines of code, either in the library or in the application, the library is adding 2 more source directories
+The current library implementation, using `xyz-Impl.h` instead of standard `xyz.cpp`, possibly creates certain `Multiple Definitions` Linker error in certain use cases.
 
-1. **scr_h** for new h-only files
-2. **src_cpp** for standard h/cpp files
+You can use
 
-besides the standard **src** directory.
-
-To use the **old standard cpp** way, locate this library' directory, then just 
-
-1. **Delete the all the files in src directory.**
-2. **Copy all the files in src_cpp directory into src.**
-3. Close then reopen the application code in Arduino IDE, etc. to recompile from scratch.
+```
+#include <ESP32_New_ISR_Timer.hpp>               //https://github.com/khoih-prog/ESP32_New_TimerInterrupt
+```
 
-To re-use the **new h-only** way, just 
+in many files. But be sure to use the following `#include <ESP32_New_ISR_Timer.h>` **in just 1 `.h`, `.cpp` or `.ino` file**, which must **not be included in any other file**, to avoid `Multiple Definitions` Linker Error
 
-1. **Delete the all the files in src directory.**
-2. **Copy the files in src_h directory into src.**
-3. Close then reopen the application code in Arduino IDE, etc. to recompile from scratch.
+```
+// To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
+#include <ESP32_New_ISR_Timer.h>                //https://github.com/khoih-prog/ESP32_New_TimerInterrupt
+```
 
 ---
 ---
@@ -617,7 +612,7 @@ The following is the sample terminal output when running example [TimerInterrupt
 ```
 
 Starting TimerInterruptTest on ESP32_DEV
-ESP32_New_TimerInterrupt v1.0.1
+ESP32_New_TimerInterrupt v1.1.0
 CPU Frequency = 240 MHz
 [TISR] ESP32_TimerInterrupt: _timerNo = 0 , _fre = 1000000
 [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
@@ -650,7 +645,7 @@ The following is the sample terminal output when running example [Change_Interva
 
 ```
 Starting Change_Interval on ESP32_DEV
-ESP32_New_TimerInterrupt v1.0.1
+ESP32_New_TimerInterrupt v1.1.0
 CPU Frequency = 240 MHz
 Starting  ITimer0 OK, millis() = 136
 Starting  ITimer1 OK, millis() = 147
@@ -679,7 +674,7 @@ The following is the sample terminal output when running example [Argument_None]
 
 ```
 Starting Argument_None on ESP32S2_DEV
-ESP32_New_TimerInterrupt v1.0.1
+ESP32_New_TimerInterrupt v1.1.0
 CPU Frequency = 240 MHz
 [TISR] ESP32_S2_TimerInterrupt: _timerNo = 0 , _fre = 1000000
 [TISR] TIMER_BASE_CLK = 80000000 , TIMER_DIVIDER = 80
@@ -731,7 +726,7 @@ The following is the sample terminal output when running example [ISR_16_Timers_
 
 ```
 Starting ISR_16_Timers_Array_Complex on ESP32C3_DEV
-ESP32_New_TimerInterrupt v1.0.1
+ESP32_New_TimerInterrupt v1.1.0
 CPU Frequency = 160 MHz
 Starting ITimer OK, millis() = 2187
 SimpleTimer : 2, ms : 12193, Dms : 10004
@@ -882,7 +877,7 @@ The following is the sample terminal output when running example [ISR_16_Timers_
 
 ```
 Starting ISR_16_Timers_Array on ESP32S2_DEV
-ESP32_New_TimerInterrupt v1.0.1
+ESP32_New_TimerInterrupt v1.1.0
 CPU Frequency = 240 MHz
 Starting ITimer OK, millis() = 2538
 simpleTimerDoingSomething2s: Delta programmed ms = 2000, actual = 10008
@@ -918,20 +913,12 @@ Sometimes, the library will only work if you update the board core to the latest
 ---
 ---
 
-## Releases
-
-### Releases v1.0.0
-
-1. Initial coding for ESP32, ESP32_S2, ESP32_C3 boards with [ESP32 core v2.0.0-rc1+](https://github.com/espressif/arduino-esp32/releases/tag/2.0.0-rc1)
-
-
----
----
 
 ### Issues
 
 Submit issues to: [ESP32_New_TimerInterrupt issues](https://github.com/khoih-prog/ESP32_New_TimerInterrupt/issues)
 
+---
 ---
 
 ## TO DO

changelog.md

@@ -12,6 +12,7 @@
 ## Table of Contents
 
 * [Changelog](#changelog)
+  * [Releases v1.1.0](#releases-v110)
   * [Releases v1.0.1](#releases-v101)
   * [Releases v1.0.0](#releases-v100)
 
@@ -21,6 +22,10 @@
 
 ## Changelog
 
+### Releases v1.1.0
+
+1. Fix `multiple-definitions` linker error. Drop `src_cpp` and `src_h` directories
+
 ### Releases v1.0.1
 
 1. Avoid using `PIN_D1 (GPIO1)` in your code due to issue with core v2.0.0 and v2.0.1. Check [ESP32 Core v2.0.1 / 2.0.1 RC1 crashes if using pinMode with GPIO1 #5868](https://github.com/espressif/arduino-esp32/issues/5868). Only OK with core v1.0.6-

examples/RPM_Measure/RPM_Measure.ino

@@ -73,8 +73,10 @@ ESP32Timer ITimer0(0);
 volatile unsigned long rotationTime = 0;
 
 // Not using float => using RPM = 100 * real RPM
-uint32_t RPM       = 0;
-uint32_t avgRPM    = 0;
+float RPM       = 0;
+float avgRPM    = 0;
+//uint32_t RPM       = 0;
+//uint32_t avgRPM    = 0;
 
 volatile int debounceCounter;
 

keywords.txt

@@ -39,3 +39,10 @@ getNumAvailableTimers KEYWORD2
 #######################################
 # Constants (LITERAL1)
 #######################################
+
+ESP32_NEW_TIMERINTERRUPT_VERSION LITERAL1
+ESP32_NEW_TIMERINTERRUPT_VERSION_MAJOR LITERAL1
+ESP32_NEW_TIMERINTERRUPT_VERSION_MINOR LITERAL1
+ESP32_NEW_TIMERINTERRUPT_VERSION_PATCH LITERAL1
+ESP32_NEW_TIMERINTERRUPT_VERSION_INT LITERAL1
+

library.json

@@ -1,7 +1,7 @@
 {
   "name": "ESP32_New_TimerInterrupt",
-  "version": "1.0.1",
-  "keywords": "timing, device, control, timer, interrupt, timer-interrupt, hardware, isr, isr-based, hardware-timer, isr-timer, isr-based-timer, mission-critical, accuracy, precise, non-blocking, esp32, esp32-s2, esp32-c3",
+  "version": "1.1.0",
+  "keywords": "timing, device, control, timer, interrupt, timer-interrupt, hardware, isr, isr-based, hardware-timer, isr-timer, isr-based-timer, mission-critical, accuracy, precise, non-blocking, esp32, esp32-s2, esp32-c3, esp32-s3",
   "description": "This library enables you to use Interrupt from Hardware Timers on an ESP32, ESP32_S2 or ESP32_C3-based board. It now supports 16 ISR-based timers, while consuming only 1 Hardware Timer. Timers' interval is very long (ulong millisecs). The most important feature is they're ISR-based timers. Therefore, their executions are not blocked by bad-behaving functions or tasks. This important feature is absolutely necessary for mission-critical tasks. These hardware timers, using interrupt, still work even if other functions are blocking. Moreover, they are much more precise (certainly depending on clock frequency accuracy) than other software timers using millis() or micros(). That's necessary if you need to measure some data requiring better accuracy.",
   "authors":
   {
@@ -22,8 +22,9 @@
       "tests"
     ]
   },
+  "license": "MIT",
   "frameworks": "*",
   "platforms": "espressif32",
   "examples": "examples/*/*/*.ino",
-  "license": "MIT"
+  "headers": ["ESP32_New_TimerInterrupt.h", "ESP32_New_ISR_Timer.hpp", "ESP32_New_ISR_Timer.h"]
 }

library.properties

@@ -1,5 +1,5 @@
 name=ESP32_New_TimerInterrupt
-version=1.0.1
+version=1.1.0
 author=Khoi Hoang <khoih.prog@gmail.com>
 maintainer=Khoi Hoang <khoih.prog@gmail.com>
 sentence=This library enables you to use Interrupt from Hardware Timers on an ESP32, ESP32_S2 or ESP32_C3-based board
@@ -9,4 +9,4 @@ url=https://github.com/khoih-prog/ESP32_New_TimerInterrupt
 architectures=esp32
 repository=https://github.com/khoih-prog/ESP32_New_TimerInterrupt
 license=MIT
-includes=ESP32_New_TimerInterrupt.h,ESP32_New_ISR_Timer.h
+includes=ESP32_New_TimerInterrupt.h,ESP32_New_ISR_Timer.hpp,ESP32_New_ISR_Timer.h

src/ESP32_New_ISR_Timer-Impl.h

@@ -27,12 +27,13 @@
   Based on BlynkTimer.h
   Author: Volodymyr Shymanskyy
 
-  Version: 1.0.1
+  Version: 1.1.0
 
   Version Modified By   Date      Comments
   ------- -----------  ---------- -----------
   1.0.0   K Hoang      15/08/2021 Initial coding for ESP32, ESP32_S2, ESP32_C3 boards with ESP32 core v2.0.0-rc1+
   1.0.1   K.Hoang      14/11/2021 Avoid using float and D1 in examples due to issue with core v2.0.0 and v2.0.1
+  1.1.0   K.Hoang      18/01/2022 Fix `multiple-definitions` linker error.
 *****************************************************************************************************************************/
 
 #pragma once