Adding new function

- adding a new function for blink in a period

Author: ArduinoGetStarted

README.md

@@ -20,6 +20,7 @@ Available Examples
 * 04.SingleBlinkChangeFrequency
 * 05.MultipleBlinkWithoutDelay
 * 06.MultipleBlinkWithOffset
+* 07.BlinkInPeriod
 
 How To Install the Library
 ----------------------------

examples/07.BlinkInPeriod/07.BlinkInPeriod.ino

@@ -0,0 +1,24 @@
+/*
+ * Created by ArduinoGetStarted.com
+ *
+ * This example code is in the public domain
+ *
+ * Tutorial page: https://arduinogetstarted.com/tutorials/arduino-output-library
+ *
+ * This example blinks LED:
+ * + blink in 10 seconds and then turn off
+ * + without using delay() function. This is a non-blocking example 
+ */
+
+#include <ezOutput.h> // ezOutput library
+
+ezOutput led(7);  // create ezOutput object that attach to pin 7;
+
+
+void setup() {
+  led.blink(200, 200, 0, 10000); // 200 milliseconds ON, 200 milliseconds OFF, start immidiately, blink during 10000 milliseconds
+}
+
+void loop() {
+  led.loop(); // MUST call the led.loop() function in loop()
+}

library.properties

@@ -1,5 +1,5 @@
 name=ezOutput
-version=1.0.0
+version=1.0.1
 author=ArduinoGetStarted.com
 maintainer=ArduinoGetStarted.com (ArduinoGetStarted@gmail.com)
 sentence=Output library for Arduino

src/ezOutput.cpp

@@ -38,6 +38,7 @@ ezOutput::ezOutput(int pin) {
 
 	_highTime = 0;
 	_lowTime  = 0;
+	_blinkTimes  = -1;
 	_lastBlinkTime = 0; 
 
 	pinMode(_outputPin, OUTPUT);
@@ -61,19 +62,24 @@ void ezOutput::toggle(void) {
 	digitalWrite(_outputPin, _outputState);
 }
 
-void ezOutput::blink(unsigned long lowTime, unsigned long highTime, unsigned long startTime) {
-	_highTime  = highTime;
-	_lowTime   = lowTime;
-	_startTime = startTime;
+void ezOutput::blink(unsigned long lowTime, unsigned long highTime, unsigned long startTime, long blinkTimes) {
+	_highTime   = highTime;
+	_lowTime    = lowTime;
+	_startTime  = startTime;
+	_blinkTimes = blinkTimes;
 
 	if(_blinkState == BLINK_STATE_DISABLE) {
 		_blinkState = BLINK_STATE_DELAY;
 		_lastBlinkTime = millis();
 	}
 }
 
+void ezOutput::blink(unsigned long lowTime, unsigned long highTime, unsigned long startTime) {
+	blink(lowTime, highTime, startTime, -1);
+}
+
 void ezOutput::blink(unsigned long lowTime, unsigned long highTime) {
-	blink(lowTime, highTime, 0);
+	blink(lowTime, highTime, 0, -1);
 }
 
 int ezOutput::getState(void) {
@@ -83,6 +89,9 @@ int ezOutput::getState(void) {
 void ezOutput::loop(void) {
 	bool isBlink = false;
 
+	if(_blinkTimes == 0)
+		_blinkState = BLINK_STATE_DISABLE;
+
 	switch(_blinkState) {
 		case BLINK_STATE_DISABLE:
 			return;
@@ -112,6 +121,9 @@ void ezOutput::loop(void) {
 		_outputState = (_outputState == LOW) ? HIGH : LOW;
 		digitalWrite(_outputPin, _outputState);
 		_lastBlinkTime = millis();
+		
+		if(_blinkTimes > 0)
+			_blinkTimes--;
 	}
 }
 

src/ezOutput.h

@@ -48,6 +48,7 @@ class ezOutput
 		unsigned long _highTime;
 		unsigned long _lowTime;
 		unsigned long _startTime;
+		unsigned long _blinkTimes;
 		unsigned long _lastBlinkTime; // the last time the output pin was blinked
 
 	public:
@@ -57,6 +58,7 @@ class ezOutput
 		void toggle(void);
 		void blink(unsigned long lowTime, unsigned long highTime);
 		void blink(unsigned long lowTime, unsigned long highTime, unsigned long startTime);
+		void blink(unsigned long lowTime, unsigned long highTime, unsigned long startTime, long blinkTimes);
 		int getState(void);
 		void loop(void);
 };