Library ready to use

Author: jaakka

examples/Blink/Blink.ino

@@ -1,7 +1,10 @@
 /*
     DelayFunctions, is designed for managing multiple software timers in Arduino projects.
+    
+    In this example, the timer function is demonstrated by blinking an LED.
+
     https://github.com/jaakka/DelayFunctionsArduino
-    Created by Jaakko Talvitie 18.11.2024
+    Library created by Jaakko Talvitie 18.11.2024
 */
 
 #include <DelayFunctions.h>

examples/DelaySwapWithBlinkExample/DelaySwapWithBlinkExample.ino

@@ -1,3 +1,12 @@
+/*
+    DelayFunctions, is designed for managing multiple software timers in Arduino projects.
+    
+    In this example, it is demonstrated how you can change the speed of the timer function. (after start)
+
+    https://github.com/jaakka/DelayFunctionsArduino
+    Library created by Jaakko Talvitie 18.11.2024
+*/
+
 #include <DelayFunctions.h>
 
 //FOR ARDUINO #define ledPin = LED_BUILTIN;  

examples/FourFunctions/FourFunctions.ino

@@ -1,3 +1,13 @@
+/*
+    DelayFunctions, is designed for managing multiple software timers in Arduino projects.
+    
+    In this example, multiple timed functions are demonstrated, 
+    and a message is printed to the Serial Monitor whenever one of them executes.
+
+    https://github.com/jaakka/DelayFunctionsArduino
+    Library created by Jaakko Talvitie 18.11.2024
+*/
+
 #include <DelayFunctions.h>
 
 //save memory with correct count of timers.

examples/OneFunction/OneFunction.ino

@@ -1,3 +1,13 @@
+/*
+    DelayFunctions, is designed for managing multiple software timers in Arduino projects.
+    
+    In this example, the timer function is demonstrated by printing a message 
+    to the Serial Monitor every second.
+
+    https://github.com/jaakka/DelayFunctionsArduino
+    Library created by Jaakko Talvitie 18.11.2024
+*/
+
 #include <DelayFunctions.h>
 
 //save memory with correct count of timers.

library.properties

@@ -3,7 +3,7 @@ version=0.0.1
 author=Jaakko Talvitie
 maintainer=Jaakko Talvitie<jaska.talvitie@gmail.com>
 sentence=Simple delay functions.
-paragraph=Simple delay functions for arduino, with out full code pause.
+paragraph=Simple delay functions for arduino, without full code pause.
 category=SmartCode
 url=https://github.com/jaakka
 architectures=avr,esp32

src/DelayFunctions.cpp

@@ -1,86 +1,78 @@
+/*
+    https://github.com/jaakka/DelayFunctionsArduino
+    Library created by Jaakko Talvitie 18.11.2024
+*/
+
 #include "Arduino.h"
 #include "DelayFunctions.h"
 
-// Konstruktori, joka alustaa ajastimien määrän ja varaa muistia
 DelayFunctions::DelayFunctions(int argTimersCount)
 {
-    _maxTimersCount = argTimersCount;  // Asetetaan enimmäismäärä
-    timeFunctions = new DelayFunction[_maxTimersCount];  // Dynaaminen muistivaraus ajastimille
-    _timersCount = 0;  // Alustetaan ajastimien määrä nollaksi
+    _maxTimersCount = argTimersCount;  
+    timeFunctions = new DelayFunction[_maxTimersCount]; 
+    _timersCount = 0;  
 }
 
-// Destruktori, joka vapauttaa dynaamisesti varatun muistin
 DelayFunctions::~DelayFunctions()
 {
-    delete[] timeFunctions;  // Vapautetaan muistivaraus
+    delete[] timeFunctions;  
 }
 
-// Päivittää ajastimen aikarajan 
 void DelayFunctions::updateTime(void (*cb)(), unsigned long interval)
 {
     for (int i = 0; i < _timersCount; i++)
     {
-        if (timeFunctions[i].callback == cb)  // Jos callback-muuttuja vastaa
+        if (timeFunctions[i].callback == cb) 
         {
-            timeFunctions[i].interval = interval;  // Päivitetään ajastimen interval
+            timeFunctions[i].interval = interval;  
         }
     }
 }
 
