Latching Button update, added AlwaysOffButton

Latching Button updated so it returns the state if long press reset is disabled.
Added AlwaysOffButton.

Author: lendres

src/AlwaysOffButton.cpp

@@ -0,0 +1,45 @@
+/*
+	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 "AlwaysOffButton.h"
+
+// Constructors.
+AlwaysOffButton::AlwaysOffButton(int pin) :
+	SimpleButton(pin)
+{
+}
+
+AlwaysOffButton::AlwaysOffButton(int pin, int debounceInterval) :
+	SimpleButton(pin, debounceInterval)
+{
+}
+
+// Destructor.
+AlwaysOffButton::~AlwaysOffButton()
+{
+}
+
+BUTTONSTATUS AlwaysOffButton::getStatus()
+{
+	return NOTPRESSED;
+}

src/AlwaysOffButton.h

@@ -0,0 +1,46 @@
+/*
+	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 button always returns NOTPRESSED.  See SimpleButton.h for more information.
+*/
+
+#ifndef ALWAYSOFFBUTTON_H
+#define ALWAYSOFFBUTTON_H
+
+#include "Arduino.h"
+#include "SimpleButton.h"
+
+class AlwaysOffButton : public SimpleButton
+{
+	public:
+		AlwaysOffButton(int pin);
+		AlwaysOffButton(int pin, int debounceInterval);
+		~AlwaysOffButton();
+
+	public:
+		// Returns true if the button is currently pressed.
+		BUTTONSTATUS getStatus();
+};
+
+#endif

src/AlwaysOnButton.h

@@ -22,11 +22,7 @@
 */
 
 /*
-	This button always returns true.  The purpose of this class is to provide automatic
-	implimentation of an always on state for libraries or classes the take TwoStateButtons
-	as an argument.  By using a TwoStateButton, as class can automatically implement
-	momentary, latching, or always on behavior depending on which class derived from
-	the TwoStateButton class is used.  This makes it easy to switch behaviors as needed.
+	This button always returns ISPRESSED.  See SimpleButton.h for more information.
 */
 
 #ifndef ALWAYSONBUTTON_H

src/ButtonEnums.h

@@ -22,29 +22,7 @@
 */
 
 /*
-	This is a base class used for adding behavior to push buttons (momentary buttons).
-	It uses a debouncer to prevent accidental double readings.  It separates the button
-	behavior into currently pressed, short press, long press, or idle (nothing
-	happening).
-	
-	This class also acts as a base class for other button related classes.
-
-	The work of debouncing and catching the state changes (LOW to HIGH or HIGH to LOW)
-	is done by the Bounce2 library.
-
-	See also: PushButton, ToggleButton, PushButtonCounter, CycleButton
-*/
-
-/*
-	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.
-*/
-
-/*
-	If you want debugging messages printed to the serial monitor, enable the serial monitor and
-	use the following line in your file:
-	
-	#define BUTTONSUITEDEBUG
+	This file contains enumerations used by the ButtonSuite.
 */
 
 #ifndef BUTTONENUMS_H

src/LatchingButton.cpp

@@ -72,6 +72,10 @@ BUTTONSTATUS LatchingButton::getStatus()
 			{
 				reset();
 			}
+			else
+			{
+				_latched = !_latched;
+			}
 			return convertStateToButtonStatus();
 
 		case ISPRESSED:

src/LatchingButton.h

@@ -23,12 +23,24 @@
 
 /*
 	Turns a push button (momentary button) into a toggle button (latching button).
-	Pressing the button alternates between on (ISPRESSED) and off (NOTPRESSED).  If the
-	button is pushed once to turn in on (ISPRESSED) it will continue to return on
-	(ISPRESSED) until the button is pushed again.  This effectively creates a
-	virtual latching switch controled by a momentary button.  The toggle button
-	can be reset to the base (known) state by the user (with a long press, if
+	Pressing the button alternates between on (ISPRESSED) and off (NOTPRESSED).
+	This effectively creates a virtual latching switch controled by a momentary button.
+	The button can be reset to the base (known) state by the user (with a long press, if
 	enabled) or programmically.
+	
+	After a button is press down, the first call to getStatus returns WASPRESSED.
+	This allows a derived class to act on the button down press, if required.  Further
+	calls to getStatus will then return either ISPRESSED or NOTPRESSED depending
+	on the current value of _latched.
+
+	When the button is released, the length of the button press is evaluated.  The behavior
+	is then:
+		Short Press - The value of _latched is switched and the new state returned (as ISPRESSED
+			OR NOT PRESSED).
+
+		Long Press - If reset is enabled, the value of _latched is set to the default state
+			and the new state returned.  If reset is disabled, the behavior is the same as
+			as short press.
 
 	This button only returns the states, WASPRESSED, ISPRESSED or NOTPRESSED.  A short
 	press and a long press are used to either toggle the state or reset the state,

src/SimpleButton.h

@@ -24,6 +24,11 @@
 /*
 	Abstract class that provides interface for a two state button (button that only has
 	an on and off state).
+
+	The purpose of this class is to provide automatic implimentation of different behaviors.
+	By using different classes derived from SimpleButton, a class can automatically implement
+	momentary, latching, always on, or always off behavior.  This makes it easy to implement
+	different behaviors or even	switch behaviors during run time.
 */
 
 #ifndef TWOSTATEBUTTON_H