Library for debouncing inputs, originally by Andres Mora Bedoya. Updated to include PinMode capability and class documentation.
Fork of DebouncedIn by
Diff: DebouncedIn.cpp
- Revision:
- 3:41d314732786
- Parent:
- 2:261228f701a1
- Child:
- 4:e88ec98d2b7e
--- a/DebouncedIn.cpp Wed Oct 08 15:14:31 2014 +0000 +++ b/DebouncedIn.cpp Thu Oct 09 20:03:47 2014 +0000 @@ -5,10 +5,7 @@ #include "DebouncedIn.h" #include "mbed.h" - -/** - * Constructor - */ + DebouncedIn::DebouncedIn(PinName in) : _in(in) { @@ -41,31 +38,15 @@ // Public member functions -/** Read the input state, represented as 0 or 1 (int) - * - * @returns - * An integer representing the state of the input pin, - * 0 for logical 0, 1 for logical 1. State changes when input - * has been steady for at least 40ms (8 ticker cycles of 5ms). - */ int DebouncedIn::read(void) { return(_output); } - -/** An operator shorthand for read() - */ + DebouncedIn::operator int() { return read(); } // return number of rising edges -/** Rising edge count (int) - * - * @returns - * An integer representing the number of times the switch has - * changed from low to high. Count resets to zero when this - * function is called. - */ int DebouncedIn::rising(void) { int return_value = _rising_flag; _rising_flag = 0; @@ -73,13 +54,6 @@ } // return number of falling edges -/** Falling edge count (int) - * - * @returns - * An integer representing the number of times the switch has - * changed from high to low. Count resets to zero when this - * function is called. - */ int DebouncedIn::falling(void) { int return_value = _falling_flag; _falling_flag = 0; @@ -87,12 +61,6 @@ } // return number of ticks we've bene steady for -/** Steady state tick count (int) - * - * @returns - * An integer representing how many ticker cycles the input has been - * steady for. Ticker cycles every 5ms. - */ int DebouncedIn::steady(void) { return(_state_counter); }