v1.2.0

### Releases v1.2.0 1. Add better debug feature. 2. Optimize code and examples to reduce RAM usage 3. Add Table of Contents
khoih-prog · Jan 11, 2021 · f9ee49b · f9ee49b
1 parent d988189
commit f9ee49b
Show file tree

Hide file tree

Showing 4 changed files with 34 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -346,7 +346,7 @@ Before using any Timer, you have to make sure the Timer has not been used by any
 
 ### 1. Using only Hardware Timer directly
 
-#### 1.1 Init Hardware Timer
+### 1.1 Init Hardware Timer
 
 ```
 // You can select Teensy Hardware Timer  from TEENSY_TIMER_1 or TEENSY_TIMER_3
@@ -355,7 +355,7 @@ Before using any Timer, you have to make sure the Timer has not been used by any
 TeensyTimer ITimer0(TEENSY_TIMER_1);
 ```
 
-#### 1.2 Set Hardware Timer Interval and attach Timer Interrupt Handler function
+### 1.2 Set Hardware Timer Interval and attach Timer Interrupt Handler function
 
 Use one of these functions with **interval in unsigned long milliseconds**
 
@@ -438,7 +438,7 @@ void setup()
 
 The 16 ISR_based Timers, designed for long timer intervals, only support using **unsigned long millisec intervals**. If you have to use much higher frequency or sub-millisecond interval, you have to use the Hardware Timers directly as in [1.3 Set Hardware Timer Frequency and attach Timer Interrupt Handler function](#13-set-hardware-timer-frequency-and-attach-timer-interrupt-handler-function)
 
-#### 2.2 Init Hardware Timer and ISR-based Timer
+### 2.2 Init Hardware Timer and ISR-based Timer
 
 ```
 // You can select Teensy Hardware Timer  from TEENSY_TIMER_1 or TEENSY_TIMER_3
@@ -451,7 +451,7 @@ TeensyTimer ITimer(TEENSY_TIMER_1);
 Teensy_ISR_Timer ISR_Timer;
 ```
 
-#### 2.3 Set Hardware Timer Interval and attach Timer Interrupt Handler functions
+### 2.3 Set Hardware Timer Interval and attach Timer Interrupt Handler functions
 
 ```
 void TimerHandler(void)

diff --git a/src/TeensyTimerInterrupt.h b/src/TeensyTimerInterrupt.h
@@ -31,6 +31,9 @@
 
 #pragma once
 
+#ifndef TEENSYTIMERINTERRUPT_H
+#define TEENSYTIMERINTERRUPT_H
+
 #if !( defined(CORE_TEENSY) || defined(TEENSYDUINO) )
   #error This code is designed to run on Teensy platform! Please check your Tools->Board setting.
 #endif
@@ -116,7 +119,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -232,7 +235,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -457,7 +460,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -601,7 +604,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -828,7 +831,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -962,7 +965,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -1098,4 +1101,4 @@ ISR(TIMER3_OVF_vect)
 
 ////////////////////////////////////////////////////////////////////////////////
 
-
+#endif    // TEENSYTIMERINTERRUPT_H
diff --git a/src_cpp/TeensyTimerInterrupt.h b/src_cpp/TeensyTimerInterrupt.h
@@ -31,6 +31,9 @@
 
 #pragma once
 
+#ifndef TEENSYTIMERINTERRUPT_H
+#define TEENSYTIMERINTERRUPT_H
+
 #if !( defined(CORE_TEENSY) || defined(TEENSYDUINO) )
   #error This code is designed to run on Teensy platform! Please check your Tools->Board setting.
 #endif
@@ -116,7 +119,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -232,7 +235,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -457,7 +460,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -601,7 +604,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -828,7 +831,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -962,7 +965,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -1098,4 +1101,4 @@ ISR(TIMER3_OVF_vect)
 
 ////////////////////////////////////////////////////////////////////////////////
 
-
+#endif    // TEENSYTIMERINTERRUPT_H
diff --git a/src_h/TeensyTimerInterrupt.h b/src_h/TeensyTimerInterrupt.h
@@ -31,6 +31,9 @@
 
 #pragma once
 
+#ifndef TEENSYTIMERINTERRUPT_H
+#define TEENSYTIMERINTERRUPT_H
+
 #if !( defined(CORE_TEENSY) || defined(TEENSYDUINO) )
   #error This code is designed to run on Teensy platform! Please check your Tools->Board setting.
 #endif
@@ -116,7 +119,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -232,7 +235,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -457,7 +460,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -601,7 +604,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -828,7 +831,7 @@ class TeensyTimerInterrupt
     }
 
     // frequency (in hertz) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool setFrequency(float frequency, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval((float) (1000000.0f / frequency), callback);
@@ -962,7 +965,7 @@ class TeensyTimerInterrupt
     }
 
     // interval (in microseconds) and duration (in milliseconds). Duration = 0 or not specified => run indefinitely
-    // No params and duration now. To be addes in the future by adding similar functions here or to NRF52-hal-timer.c
+    // No params and duration now. To be added in the future by adding similar functions here or to NRF52-hal-timer.c
     bool attachInterruptInterval(unsigned long interval, timerCallback callback) __attribute__((always_inline))
     {
       return setInterval(interval, callback);
@@ -1098,4 +1101,4 @@ ISR(TIMER3_OVF_vect)
 
 ////////////////////////////////////////////////////////////////////////////////
 
-
+#endif    // TEENSYTIMERINTERRUPT_H