SimpleTimer update

Author: DreamerDeLy

.circleci/config.yml

@@ -9,3 +9,5 @@ jobs:
       - run: pio ci --board=esp32dev examples/SerialLogging/ --lib src/
       - run: pio ci --board=esp32dev examples/UnitsConversion/ --lib src/
       - run: pio ci --board=esp32dev examples/Values/ --lib src/
+      - run: pio ci --board=esp32dev examples/TimerSimple/ --lib src/
+      - run: pio ci --board=esp32dev examples/TimerCallbacks/ --lib src/

CHANGELOG.md

@@ -11,4 +11,9 @@
 ## v0.2.0
 
 * Невеликі фікси та перероблений шаблон SerialLog.
-* Додано приклади роботи з CLI та з Value.
+* Додано приклади роботи з CLI та з Value.
+
+## v0.3.0
+
+* Доданий приклад з UnitCorvesion.
+* Функціонал SimpleTimer розширено: додана можливість працювати з калбеками. Додані приклади роботи в різних варіантах.

README.md

@@ -58,6 +58,8 @@ pio ci --board=esp32dev examples/CLI/ --lib src/
 pio ci --board=esp32dev examples/SerialLogging/ --lib src/
 pio ci --board=esp32dev examples/UnitsConversion/ --lib src/
 pio ci --board=esp32dev examples/Values/ --lib src/
+pio ci --board=esp32dev examples/TimerSimple/ --lib src/
+pio ci --board=esp32dev examples/TimerCallbacks/ --lib src/
 ```
 
 Use this command to run tests (you have to have connected ESP32 to your computer):

examples/TimerCallbacks/TimerCallbacks.ino

@@ -0,0 +1,36 @@
+
+// Include library
+#include <realtime/simple_timer.h>
+
+// Create timer and set interval
+SimpleTimer timer = SimpleTimer(/* interval: */ 5000);
+
+void setup()
+{
+	// Setup Serial port
+	Serial.begin(115200);
+
+	// Add callback
+	timer.onElapsed(onTimer);
+
+	// Set new interval
+	timer.setInterval(1000);
+
+	// Begin timer
+	timer.begin();
+}
+
+void loop()
+{
+	// Check timer
+	timer.tick();
+}
+
+void onTimer(SimpleTimer *t)
+{
+	// Reset timer
+	t->reset();
+
+	// Print message
+	Serial.println("Timer triggered! " + String(millis()));
+}

examples/TimerSimple/TimerSimple.ino

@@ -0,0 +1,27 @@
+
+// Include library
+#include <realtime/simple_timer.h>
+
+// Create timer 
+SimpleTimer timer = SimpleTimer();
+
+void setup()
+{
+	// Setup Serial port
+	Serial.begin(115200);
+
+	// Begin timer
+	timer.begin(/* interval: */ 5000);
+}
+
+void loop()
+{
+	if (timer.check())
+	{
+		// Reset timer
+		timer.reset();
+
+		// Print message
+		Serial.println("Timer triggered! " + String(millis()));
+	}
+}

library.json

@@ -15,7 +15,7 @@
 		"type": "git",
 		"url": "https://github.com/DreamerDeLy/dream.git"
 	},
-	"version": "0.2.0",
+	"version": "0.3.0",
 	"license": "GPL-3.0-or-later",
 	"frameworks": "arduino",
 	"platforms": 

src/realtime/simple_timer.h

@@ -18,16 +18,33 @@
 class SimpleTimer
 {
 	private: //-----------------------------------------------------------------
+
+	// Time typedef
 	typedef unsigned long long_time_t;
 
+	// Timer interval
 	long_time_t _interval;
-	long_time_t _last_tick = millis();
+
+	// Run callback function on elapsed
+	bool _callback_on_elapsed = false;
+
+	// Timer cycle start
+	long_time_t _start_time;
+
+	// Callback function
+	typedef void (*CallbackFunction)(SimpleTimer*);
+	CallbackFunction _callback_function;
 
 	public: //------------------------------------------------------------------
 
 	// Timer constructor
 	SimpleTimer(long_time_t interval = 1000) : _interval(interval) { }
 
+	SimpleTimer(long_time_t interval, CallbackFunction f) : _interval(interval) 
+	{ 
+		onElapsed(f);
+	}
+
 	// Begin timer 
 	void begin()
 	{
@@ -44,7 +61,7 @@ class SimpleTimer
 	// Reset timer
 	void reset() 
 	{
-		_last_tick = millis();
+		_start_time = millis();
 	}
 
 	// Set timer interval
@@ -58,23 +75,36 @@ class SimpleTimer
 	{
 		long_time_t current_millis = millis();
 
-		return ((current_millis - _last_tick) > _interval);
+		return ((current_millis - _start_time) > _interval);
+	}
+
+	// Function to call on elapsed
+	void onElapsed(CallbackFunction f)
+	{
+		_callback_on_elapsed = true;
+		_callback_function = f;
+	}
+
+	// Check timer and run callback
+	void tick()
+	{
+		if (_callback_on_elapsed && check()) _callback_function(this);
 	}
 
 	// The number of milliseconds until the next trigger
 	long_time_t remains() const
 	{
 		long_time_t current_millis = millis();
 
-		return ((_last_tick + _interval) - current_millis);
+		return ((_start_time + _interval) - current_millis);
 	}
 
 	// The number of milliseconds that have passed since the last reset
 	long_time_t passed() const
 	{
 		long_time_t current_millis = millis();
 
-		return current_millis - _last_tick;
+		return current_millis - _start_time;
 	}
 };