-// Hankkii ajastimen aikarajan
 unsigned long DelayFunctions::getTime(void (*cb)())
 {
     for (int i = 0; i < _timersCount; i++)
     {
-        if (timeFunctions[i].callback == cb)  // Jos callback-muuttuja vastaa
+        if (timeFunctions[i].callback == cb)  
         {
-            return timeFunctions[i].interval;  // Palautetaan ajastimen interval
+            return timeFunctions[i].interval;  
         }
     }
     return -1;
 }
 
-// Lisää uuden ajastimen ajastinluetteloon
 void DelayFunctions::NewDelayFunction(unsigned long interval, void (*cb)())
 {
     if (_timersCount < _maxTimersCount)
     {
         timeFunctions[_timersCount] = DelayFunction(cb, interval);
-        timeFunctions[_timersCount].lastRun = millis();  // Alustetaan viimeinen suoritushetki
+        timeFunctions[_timersCount].lastRun = millis();  
         _timersCount++;
     }
-    else
-    {
-        Serial.println("Max timers reached! Cannot add more timers.");
-    }
 }
 
-// Kutsutaan pääloopissa ja tarkistaa ajastimet
 void DelayFunctions::loop()
 {
-    unsigned long currentMillis = millis();  // Haetaan nykyinen aika
+    unsigned long currentMillis = millis();  
     for (int i = 0; i < _timersCount; i++)
     {
-        // Tarkistetaan, onko ajastin ehtinyt aikarajan
         if (currentMillis - timeFunctions[i].lastRun >= timeFunctions[i].interval)
         {
             if (timeFunctions[i].callback != nullptr)
             {
-                timeFunctions[i].callback();  // Kutsutaan ajastimen callback
-                timeFunctions[i].lastRun = currentMillis;  // Päivitetään viimeinen suoritushetki
+                timeFunctions[i].callback(); 
+                timeFunctions[i].lastRun = currentMillis;  
             }
         }
     }
 }
 
-// DelayFunction-konstruktori, joka alustaa ajastimen
 DelayFunction::DelayFunction()
 {
     interval = 0;
     callback = nullptr;
 }
 
-// Parametrillinen konstruktori, joka asettaa callbackin ja intervalin
 DelayFunction::DelayFunction(void (*_callback)(), unsigned long _interval)
 {
     callback = _callback;

src/DelayFunctions.h

@@ -1,33 +1,37 @@
+/*
+    https://github.com/jaakka/DelayFunctionsArduino
+    Library created by Jaakko Talvitie 18.11.2024
+*/
+
 #ifndef DELAYFUNCTIONS_H
 #define DELAYFUNCTIONS_H
 
 #include "Arduino.h"
 
-// DelayFunction-luokka, joka edustaa yksittäistä ajastinta
 class DelayFunction
 {
   public:
-    DelayFunction();  // Konstruktori, joka alustaa ajastimen
-    DelayFunction(void (*_callback)(), unsigned long _interval);  // Parametrillinen konstruktori
+    DelayFunction();  
+    DelayFunction(void (*_callback)(), unsigned long _interval);  
     unsigned long lastRun; 
-    unsigned long interval;  // Ajastimen aikaraja
-    void (*callback)();      // Callback-funktion osoitin
+    unsigned long interval;  
+    void (*callback)();      
 };
 
 class DelayFunctions
 {
   public:
-    DelayFunctions(int timersCount);  // Konstruktori, joka alustaa ajastimien määrän
-    ~DelayFunctions();                // Destruktori, joka vapauttaa dynaamisen muistin
-    void NewDelayFunction(unsigned long interval, void (*cb)());  // Lisää uuden ajastimen
-    void loop();                      // Pääloopin metodi, joka käsittelee ajastimet
-    void updateTime(void (*cb)(), unsigned long interval);  // Päivittää ajastimen ajan
-    unsigned long getTime(void (*cb)());  // Hankkii ajastimen ajan
+    DelayFunctions(int timersCount); 
+    ~DelayFunctions();               
+    void NewDelayFunction(unsigned long interval, void (*cb)());  
+    void loop();                      
+    void updateTime(void (*cb)(), unsigned long interval); 
+    unsigned long getTime(void (*cb)());  
 
   private:
-    int _maxTimersCount;      // Ajastimien enimmäismäärä
-    int _timersCount;         // Käytössä olevien ajastimien määrä
-    DelayFunction* timeFunctions;  // Dynaamisesti varattu taulukko ajastimille
+    int _maxTimersCount;    
+    int _timersCount;      
+    DelayFunction* timeFunctions;  
 };
 
 #endif