added doEvery()

Author: aster94

README.md

@@ -1,11 +1,42 @@
 # Utilities
 
-This is a collection of useful functions for the Arduino Framerwork, like:
-- printArray()
-- pinModeGroup()
-- digitalWriteGroup()
-- digitalToggle()
-- digitalToggleGroup()
-- splitString()
-
-Upload the [example](/examples/basic/basic.ino) to see them in action 🔥
+This is a collection of useful functions for the Arduino Framerwork.
+
+Upload the [example](/examples/basic/basic.ino) to see the usage 🔥
+
+# Functions
+
+#### doEvery()
+Run a task using without blocking code every given time
+
+#### pinModeGroup()
+Change the state of a group of pins
+
+#### digitalWriteGroup()
+Write the state of a group of pins
+
+#### digitalToggle()
+Toggle the state of a pin
+
+#### digitalToggleGroup()
+Toggle the state of a group of pins
+
+#### echo()
+Echo between two serial ports, bi or mono directional
+
+#### printArray()
+Print an array of any kind
+
+#### splitString()
+Split a cstring into token and get one of them
+
+# Macros
+
+#### LEN
+Get the exact size of any array
+
+#### TO_FAHRENHEIT
+Convert Celsius to Fahrenheit
+
+#### TO_CELSIUS
+Convert Fahrenheit to Celsius

Utilities.h

@@ -10,10 +10,25 @@
 #endif
 
 // MACROS
+#define LEN(x) ((sizeof(x) / sizeof(0 [x])) / ((size_t)(!(sizeof(x) % sizeof(0 [x]))))) // complex but safe macro for the lenght
 #define TO_FAHRENHEIT(x) x * 1.8 + 32
 #define TO_CELSIUS(x) (x - 32) * 0.55
-#define LEN(x) ((sizeof(x) / sizeof(0 [x])) / ((size_t)(!(sizeof(x) % sizeof(0 [x]))))) // complex but safe macro for the lenght
-#define maybe 2																			// true or false is not enough
+#define maybe 2 // true or false is not enough
+
+// Run a task using without blocking code every given time
+template <class T1, class T2>
+bool doEvery(T1 *start_time, T2 interval)
+{
+	if (millis() > *start_time + interval)
+	{
+		*start_time = millis();
+		return true;
+	}
+	else
+	{
+		return false;
+	}
+}
 
 // Change the state of a group of pins
 void pinModeGroup(uint8_t pins[], size_t len, uint8_t state)

examples/basic/basic.ino

@@ -5,8 +5,8 @@ void setup()
   Serial.begin(115200);
   delay(1000);
 
-  // Create a group of pin
-  uint8_t group[] = {LED_BUILTIN, 12, 11, 10, 9, 8};
+  // Create a group of pins
+  byte group[] = {LED_BUILTIN, 12, 11, 10, 9, 8};
 
   // Print that group
   printArray(group, LEN(group));
@@ -20,14 +20,14 @@ void setup()
   digitalWriteGroup(group, LEN(group), LOW);
 
   // Toggle the state of a pin
-  for (uint8_t n = 0; n < 5; n++)
+  for (byte n = 0; n < 5; n++)
   {
     digitalToggle(LED_BUILTIN);
     delay(500);
   }
 
   // Or toggle a group of pins
-  for (uint8_t n = 0; n < 5; n++)
+  for (byte n = 0; n < 5; n++)
   {
     digitalToggleGroup(group, LEN(group));
     delay(500);
@@ -44,9 +44,12 @@ void setup()
   Serial.println(substring); // this will output "test"
 
   // A more complex array for printArray
-  uint8_t array[] = {1, 0x56, 0b1011};
+  int array[] = {1, 11, 89, 34, 9};
 
-  // Print the array as hexadecimal values with a ":" between the items and invert it (from the last to the first)
+  // Print the array as decimal values with a ", " between the items and invert them (from the last to the first)
+  printArray(array, LEN(array), ", ", DEC, true);
+
+  // Print the array as hexadecimal values with a ":" between the items and invert them (from the last to the first)
   printArray(array, LEN(array), ":", HEX, true);
 
   // Print the array as binary values with a newline ("\n") between the items and write the index before every element
@@ -56,4 +59,19 @@ void setup()
   //echo(&Serial, &Serial2);
 }
 
-void loop() {}
+unsigned long task1, task2;
+
+void loop()
+{
+  // This will be run every 3500 milliseconds (3.5 seconds)
+  if (doEvery(&task1, 3500))
+  {
+    Serial.println("Hello, from task1");
+  }
+
+  // This every 10 seconds
+  if (doEvery(&task2, 10000))
+  {
+    Serial.println("Also from task2!");
+  }
+}

keywords.txt

@@ -9,6 +9,7 @@
 #######################################
 # Methods and Functions (KEYWORD2)
 #######################################
+doEvery     		KEYWORD2
 pinModeGroup		KEYWORD2
 digitalWriteGroup	KEYWORD2
 digitalToggle		KEYWORD2
@@ -20,7 +21,7 @@ splitString			KEYWORD2
 #######################################
 # Constants (LITERAL1)
 #######################################
+LEN					LITERAL1
 TO_FAHRENHEIT		LITERAL1
 TO_CELSIUS  		LITERAL1
-LEN					LITERAL1
 maybe				LITERAL1