Added custom button demo.

Author: lendres

examples/Advanced_CustomButton_Demo_01/Advanced_CustomButton_Demo_01.ino

@@ -0,0 +1,85 @@
+/*
+	Turns an LED on when the button is pressed and off when the button is released.
+
+	The button should be wired such that when pressed, the "buttonPin" is
+	connected to ground.
+
+	The LED should be wired with the "ledPin" to the positive lead and the
+	negative lead should be connected to ground.  A current limiting resistor
+	should be used.
+*/
+
+#include "CustomButton.h"
+
+// Change these if your button or LED are on other pins.
+int buttonPin	= 8;
+int ledPin		= 9;
+
+// The button will automatically configure the button pin.
+CustomButton button(buttonPin);
+
+// Used for timing.
+unsigned long	intervalStartTime;
+const int		fastBlinkInterval			= 100;
+bool			timing;
+
+void setup()
+{
+	// Setup the output LED.
+	pinMode(ledPin, OUTPUT);
+	digitalWrite(ledPin, LOW);
+}
+
+void loop()
+{
+	// Hold the button down to turn the LED on and release it to turn it off.
+	switch (button.getBehavior())
+	{
+		case CustomButton::LIGHTOFF:
+		{
+			// Turn off the light and make sure timing is turned off.
+			digitalWrite(ledPin, LOW);
+			timing = false;
+			break;
+		}
+
+		case CustomButton::BLINKONCE:
+		{
+			// Turn on the light for 1 second.  We won't bother with timing for this.
+			digitalWrite(ledPin, HIGH);
+			delay(1000);
+			break;
+		}
+
+		case CustomButton::FASTBLINK:
+		{
+			// If we are not timing, then we start it.  That is, we have determine the button is being
+			// held down and this is the first pass through the loop since the long press was activated.
+			//
+			// If we are already timing, we need to alternate the status of the light everytime the
+			// timing interval is up.
+			if (!timing)
+			{
+				// Turn on the light and start the timing.
+				digitalWrite(ledPin, HIGH);
+				intervalStartTime		= millis();
+				timing					= true;
+			}
+			else
+			{
+				// Check if the timing interval is up.
+				if (millis() - intervalStartTime > fastBlinkInterval)
+				{
+					// Swap the state of the LED light.  If it's off, turn it on and vice versa.
+					// This is done by reading the current status of the pin, negating it and
+					// passing it to the write function.
+					digitalWrite(ledPin, !digitalRead(ledPin));
+
+					// Restart the timing.
+					intervalStartTime = millis();
+				}
+			}
+			break;
+		}
+	}
+}

examples/Advanced_CustomButton_Demo_01/CustomButton.cpp

@@ -0,0 +1,66 @@
+/*
+	The MIT License (MIT)
+	
+	Copyright (c) 2019 Lance A. Endres
+	
+	Permission is hereby granted, free of charge, to any person obtaining a copy of
+	this software and associated documentation files (the "Software"), to deal in
+	the Software without restriction, including without limitation the rights to
+	use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+	the Software, and to permit persons to whom the Software is furnished to do so,
+	subject to the following conditions:
+	
+	The above copyright notice and this permission notice shall be included in all
+	copies or substantial portions of the Software.
+	
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+	FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+	COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+	IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+	CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+#include "CustomButton.h"
+
+// Constructors.
+CustomButton::CustomButton(int pin) :
+	ButtonBase(pin)
+{
+}
+
+CustomButton::CustomButton(int pin, int debounceInterval) :
+	ButtonBase(pin, debounceInterval)
+{
+}
+
+// Destructor.
+CustomButton::~CustomButton()
+{
+}
+
+CustomButton::LIGHTBEHAVIOR CustomButton::getBehavior()
+{
+	switch (update())
+	{
+		// We want to blink the light for 1 second when the button is pressed and released.
+		// In the ButtonSuite, this event returns the WASSHORTPRESSED.  
+		case WASSHORTPRESSED:
+		{
+			return BLINKONCE;
+		}
+
+		// We want to blink the light fastly as long as the button has been held down long
+		// enough to be considered a long press and still is being held down.
+		case ISLONGPRESSED:
+		{
+			return FASTBLINK;
+		}
+
+		// If neither of the above two things are true, we turn the light off.
+		default:
+		{
+			return LIGHTOFF;
+		}
+	}
+}

examples/Advanced_CustomButton_Demo_01/CustomButton.h

@@ -0,0 +1,65 @@
+/*
+	The MIT License (MIT)
+	
+	Copyright (c) 2019 Lance A. Endres
+	
+	Permission is hereby granted, free of charge, to any person obtaining a copy of
+	this software and associated documentation files (the "Software"), to deal in
+	the Software without restriction, including without limitation the rights to
+	use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+	the Software, and to permit persons to whom the Software is furnished to do so,
+	subject to the following conditions:
+	
+	The above copyright notice and this permission notice shall be included in all
+	copies or substantial portions of the Software.
+	
+	THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+	IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+	FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+	COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+	IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+	CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+*/
+
+/*
+	This class is used to demonstrate how to derive your own custom behavior for
+	a button.  While there are many examples of button classes in the library, they
+	are largely inherited from intermediate classes.  However, many custom buttons
+	will likely find it better to inherit direction from the ButtonBase class.
+*/
+
+/*
+	To use a button with this library, the button should be wired with one side
+	connected to the Arduino pin and the other side connected to ground such that
+	when the button is pressed, the pin is brought to ground (LOW).
+*/
+
+#ifndef CUSTOMBUTTON_H
+#define CUSTOMBUTTON_H
+
+#include "Arduino.h"
+#include "ButtonBase.h"
+
+class CustomButton : public ButtonBase
+{
+	public:
+		enum LIGHTBEHAVIOR
+		{
+			LIGHTOFF,
+			BLINKONCE,
+			FASTBLINK		
+		};
+
+	public:
+		CustomButton(int pin);
+		CustomButton(int pin, int debounceInterval);
+
+		~CustomButton();
+
+	// Status access functions.  Call in the "loop" to get the status of the button.
+	public:
+		// Returns a value to that states what the light should do.
+		LIGHTBEHAVIOR getBehavior();
+};
+
+#endif