Update README.md and useallman astyle

Author: khoih-prog

CONTRIBUTING.md

@@ -30,24 +30,45 @@ Arduino IDE version: v1.8.19
 ESP8266 Core Version v3.0.2
 ESP8266_NODEMCU
 OS: Ubuntu 20.04 LTS
-Linux xy-Inspiron-3593 5.13.0-35-generic #40~20.04.1-Ubuntu SMP Mon Mar 7 09:18:32 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
+Linux xy-Inspiron-3593 5.15.0-52-generic #58~20.04.1-Ubuntu SMP Thu Oct 13 13:09:46 UTC 2022 x86_64 x86_64 x86_64 GNU/Linux
 
 Context:
-I encountered a crash while trying to use the Timer Interrupt.
+I encountered a crash while trying to use the library
 
 Steps to reproduce:
 1. ...
 2. ...
 3. ...
 4. ...
 ```
+
+---
+
 ### Sending Feature Requests
 
 Feel free to post feature requests. It's helpful if you can explain exactly why the feature would be useful.
 
 There are usually some outstanding feature requests in the [existing issues list](https://github.com/khoih-prog/ESP8266TimerInterrupt/issues?q=is%3Aopen+is%3Aissue+label%3Aenhancement), feel free to add comments to them.
 
+---
+
 ### Sending Pull Requests
 
 Pull Requests with changes and fixes are also welcome!
 
+Please use the `astyle` to reformat the updated library code as follows (demo for Ubuntu Linux)
+
+1. Change directory to the library GitHub
+
+```
+xy@xy-Inspiron-3593:~$ cd Arduino/xy/ESP8266TimerInterrupt_GitHub/
+xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266TimerInterrupt_GitHub$
+```
+
+2. Issue astyle command
+
+```
+xy@xy-Inspiron-3593:~/Arduino/xy/ESP8266TimerInterrupt_GitHub$ bash utils/restyle.sh
+```
+
+

README.md

@@ -6,8 +6,11 @@
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
 [![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESP8266TimerInterrupt.svg)](http://github.com/khoih-prog/ESP8266TimerInterrupt/issues)
 
+
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
 <a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
+<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
+<a href="https://profile-counter.glitch.me/khoih-prog-ESP8266TimerInterrupt/count.svg" title="ESP8266TimerInterrupt Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-ESP8266TimerInterrupt/count.svg" style="height: 30px;width: 200px;"></a>
 
 ---
 ---
@@ -180,14 +183,14 @@ The current library implementation, using `xyz-Impl.h` instead of standard `xyz.
 
 You can use
 
-```
+```cpp
 #include "ESP8266TimerInterrupt.h"             //https://github.com/khoih-prog/ESP8266TimerInterrupt
 #include "ESP8266_ISR_Timer.hpp"               //https://github.com/khoih-prog/ESP8266TimerInterrupt
 ```
 
 in many files. But be sure to use the following `#include <ESP8266_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
 
-```
+```cpp
 // To be included only in main(), .ino with setup() to avoid `Multiple Definitions` Linker Error
 #include "ESP8266_ISR_Timer.h"                //https://github.com/khoih-prog/ESP8266TimerInterrupt
 ```
@@ -260,7 +263,7 @@ Using 256 prescaler, maximum Timer1 interval is only 26.843542 seconds !!!
 
 ### 1.1 Init Hardware Timer
 
-```
+```cpp
 // Select a Timer Clock
 #define USING_TIM_DIV1                false           // for shortest and most accurate timer
 #define USING_TIM_DIV16               false           // for medium time and medium accurate timer
@@ -274,7 +277,7 @@ ESP8266Timer ITimer;
 
 Use one of these functions with **interval in unsigned long milliseconds**
 
-```
+```cpp
 // interval (in microseconds)
 bool setInterval(unsigned long interval, timer_callback callback)
 
@@ -284,7 +287,7 @@ bool attachInterruptInterval(unsigned long interval, timer_callback callback)
 
 as follows
 
-```
+```cpp
 void IRAM_ATTR TimerHandler()
 {
   // Doing something here inside ISR
@@ -311,7 +314,7 @@ void setup()
 
 Use one of these functions with **frequency in float Hz**
 
-```
+```cpp
 // frequency (in hertz)
 bool setFrequency(float frequency, timer_callback callback)
 
@@ -321,7 +324,7 @@ bool attachInterrupt(float frequency, timer_callback callback)
 
 as follows
 
-```
+```cpp
 void TimerHandler()
 {
   // Doing something here inside ISR
@@ -350,7 +353,7 @@ The 16 ISR_based Timers, designed for long timer intervals, only support using *
 
 ### 2.2 Init Hardware Timer and ISR-based Timer
 
-```
+```cpp
 // Select a Timer Clock
 #define USING_TIM_DIV1                false           // for shortest and most accurate timer
 #define USING_TIM_DIV16               false           // for medium time and medium accurate timer
@@ -368,7 +371,7 @@ ESP8266_ISR_Timer ISR_Timer;
 
 ### 2.3 Set Hardware Timer Interval and attach Timer Interrupt Handler functions
 
-```
+```cpp
 void IRAM_ATTR TimerHandler()
 {
   ISR_timer.run();

changelog.md

@@ -6,6 +6,12 @@
 [![contributions welcome](https://img.shields.io/badge/contributions-welcome-brightgreen.svg?style=flat)](#Contributing)
 [![GitHub issues](https://img.shields.io/github/issues/khoih-prog/ESP8266TimerInterrupt.svg)](http://github.com/khoih-prog/ESP8266TimerInterrupt/issues)
 
+
+<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://cdn.buymeacoffee.com/buttons/v2/default-yellow.png" alt="Donate to my libraries using BuyMeACoffee" style="height: 50px !important;width: 181px !important;" ></a>
+<a href="https://www.buymeacoffee.com/khoihprog6" title="Donate to my libraries using BuyMeACoffee"><img src="https://img.shields.io/badge/buy%20me%20a%20coffee-donate-orange.svg?logo=buy-me-a-coffee&logoColor=FFDD00" style="height: 20px !important;width: 200px !important;" ></a>
+<a href="https://profile-counter.glitch.me/khoih-prog/count.svg" title="Total khoih-prog Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog/count.svg" style="height: 30px;width: 200px;"></a>
+<a href="https://profile-counter.glitch.me/khoih-prog-ESP8266TimerInterrupt/count.svg" title="ESP8266TimerInterrupt Visitor count"><img src="https://profile-counter.glitch.me/khoih-prog-ESP8266TimerInterrupt/count.svg" style="height: 30px;width: 200px;"></a>
+
 ---
 ---
 

examples/Argument_None/Argument_None.ino

@@ -63,7 +63,8 @@ void IRAM_ATTR TimerHandler()
   }
 
 #if (TIMER_INTERRUPT_DEBUG > 0)
-  Serial.print("Delta ms = "); Serial.println(millis() - lastMillis);
+  Serial.print("Delta ms = ");
+  Serial.println(millis() - lastMillis);
   lastMillis = millis();
 #endif
 
@@ -80,19 +81,24 @@ ESP8266Timer ITimer;
 void setup()
 {
   Serial.begin(115200);
-  while (!Serial);
-  
-  delay(300);
 
-  Serial.print(F("\nStarting Argument_None on ")); Serial.println(ARDUINO_BOARD);
+  while (!Serial && millis() < 5000);
+
+  delay(500);
+
+  Serial.print(F("\nStarting Argument_None on "));
+  Serial.println(ARDUINO_BOARD);
   Serial.println(ESP8266_TIMER_INTERRUPT_VERSION);
-  Serial.print(F("CPU Frequency = ")); Serial.print(F_CPU / 1000000); Serial.println(F(" MHz"));
+  Serial.print(F("CPU Frequency = "));
+  Serial.print(F_CPU / 1000000);
+  Serial.println(F(" MHz"));
 
   // Interval in microsecs
   if (ITimer.attachInterruptInterval(TIMER_INTERVAL_MS * 1000, TimerHandler))
   {
     lastMillis = millis();
-    Serial.print(F("Starting  ITimer OK, millis() = ")); Serial.println(lastMillis);
+    Serial.print(F("Starting  ITimer OK, millis() = "));
+    Serial.println(lastMillis);
   }
   else
     Serial.println(F("Can't set ITimer correctly. Select another freq. or interval"));

examples/Change_Interval/Change_Interval.ino

@@ -60,8 +60,10 @@ ESP8266Timer ITimer;
 
 void printResult(uint32_t currTime)
 {
-  Serial.print(F("Time = ")); Serial.print(currTime); 
-  Serial.print(F(", TimerCount = ")); Serial.println(TimerCount);
+  Serial.print(F("Time = "));
+  Serial.print(currTime);
+  Serial.print(F(", TimerCount = "));
+  Serial.println(TimerCount);
 }
 
 void TimerHandler()
@@ -79,20 +81,25 @@ void TimerHandler()
 void setup()
 {
   pinMode(LED_BUILTIN, OUTPUT);
-  
+
   Serial.begin(115200);
-  while (!Serial);
 
-  delay(300);
+  while (!Serial && millis() < 5000);
+
+  delay(500);
 
-  Serial.print(F("\nStarting Change_Interval on ")); Serial.println(ARDUINO_BOARD);
+  Serial.print(F("\nStarting Change_Interval on "));
+  Serial.println(ARDUINO_BOARD);
   Serial.println(ESP8266_TIMER_INTERRUPT_VERSION);
-  Serial.print(F("CPU Frequency = ")); Serial.print(F_CPU / 1000000); Serial.println(F(" MHz"));
- 
+  Serial.print(F("CPU Frequency = "));
+  Serial.print(F_CPU / 1000000);
+  Serial.println(F(" MHz"));
+
   // Interval in microsecs
   if (ITimer.attachInterruptInterval(TIMER_INTERVAL_MS * 1000, TimerHandler))
   {
-    Serial.print(F("Starting  ITimer OK, millis() = ")); Serial.println(millis());
+    Serial.print(F("Starting  ITimer OK, millis() = "));
+    Serial.println(millis());
   }
   else
     Serial.println(F("Can't set ITimer. Select another freq. or timer"));
@@ -119,11 +126,12 @@ void loop()
     {
       //setInterval(unsigned long interval, timerCallback callback)
       multFactor = (multFactor + 1) % 2;
-      
+
       ITimer.setInterval(TIMER_INTERVAL_MS * 1000 * (multFactor + 1), TimerHandler);
 
-      Serial.print(F("Changing Interval, Timer = ")); Serial.println(TIMER_INTERVAL_MS * (multFactor + 1));
-      
+      Serial.print(F("Changing Interval, Timer = "));
+      Serial.println(TIMER_INTERVAL_MS * (multFactor + 1));
+
       lastChangeTime = currTime;
     }
   }

examples/ISR_16_Timers_Array/ISR_16_Timers_Array.ino

@@ -129,8 +129,11 @@ typedef void (*irqCallback)  ();
 #if (TIMER_INTERRUPT_DEBUG > 0)
 void printStatus(uint16_t index, unsigned long deltaMillis, unsigned long currentMillis)
 {
-  Serial.print(TimerInterval[index] / 1000); Serial.print("s: Delta ms = "); Serial.print(deltaMillis);
-  Serial.print(", ms = "); Serial.println(currentMillis);
+  Serial.print(TimerInterval[index] / 1000);
+  Serial.print("s: Delta ms = ");
+  Serial.print(deltaMillis);
+  Serial.print(", ms = ");
+  Serial.println(currentMillis);
 }
 #endif
 
@@ -385,28 +388,35 @@ void simpleTimerDoingSomething2s()
 {
   static unsigned long previousMillis = startMillis;
 
-  Serial.print(F("simpleTimerDoingSomething2s: Delta programmed ms = ")); Serial.print(SIMPLE_TIMER_MS);
-  Serial.print(F(", actual = ")); Serial.println(millis() - previousMillis);
+  Serial.print(F("simpleTimerDoingSomething2s: Delta programmed ms = "));
+  Serial.print(SIMPLE_TIMER_MS);
+  Serial.print(F(", actual = "));
+  Serial.println(millis() - previousMillis);
 
   previousMillis = millis();
 }
 
 void setup()
 {
   Serial.begin(115200);
-  while (!Serial);
 
-  delay(300);
+  while (!Serial && millis() < 5000);
 
-  Serial.print(F("\nStarting ISR_16_Timers_Array on ")); Serial.println(ARDUINO_BOARD);
+  delay(500);
+
+  Serial.print(F("\nStarting ISR_16_Timers_Array on "));
+  Serial.println(ARDUINO_BOARD);
   Serial.println(ESP8266_TIMER_INTERRUPT_VERSION);
-  Serial.print(F("CPU Frequency = ")); Serial.print(F_CPU / 1000000); Serial.println(F(" MHz"));
+  Serial.print(F("CPU Frequency = "));
+  Serial.print(F_CPU / 1000000);
+  Serial.println(F(" MHz"));
 
   // Interval in microsecs
   if (ITimer.attachInterruptInterval(HW_TIMER_INTERVAL_MS * 1000, TimerHandler))
   {
     startMillis = millis();
-    Serial.print(F("Starting ITimer OK, millis() = ")); Serial.println(startMillis);
+    Serial.print(F("Starting ITimer OK, millis() = "));
+    Serial.println(startMillis);
   }
   else
     Serial.println(F("Can't set ITimer. Select another freq. or timer"));

examples/ISR_16_Timers_Array_Complex/ISR_16_Timers_Array_Complex.ino

@@ -82,7 +82,7 @@ ESP8266_ISR_Timer ISR_Timer;
 #define LED_TOGGLE_INTERVAL_MS        2000L
 
 void IRAM_ATTR TimerHandler()
-{ 
+{
   static bool toggle  = false;
   static int timeRun  = 0;
 
@@ -290,20 +290,29 @@ void simpleTimerDoingSomething2s()
 
   unsigned long currMillis = millis();
 
-  Serial.print(F("SimpleTimer : ")); Serial.print(SIMPLE_TIMER_MS / 1000);
-  Serial.print(F(", ms : ")); Serial.print(currMillis);
-  Serial.print(F(", Dms : ")); Serial.println(currMillis - previousMillis);
+  Serial.print(F("SimpleTimer : "));
+  Serial.print(SIMPLE_TIMER_MS / 1000);
+  Serial.print(F(", ms : "));
+  Serial.print(currMillis);
+  Serial.print(F(", Dms : "));
+  Serial.println(currMillis - previousMillis);
 
   for (uint16_t i = 0; i < NUMBER_ISR_TIMERS; i++)
   {
 #if USE_COMPLEX_STRUCT
-    Serial.print(F("Timer : ")); Serial.print(i);
-    Serial.print(F(", programmed : ")); Serial.print(curISRTimerData[i].TimerInterval);
-    Serial.print(F(", actual : ")); Serial.println(curISRTimerData[i].deltaMillis);
+    Serial.print(F("Timer : "));
+    Serial.print(i);
+    Serial.print(F(", programmed : "));
+    Serial.print(curISRTimerData[i].TimerInterval);
+    Serial.print(F(", actual : "));
+    Serial.println(curISRTimerData[i].deltaMillis);
 #else
-    Serial.print(F("Timer : ")); Serial.print(i);
-    Serial.print(F(", programmed : ")); Serial.print(TimerInterval[i]);
-    Serial.print(F(", actual : ")); Serial.println(deltaMillis[i]);
+    Serial.print(F("Timer : "));
+    Serial.print(i);
+    Serial.print(F(", programmed : "));
+    Serial.print(TimerInterval[i]);
+    Serial.print(F(", actual : "));
+    Serial.println(deltaMillis[i]);
 #endif
   }
 
@@ -315,19 +324,24 @@ void setup()
   pinMode(LED_BUILTIN, OUTPUT);
 
   Serial.begin(115200);
-  while (!Serial);
 
-  delay(300);
+  while (!Serial && millis() < 5000);
+
+  delay(500);
 
-  Serial.print(F("\nStarting ISR_16_Timers_Array_Complex on ")); Serial.println(ARDUINO_BOARD);
+  Serial.print(F("\nStarting ISR_16_Timers_Array_Complex on "));
+  Serial.println(ARDUINO_BOARD);
   Serial.println(ESP8266_TIMER_INTERRUPT_VERSION);
-  Serial.print(F("CPU Frequency = ")); Serial.print(F_CPU / 1000000); Serial.println(F(" MHz"));
+  Serial.print(F("CPU Frequency = "));
+  Serial.print(F_CPU / 1000000);
+  Serial.println(F(" MHz"));
 
   // Interval in microsecs
   if (ITimer.attachInterruptInterval(HW_TIMER_INTERVAL_US, TimerHandler))
   {
     startMillis = millis();
-    Serial.print(F("Starting ITimer OK, millis() = ")); Serial.println(startMillis);
+    Serial.print(F("Starting ITimer OK, millis() = "));
+    Serial.println(startMillis);
   }
   else
     Serial.println(F("Can't set ITimer. Select another freq. or timer"));