From 79db9f00168eaad226d37b72adb80a66c0f98ef8 Mon Sep 17 00:00:00 2001 From: Thomas O Fredericks Date: Mon, 21 Mar 2022 10:04:38 -0400 Subject: [PATCH] Added back duration but as deprecated and updated documentation --- docs/files/_bounce2_8h_source.html | 223 +++++++++--------- docs/files/class_bounce-members.html | 35 +-- docs/files/class_bounce.html | 3 + .../class_bounce2_1_1_button-members.html | 47 ++-- docs/files/class_bounce2_1_1_button.html | 5 +- docs/files/class_debouncer-members.html | 25 +- docs/files/class_debouncer.html | 34 ++- docs/files/functions.html | 3 + docs/files/functions_func.html | 3 + docs/files/index.html | 8 +- docs/files/search/all_3.js | 3 +- docs/files/search/all_4.js | 4 +- docs/files/search/all_5.js | 4 +- docs/files/search/all_6.js | 4 +- docs/files/search/all_7.js | 6 +- docs/files/search/all_8.js | 8 +- docs/files/search/all_9.js | 2 +- docs/files/search/all_a.js | 2 +- docs/files/search/classes_0.js | 4 +- docs/files/search/classes_1.js | 2 +- docs/files/search/functions_0.js | 2 +- docs/files/search/functions_1.js | 4 +- docs/files/search/functions_2.js | 4 +- docs/files/search/functions_3.js | 3 +- docs/files/search/functions_4.js | 4 +- docs/files/search/functions_5.js | 4 +- docs/files/search/functions_6.js | 4 +- docs/files/search/functions_7.js | 4 +- docs/files/search/functions_8.js | 8 +- docs/files/search/functions_9.js | 2 +- docs/files/search/functions_a.js | 2 +- docs/files/search/namespaces_0.js | 2 +- docs/files/search/pages_0.js | 2 +- docs/files/search/variables_0.js | 2 +- library.json | 2 +- library.properties | 2 +- src/Bounce2.h | 18 ++ 37 files changed, 286 insertions(+), 208 deletions(-) diff --git a/docs/files/_bounce2_8h_source.html b/docs/files/_bounce2_8h_source.html index c1decaf..c70e78d 100644 --- a/docs/files/_bounce2_8h_source.html +++ b/docs/files/_bounce2_8h_source.html @@ -148,127 +148,138 @@ $(function() {
123 
124 public:
130  bool changed( ) const { return getStateFlag(CHANGED_STATE); }
-
131 
-
140  unsigned long currentDuration() const;
-
141 
-
142 
-
150  unsigned long previousDuration() const;
-
151 
-
152 protected:
-
153  void begin();
-
154  virtual bool readCurrentState() =0;
-
155  unsigned long previous_millis;
-
156  uint16_t interval_millis;
-
157  uint8_t state;
-
158  unsigned long stateChangeLastTime;
-
159  unsigned long durationOfPreviousState;
-
160 
-
161 };
-
162 
-
163 
-
168 class Bounce : public Debouncer
-
169 {
-
170 
-
171 
-
172 public:
-
173 
-
184  Bounce();
-
185 
+
131 
+
132 
+
133 
+
134 
+
143  unsigned long currentDuration() const;
+
144 
+
145 
+
153  unsigned long previousDuration() const;
+
154 
+
163  [[deprecated]]
+
164  unsigned long duration() {
+
165  return currentDuration();
+
166  };
+
167 
+
168 protected:
+
169  void begin();
+
170  virtual bool readCurrentState() =0;
+
171  unsigned long previous_millis;
+
172  uint16_t interval_millis;
+
173  uint8_t state;
+
174  unsigned long stateChangeLastTime;
+
175  unsigned long durationOfPreviousState;
+
176 
+
177 };
+
178 
+
179 
+
184 class Bounce : public Debouncer
+
185 {
186 
-
195  void attach(int pin, int mode);
-
196 
-
200  void attach(int pin);
+
187 
+
188 public:
+
189 
+
200  Bounce();
201 
-
202  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
-
203  attach(pin);
-
204  interval(interval_millis);
-
205  }
-
206 
-
207 
-
213  inline int getPin() const {
-
214  return this->pin;
-
215  };
-
216 
-
218  // Deprecated //
-
220 
-
224  bool risingEdge() const { return rose(); }
-
228  bool fallingEdge() const { return fell(); }
-
234 protected:
-
235 
-
236 
-
237  uint8_t pin;
-
238 
-
239  virtual bool readCurrentState() { return digitalRead(pin); }
-
240  virtual void setPinMode(int pin, int mode) {
-
241 #if defined(ARDUINO_ARCH_STM32F1)
-
242  pinMode(pin, (WiringPinMode)mode);
-
243 #else
-
244  pinMode(pin, mode);
-
245 #endif
-
246  }
-
247 
-
248 
-
249 
-
250 };
-
251 
-
255 namespace Bounce2 {
-
256  // code declarations
-
257 
-
258 class Button : public Bounce{
-
259 protected:
-
260  bool stateForPressed = 1; //
-
261  public:
-
272  Button(){ }
-
273 
-
281  void setPressedState(bool state){
-
282  stateForPressed = state;
-
283  }
-
284 
-
288  inline bool getPressedState() const {
-
289  return stateForPressed;
-
290  };
+
202 
+
211  void attach(int pin, int mode);
+
212 
+
216  void attach(int pin);
+
217 
+
218  Bounce(uint8_t pin, unsigned long interval_millis ) : Bounce() {
+
219  attach(pin);
+
220  interval(interval_millis);
+
221  }
+
222 
+
223 
+
229  inline int getPin() const {
+
230  return this->pin;
+
231  };
+
232 
+
234  // Deprecated //
+
236 
+
240  [[deprecated]]
+
241  bool risingEdge() const { return rose(); }
+
245  [[deprecated]]
+
246  bool fallingEdge() const { return fell(); }
+
252 protected:
+
253 
+
254 
+
255  uint8_t pin;
+
256 
+
257  virtual bool readCurrentState() { return digitalRead(pin); }
+
258  virtual void setPinMode(int pin, int mode) {
+
259 #if defined(ARDUINO_ARCH_STM32F1)
+
260  pinMode(pin, (WiringPinMode)mode);
+
261 #else
+
262  pinMode(pin, mode);
+
263 #endif
+
264  }
+
265 
+
266 
+
267 
+
268 };
+
269 
+
273 namespace Bounce2 {
+
274  // code declarations
+
275 
+
276 class Button : public Bounce{
+
277 protected:
+
278  bool stateForPressed = 1; //
+
279  public:
+
290  Button(){ }
291 
-
295  inline bool isPressed() const {
-
296  return read() == getPressedState();
-
297  };
-
298 
-
302  inline bool pressed() const {
-
303  return changed() && isPressed();
-
304  };
-
305 
-
309  inline bool released() const {
-
310  return changed() && !isPressed();
-
311  };
-
312 
-
313 };
-
314 };
-
315 
-
316 #endif
+
299  void setPressedState(bool state){
+
300  stateForPressed = state;
+
301  }
+
302 
+
306  inline bool getPressedState() const {
+
307  return stateForPressed;
+
308  };
+
309 
+
313  inline bool isPressed() const {
+
314  return read() == getPressedState();
+
315  };
+
316 
+
320  inline bool pressed() const {
+
321  return changed() && isPressed();
+
322  };
+
323 
+
327  inline bool released() const {
+
328  return changed() && !isPressed();
+
329  };
+
330 
+
331 };
+
332 };
+
333 
+
334 #endif
-
Bounce2::Button
Definition: Bounce2.h:258
+
Bounce2::Button
Definition: Bounce2.h:276
Debouncer::interval
void interval(uint16_t interval_millis)
Sets the debounce interval in milliseconds.
Definition: Bounce2.cpp:14
Debouncer::previousDuration
unsigned long previousDuration() const
Returns the duration in milliseconds of the previous state.
Definition: Bounce2.cpp:103
-
Bounce2::Button::getPressedState
bool getPressedState() const
Get the electrical state (HIGH/LOW) that corresponds to a physical press.
Definition: Bounce2.h:288
+
Bounce2::Button::getPressedState
bool getPressedState() const
Get the electrical state (HIGH/LOW) that corresponds to a physical press.
Definition: Bounce2.h:306
Bounce::Bounce
Bounce()
Create an instance of the Bounce class.
Definition: Bounce2.cpp:138
-
Bounce::fallingEdge
bool fallingEdge() const
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:228
+
Debouncer::duration
unsigned long duration()
DEPRECATED (i.e. do not use). Renamed currentDuration().
Definition: Bounce2.h:164
+
Bounce::fallingEdge
bool fallingEdge() const
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:246
Debouncer::rose
bool rose() const
Returns true if pin signal transitions from low to high.
Definition: Bounce2.cpp:123
-
Bounce::pin
uint8_t pin
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:237
-
Bounce2::Button::pressed
bool pressed() const
Returns true if the button was physically pressed
Definition: Bounce2.h:302
+
Bounce::pin
uint8_t pin
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:255
+
Bounce2::Button::pressed
bool pressed() const
Returns true if the button was physically pressed
Definition: Bounce2.h:320
Debouncer::currentDuration
unsigned long currentDuration() const
Returns the duration in milliseconds of the current state.
Definition: Bounce2.cpp:107
Debouncer::update
bool update()
Updates the pin's state.
Definition: Bounce2.cpp:32
-
Bounce2::Button::Button
Button()
Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
Definition: Bounce2.h:272
-
Bounce
The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. This class is odly named,...
Definition: Bounce2.h:168
-
Bounce::getPin
int getPin() const
Return pin that this Bounce is attached to.
Definition: Bounce2.h:213
+
Bounce2::Button::Button
Button()
Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
Definition: Bounce2.h:290
+
Bounce
The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. This class is odly named,...
Definition: Bounce2.h:184
+
Bounce::getPin
int getPin() const
Return pin that this Bounce is attached to.
Definition: Bounce2.h:229
Debouncer
The Debouce class. Just the deboucing code separated from all harware.
Definition: Bounce2.h:62
-
Bounce2::Button::setPressedState
void setPressedState(bool state)
Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default,...
Definition: Bounce2.h:281
+
Bounce2::Button::setPressedState
void setPressedState(bool state)
Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default,...
Definition: Bounce2.h:299
Debouncer::fell
bool fell() const
Returns true if pin signal transitions from high to low.
Definition: Bounce2.cpp:128
-
Bounce2::Button::released
bool released() const
Returns true if the button was physically released
Definition: Bounce2.h:309
+
Bounce2::Button::released
bool released() const
Returns true if the button was physically released
Definition: Bounce2.h:327
Bounce::attach
void attach(int pin, int mode)
Attach to a pin and sets that pin's mode (INPUT, INPUT_PULLUP or OUTPUT).
Definition: Bounce2.cpp:149
-
Bounce2::Button::isPressed
bool isPressed() const
Returns true if the button is currently physically pressed.
Definition: Bounce2.h:295
+
Bounce2::Button::isPressed
bool isPressed() const
Returns true if the button is currently physically pressed.
Definition: Bounce2.h:313
Debouncer::read
bool read() const
Returns the pin's state (HIGH or LOW).
Definition: Bounce2.cpp:118
-
Bounce::risingEdge
bool risingEdge() const
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:224
+
Bounce::risingEdge
bool risingEdge() const
Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce ver...
Definition: Bounce2.h:241
Debouncer::changed
bool changed() const
Returns true if the state changed on last update.
Definition: Bounce2.h:130
-
Bounce2
The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action.
Definition: Bounce2.h:255
+
Bounce2
The Debouncer:Bounce:Button class. The Button class matches an electrical state to a physical action.
Definition: Bounce2.h:273
Debouncer::Debouncer
Debouncer()
Create an instance of the Debounce class.
Definition: Bounce2.cpp:10
diff --git a/docs/files/class_bounce-members.html b/docs/files/class_bounce-members.html index 4db5885..ef878aa 100644 --- a/docs/files/class_bounce-members.html +++ b/docs/files/class_bounce-members.html @@ -76,23 +76,24 @@ $(function() { changed() constDebouncerinline currentDuration() constDebouncer Debouncer()Debouncer - durationOfPreviousState (defined in Debouncer)Debouncerprotected - fallingEdge() constBounceinline - fell() constDebouncer - getPin() constBounceinline - interval(uint16_t interval_millis)Debouncer - interval_millis (defined in Debouncer)Debouncerprotected - pinBounceprotected - previous_millis (defined in Debouncer)Debouncerprotected - previousDuration() constDebouncer - read() constDebouncer - readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual - risingEdge() constBounceinline - rose() constDebouncer - setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual - state (defined in Debouncer)Debouncerprotected - stateChangeLastTime (defined in Debouncer)Debouncerprotected - update()Debouncer + duration()Debouncerinline + durationOfPreviousState (defined in Debouncer)Debouncerprotected + fallingEdge() constBounceinline + fell() constDebouncer + getPin() constBounceinline + interval(uint16_t interval_millis)Debouncer + interval_millis (defined in Debouncer)Debouncerprotected + pinBounceprotected + previous_millis (defined in Debouncer)Debouncerprotected + previousDuration() constDebouncer + read() constDebouncer + readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual + risingEdge() constBounceinline + rose() constDebouncer + setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual + state (defined in Debouncer)Debouncerprotected + stateChangeLastTime (defined in Debouncer)Debouncerprotected + update()Debouncer
diff --git a/docs/files/class_bounce.html b/docs/files/class_bounce.html index b050b51..52dd1c3 100644 --- a/docs/files/class_bounce.html +++ b/docs/files/class_bounce.html @@ -140,6 +140,9 @@ bool unsigned long previousDuration () const  Returns the duration in milliseconds of the previous state. More...
  +unsigned long duration () + DEPRECATED (i.e. do not use). Renamed currentDuration(). More...
+  diff --git a/docs/files/class_bounce2_1_1_button-members.html b/docs/files/class_bounce2_1_1_button-members.html index 96091af..e9595d9 100644 --- a/docs/files/class_bounce2_1_1_button-members.html +++ b/docs/files/class_bounce2_1_1_button-members.html @@ -81,29 +81,30 @@ $(function() { - - - - - - - - - - - - - - - - - - - - - - - + + + + + + + + + + + + + + + + + + + + + + + +

Protected Member Functions

changed() constDebouncerinline
currentDuration() constDebouncer
Debouncer()Debouncer
durationOfPreviousState (defined in Debouncer)Debouncerprotected
fallingEdge() constBounceinline
fell() constDebouncer
getPin() constBounceinline
getPressedState() constBounce2::Buttoninline
interval(uint16_t interval_millis)Debouncer
interval_millis (defined in Debouncer)Debouncerprotected
isPressed() constBounce2::Buttoninline
pinBounceprotected
pressed() constBounce2::Buttoninline
previous_millis (defined in Debouncer)Debouncerprotected
previousDuration() constDebouncer
read() constDebouncer
readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual
released() constBounce2::Buttoninline
risingEdge() constBounceinline
rose() constDebouncer
setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual
setPressedState(bool state)Bounce2::Buttoninline
state (defined in Debouncer)Debouncerprotected
stateChangeLastTime (defined in Debouncer)Debouncerprotected
stateForPressed (defined in Bounce2::Button)Bounce2::Buttonprotected
update()Debouncer
duration()Debouncerinline
durationOfPreviousState (defined in Debouncer)Debouncerprotected
fallingEdge() constBounceinline
fell() constDebouncer
getPin() constBounceinline
getPressedState() constBounce2::Buttoninline
interval(uint16_t interval_millis)Debouncer
interval_millis (defined in Debouncer)Debouncerprotected
isPressed() constBounce2::Buttoninline
pinBounceprotected
pressed() constBounce2::Buttoninline
previous_millis (defined in Debouncer)Debouncerprotected
previousDuration() constDebouncer
read() constDebouncer
readCurrentState() (defined in Bounce)Bounceinlineprotectedvirtual
released() constBounce2::Buttoninline
risingEdge() constBounceinline
rose() constDebouncer
setPinMode(int pin, int mode) (defined in Bounce)Bounceinlineprotectedvirtual
setPressedState(bool state)Bounce2::Buttoninline
state (defined in Debouncer)Debouncerprotected
stateChangeLastTime (defined in Debouncer)Debouncerprotected
stateForPressed (defined in Bounce2::Button)Bounce2::Buttonprotected
update()Debouncer
diff --git a/docs/files/class_bounce2_1_1_button.html b/docs/files/class_bounce2_1_1_button.html index 867e51a..c1491c0 100644 --- a/docs/files/class_bounce2_1_1_button.html +++ b/docs/files/class_bounce2_1_1_button.html @@ -163,6 +163,9 @@ bool unsigned long previousDuration () const  Returns the duration in milliseconds of the previous state. More...
  +unsigned long duration () + DEPRECATED (i.e. do not use). Renamed currentDuration(). More...
+  @@ -274,7 +277,7 @@ void src/Bounce2.h -
Bounce2::Button::Button
Button()
Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
Definition: Bounce2.h:272
+
Bounce2::Button::Button
Button()
Create an instance of the Button class. By default, the pressed state is matched to a HIGH electrical...
Definition: Bounce2.h:290
Generated by   diff --git a/docs/files/class_debouncer-members.html b/docs/files/class_debouncer-members.html index 38e32cd..8867ef7 100644 --- a/docs/files/class_debouncer-members.html +++ b/docs/files/class_debouncer-members.html @@ -72,18 +72,19 @@ $(function() {
- - - - - - - - - - - - + + + + + + + + + + + + +

Protected Attributes

begin ()
changed() constDebouncerinline
currentDuration() constDebouncer
Debouncer()Debouncer
durationOfPreviousState (defined in Debouncer)Debouncerprotected
fell() constDebouncer
interval(uint16_t interval_millis)Debouncer
interval_millis (defined in Debouncer)Debouncerprotected
previous_millis (defined in Debouncer)Debouncerprotected
previousDuration() constDebouncer
read() constDebouncer
readCurrentState()=0 (defined in Debouncer)Debouncerprotectedpure virtual
rose() constDebouncer
state (defined in Debouncer)Debouncerprotected
stateChangeLastTime (defined in Debouncer)Debouncerprotected
update()Debouncer
duration()Debouncerinline
durationOfPreviousState (defined in Debouncer)Debouncerprotected
fell() constDebouncer
interval(uint16_t interval_millis)Debouncer
interval_millis (defined in Debouncer)Debouncerprotected
previous_millis (defined in Debouncer)Debouncerprotected
previousDuration() constDebouncer
read() constDebouncer
readCurrentState()=0 (defined in Debouncer)Debouncerprotectedpure virtual
rose() constDebouncer
state (defined in Debouncer)Debouncerprotected
stateChangeLastTime (defined in Debouncer)Debouncerprotected
update()Debouncer
diff --git a/docs/files/class_debouncer.html b/docs/files/class_debouncer.html index ae47dfa..7fbb85b 100644 --- a/docs/files/class_debouncer.html +++ b/docs/files/class_debouncer.html @@ -117,6 +117,9 @@ bool unsigned long previousDuration () const  Returns the duration in milliseconds of the previous state. More...
  +unsigned long duration () + DEPRECATED (i.e. do not use). Renamed currentDuration(). More...
+  @@ -215,6 +218,35 @@ unsigned long 

Protected Member Functions

durationOfPr

Is reset to 0 once the pin rises ( rose() ) or falls ( fell() ).

Returns
The duration in milliseconds (unsigned long) of the current state.
+ + + +

◆ duration()

+ +
+
+ + + + + +
+ + + + + + + +
unsigned long Debouncer::duration ()
+ 		+inline
+
+ +

DEPRECATED (i.e. do not use). Renamed currentDuration().

+

This member function is DEPRECATED will be removed next major version. DO NOT USE IT. USE currentDuration() INSTEAD. It was renamed to avoid confusion with previousDuration().

+
Returns
The duration in milliseconds (unsigned long) of the current state.
+
@@ -259,7 +291,7 @@ unsigned long 		durationOfPr

Returns the duration in milliseconds of the previous state.

-

Takes the values of duration() once the pin changes state.

+

Takes the values of duration() once the pin changes state.

Returns
The duration in milliseconds (unsigned long) of the previous state.
diff --git a/docs/files/functions.html b/docs/files/functions.html index d926b39..4a0bc85 100644 --- a/docs/files/functions.html +++ b/docs/files/functions.html @@ -80,6 +80,9 @@ $(function() {
  • Debouncer() : Debouncer
    • +
  • duration() +: Debouncer +
  • fallingEdge() : Bounce
    • diff --git a/docs/files/functions_func.html b/docs/files/functions_func.html index bb349e4..31bd42c 100644 --- a/docs/files/functions_func.html +++ b/docs/files/functions_func.html @@ -80,6 +80,9 @@ $(function() {
  • Debouncer() : Debouncer
    • +
  • duration() +: Debouncer +
  • fallingEdge() : Bounce
    • diff --git a/docs/files/index.html b/docs/files/index.html index dc8dddf..be50e7a 100644 --- a/docs/files/index.html +++ b/docs/files/index.html @@ -221,12 +221,12 @@ $(function() {
    #define BOUNCE_WITH_PROMPT_DETECTION
    -
    Bounce2::Button
    Definition: Bounce2.h:258
    +
    Bounce2::Button
    Definition: Bounce2.h:276
    Debouncer::interval
    void interval(uint16_t interval_millis)
    Sets the debounce interval in milliseconds.
    Definition: Bounce2.cpp:14
    -
    Bounce2::Button::pressed
    bool pressed() const
    Returns true if the button was physically pressed
    Definition: Bounce2.h:302
    +
    Bounce2::Button::pressed
    bool pressed() const
    Returns true if the button was physically pressed
    Definition: Bounce2.h:320
    Debouncer::update
    bool update()
    Updates the pin's state.
    Definition: Bounce2.cpp:32
    -
    Bounce
    The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. This class is odly named,...
    Definition: Bounce2.h:168
    -
    Bounce2::Button::setPressedState
    void setPressedState(bool state)
    Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default,...
    Definition: Bounce2.h:281
    +
    Bounce
    The Debouncer:Bounce class. Links the Deboucing class to a hardware pin. This class is odly named,...
    Definition: Bounce2.h:184
    +
    Bounce2::Button::setPressedState
    void setPressedState(bool state)
    Set the electrical state (HIGH/LOW) that corresponds to a physical press. By default,...
    Definition: Bounce2.h:299
    Debouncer::fell
    bool fell() const
    Returns true if pin signal transitions from high to low.
    Definition: Bounce2.cpp:128
    Bounce::attach
    void attach(int pin, int mode)
    Attach to a pin and sets that pin's mode (INPUT, INPUT_PULLUP or OUTPUT).
    Definition: Bounce2.cpp:149
    Debouncer::read
    bool read() const
    Returns the pin's state (HIGH or LOW).
    Definition: Bounce2.cpp:118
    diff --git a/docs/files/search/all_3.js b/docs/files/search/all_3.js index 10b8335..d9ca9ea 100644 --- a/docs/files/search/all_3.js +++ b/docs/files/search/all_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['debouncer_7',['Debouncer',['../class_debouncer.html',1,'Debouncer'],['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer::Debouncer()']]] + ['debouncer_7',['Debouncer',['../class_debouncer.html',1,'Debouncer'],['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer::Debouncer()']]], + ['duration_8',['duration',['../class_debouncer.html#a462994f1f9a20876b2ee239eeee97448',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_4.js b/docs/files/search/all_4.js index 3787fd7..d02a85b 100644 --- a/docs/files/search/all_4.js +++ b/docs/files/search/all_4.js @@ -1,5 +1,5 @@ var searchData= [ - ['fallingedge_8',['fallingEdge',['../class_bounce.html#a3ef5b85db62a7a7807f0050c86cc735f',1,'Bounce']]], - ['fell_9',['fell',['../class_debouncer.html#a80315de311b855f9787b4b6d5b7899e0',1,'Debouncer']]] + ['fallingedge_9',['fallingEdge',['../class_bounce.html#a3ef5b85db62a7a7807f0050c86cc735f',1,'Bounce']]], + ['fell_10',['fell',['../class_debouncer.html#a80315de311b855f9787b4b6d5b7899e0',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_5.js b/docs/files/search/all_5.js index cc156f9..5a7c848 100644 --- a/docs/files/search/all_5.js +++ b/docs/files/search/all_5.js @@ -1,5 +1,5 @@ var searchData= [ - ['getpin_10',['getPin',['../class_bounce.html#a114878745aa1f29d3c0c293538280646',1,'Bounce']]], - ['getpressedstate_11',['getPressedState',['../class_bounce2_1_1_button.html#a1f90c647e0c75d243cdafed16c6eb28c',1,'Bounce2::Button']]] + ['getpin_11',['getPin',['../class_bounce.html#a114878745aa1f29d3c0c293538280646',1,'Bounce']]], + ['getpressedstate_12',['getPressedState',['../class_bounce2_1_1_button.html#a1f90c647e0c75d243cdafed16c6eb28c',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/all_6.js b/docs/files/search/all_6.js index 5868912..75842c3 100644 --- a/docs/files/search/all_6.js +++ b/docs/files/search/all_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['interval_12',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]], - ['ispressed_13',['isPressed',['../class_bounce2_1_1_button.html#a73c7c9ef574afe8bf1a9f3eb492bfa7f',1,'Bounce2::Button']]] + ['interval_13',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]], + ['ispressed_14',['isPressed',['../class_bounce2_1_1_button.html#a73c7c9ef574afe8bf1a9f3eb492bfa7f',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/all_7.js b/docs/files/search/all_7.js index 99db241..da31e51 100644 --- a/docs/files/search/all_7.js +++ b/docs/files/search/all_7.js @@ -1,6 +1,6 @@ var searchData= [ - ['pin_14',['pin',['../class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a',1,'Bounce']]], - ['pressed_15',['pressed',['../class_bounce2_1_1_button.html#a61541ae21354cb7f5cc5bc8c05db59dd',1,'Bounce2::Button']]], - ['previousduration_16',['previousDuration',['../class_debouncer.html#ac6af22dc9c6ae84462fe356b7430659e',1,'Debouncer']]] + ['pin_15',['pin',['../class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a',1,'Bounce']]], + ['pressed_16',['pressed',['../class_bounce2_1_1_button.html#a61541ae21354cb7f5cc5bc8c05db59dd',1,'Bounce2::Button']]], + ['previousduration_17',['previousDuration',['../class_debouncer.html#ac6af22dc9c6ae84462fe356b7430659e',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_8.js b/docs/files/search/all_8.js index bc772aa..2c6b119 100644 --- a/docs/files/search/all_8.js +++ b/docs/files/search/all_8.js @@ -1,7 +1,7 @@ var searchData= [ - ['read_17',['read',['../class_debouncer.html#aa5fcde9156f700c362fd49af5dd92ecd',1,'Debouncer']]], - ['released_18',['released',['../class_bounce2_1_1_button.html#ae9bc1365cf132e57feda6dff112edbad',1,'Bounce2::Button']]], - ['risingedge_19',['risingEdge',['../class_bounce.html#adff02eed264355c2bf90d131768f84c2',1,'Bounce']]], - ['rose_20',['rose',['../class_debouncer.html#ab61244e043754ebdc7a156da1e1824bf',1,'Debouncer']]] + ['read_18',['read',['../class_debouncer.html#aa5fcde9156f700c362fd49af5dd92ecd',1,'Debouncer']]], + ['released_19',['released',['../class_bounce2_1_1_button.html#ae9bc1365cf132e57feda6dff112edbad',1,'Bounce2::Button']]], + ['risingedge_20',['risingEdge',['../class_bounce.html#adff02eed264355c2bf90d131768f84c2',1,'Bounce']]], + ['rose_21',['rose',['../class_debouncer.html#ab61244e043754ebdc7a156da1e1824bf',1,'Debouncer']]] ]; diff --git a/docs/files/search/all_9.js b/docs/files/search/all_9.js index 7af647e..e26ccfa 100644 --- a/docs/files/search/all_9.js +++ b/docs/files/search/all_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['setpressedstate_21',['setPressedState',['../class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e',1,'Bounce2::Button']]] + ['setpressedstate_22',['setPressedState',['../class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/all_a.js b/docs/files/search/all_a.js index e0e8bda..d2a3fa7 100644 --- a/docs/files/search/all_a.js +++ b/docs/files/search/all_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['update_22',['update',['../class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06',1,'Debouncer']]] + ['update_23',['update',['../class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06',1,'Debouncer']]] ]; diff --git a/docs/files/search/classes_0.js b/docs/files/search/classes_0.js index 33dad1a..7d00ede 100644 --- a/docs/files/search/classes_0.js +++ b/docs/files/search/classes_0.js @@ -1,5 +1,5 @@ var searchData= [ - ['bounce_23',['Bounce',['../class_bounce.html',1,'']]], - ['button_24',['Button',['../class_bounce2_1_1_button.html',1,'Bounce2']]] + ['bounce_24',['Bounce',['../class_bounce.html',1,'']]], + ['button_25',['Button',['../class_bounce2_1_1_button.html',1,'Bounce2']]] ]; diff --git a/docs/files/search/classes_1.js b/docs/files/search/classes_1.js index 7d5535f..0de1744 100644 --- a/docs/files/search/classes_1.js +++ b/docs/files/search/classes_1.js @@ -1,4 +1,4 @@ var searchData= [ - ['debouncer_25',['Debouncer',['../class_debouncer.html',1,'']]] + ['debouncer_26',['Debouncer',['../class_debouncer.html',1,'']]] ]; diff --git a/docs/files/search/functions_0.js b/docs/files/search/functions_0.js index 5f58e96..8d8cac2 100644 --- a/docs/files/search/functions_0.js +++ b/docs/files/search/functions_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['attach_27',['attach',['../class_bounce.html#aba08e592941465d033e3eba3dde66eaf',1,'Bounce::attach(int pin, int mode)'],['../class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e',1,'Bounce::attach(int pin)']]] + ['attach_28',['attach',['../class_bounce.html#aba08e592941465d033e3eba3dde66eaf',1,'Bounce::attach(int pin, int mode)'],['../class_bounce.html#a163477dbcbaf1a3dee6cb3b62eedf09e',1,'Bounce::attach(int pin)']]] ]; diff --git a/docs/files/search/functions_1.js b/docs/files/search/functions_1.js index 63d4fa7..67b5f24 100644 --- a/docs/files/search/functions_1.js +++ b/docs/files/search/functions_1.js @@ -1,5 +1,5 @@ var searchData= [ - ['bounce_28',['Bounce',['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce']]], - ['button_29',['Button',['../class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad',1,'Bounce2::Button']]] + ['bounce_29',['Bounce',['../class_bounce.html#aa62a2e2b5ad0ee6913a95f2f2a0e7606',1,'Bounce']]], + ['button_30',['Button',['../class_bounce2_1_1_button.html#a18710b645862d2b8f058a73aabbaf7ad',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/functions_2.js b/docs/files/search/functions_2.js index 2c52768..2660b1a 100644 --- a/docs/files/search/functions_2.js +++ b/docs/files/search/functions_2.js @@ -1,5 +1,5 @@ var searchData= [ - ['changed_30',['changed',['../class_debouncer.html#a1bbd627f9d8809b5ee9e64e9fb21e248',1,'Debouncer']]], - ['currentduration_31',['currentDuration',['../class_debouncer.html#a883645ca26b4df6e5823586432104d11',1,'Debouncer']]] + ['changed_31',['changed',['../class_debouncer.html#a1bbd627f9d8809b5ee9e64e9fb21e248',1,'Debouncer']]], + ['currentduration_32',['currentDuration',['../class_debouncer.html#a883645ca26b4df6e5823586432104d11',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_3.js b/docs/files/search/functions_3.js index 2ab528f..dee29f8 100644 --- a/docs/files/search/functions_3.js +++ b/docs/files/search/functions_3.js @@ -1,4 +1,5 @@ var searchData= [ - ['debouncer_32',['Debouncer',['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer']]] + ['debouncer_33',['Debouncer',['../class_debouncer.html#a34c46ca04d4178933cc0049436d10fe6',1,'Debouncer']]], + ['duration_34',['duration',['../class_debouncer.html#a462994f1f9a20876b2ee239eeee97448',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_4.js b/docs/files/search/functions_4.js index 0188c5f..e1d97ae 100644 --- a/docs/files/search/functions_4.js +++ b/docs/files/search/functions_4.js @@ -1,5 +1,5 @@ var searchData= [ - ['fallingedge_33',['fallingEdge',['../class_bounce.html#a3ef5b85db62a7a7807f0050c86cc735f',1,'Bounce']]], - ['fell_34',['fell',['../class_debouncer.html#a80315de311b855f9787b4b6d5b7899e0',1,'Debouncer']]] + ['fallingedge_35',['fallingEdge',['../class_bounce.html#a3ef5b85db62a7a7807f0050c86cc735f',1,'Bounce']]], + ['fell_36',['fell',['../class_debouncer.html#a80315de311b855f9787b4b6d5b7899e0',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_5.js b/docs/files/search/functions_5.js index 9fe6341..0a83d17 100644 --- a/docs/files/search/functions_5.js +++ b/docs/files/search/functions_5.js @@ -1,5 +1,5 @@ var searchData= [ - ['getpin_35',['getPin',['../class_bounce.html#a114878745aa1f29d3c0c293538280646',1,'Bounce']]], - ['getpressedstate_36',['getPressedState',['../class_bounce2_1_1_button.html#a1f90c647e0c75d243cdafed16c6eb28c',1,'Bounce2::Button']]] + ['getpin_37',['getPin',['../class_bounce.html#a114878745aa1f29d3c0c293538280646',1,'Bounce']]], + ['getpressedstate_38',['getPressedState',['../class_bounce2_1_1_button.html#a1f90c647e0c75d243cdafed16c6eb28c',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/functions_6.js b/docs/files/search/functions_6.js index 991e1c8..6f7e923 100644 --- a/docs/files/search/functions_6.js +++ b/docs/files/search/functions_6.js @@ -1,5 +1,5 @@ var searchData= [ - ['interval_37',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]], - ['ispressed_38',['isPressed',['../class_bounce2_1_1_button.html#a73c7c9ef574afe8bf1a9f3eb492bfa7f',1,'Bounce2::Button']]] + ['interval_39',['interval',['../class_debouncer.html#a930bf3945e698d77b889f6309079857d',1,'Debouncer']]], + ['ispressed_40',['isPressed',['../class_bounce2_1_1_button.html#a73c7c9ef574afe8bf1a9f3eb492bfa7f',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/functions_7.js b/docs/files/search/functions_7.js index 471419e..19ed656 100644 --- a/docs/files/search/functions_7.js +++ b/docs/files/search/functions_7.js @@ -1,5 +1,5 @@ var searchData= [ - ['pressed_39',['pressed',['../class_bounce2_1_1_button.html#a61541ae21354cb7f5cc5bc8c05db59dd',1,'Bounce2::Button']]], - ['previousduration_40',['previousDuration',['../class_debouncer.html#ac6af22dc9c6ae84462fe356b7430659e',1,'Debouncer']]] + ['pressed_41',['pressed',['../class_bounce2_1_1_button.html#a61541ae21354cb7f5cc5bc8c05db59dd',1,'Bounce2::Button']]], + ['previousduration_42',['previousDuration',['../class_debouncer.html#ac6af22dc9c6ae84462fe356b7430659e',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_8.js b/docs/files/search/functions_8.js index 890b308..b7f656f 100644 --- a/docs/files/search/functions_8.js +++ b/docs/files/search/functions_8.js @@ -1,7 +1,7 @@ var searchData= [ - ['read_41',['read',['../class_debouncer.html#aa5fcde9156f700c362fd49af5dd92ecd',1,'Debouncer']]], - ['released_42',['released',['../class_bounce2_1_1_button.html#ae9bc1365cf132e57feda6dff112edbad',1,'Bounce2::Button']]], - ['risingedge_43',['risingEdge',['../class_bounce.html#adff02eed264355c2bf90d131768f84c2',1,'Bounce']]], - ['rose_44',['rose',['../class_debouncer.html#ab61244e043754ebdc7a156da1e1824bf',1,'Debouncer']]] + ['read_43',['read',['../class_debouncer.html#aa5fcde9156f700c362fd49af5dd92ecd',1,'Debouncer']]], + ['released_44',['released',['../class_bounce2_1_1_button.html#ae9bc1365cf132e57feda6dff112edbad',1,'Bounce2::Button']]], + ['risingedge_45',['risingEdge',['../class_bounce.html#adff02eed264355c2bf90d131768f84c2',1,'Bounce']]], + ['rose_46',['rose',['../class_debouncer.html#ab61244e043754ebdc7a156da1e1824bf',1,'Debouncer']]] ]; diff --git a/docs/files/search/functions_9.js b/docs/files/search/functions_9.js index 36672f7..b90337e 100644 --- a/docs/files/search/functions_9.js +++ b/docs/files/search/functions_9.js @@ -1,4 +1,4 @@ var searchData= [ - ['setpressedstate_45',['setPressedState',['../class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e',1,'Bounce2::Button']]] + ['setpressedstate_47',['setPressedState',['../class_bounce2_1_1_button.html#a3c88b7938b26bca9dc2c7e72aedc442e',1,'Bounce2::Button']]] ]; diff --git a/docs/files/search/functions_a.js b/docs/files/search/functions_a.js index 30d713b..512e91d 100644 --- a/docs/files/search/functions_a.js +++ b/docs/files/search/functions_a.js @@ -1,4 +1,4 @@ var searchData= [ - ['update_46',['update',['../class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06',1,'Debouncer']]] + ['update_48',['update',['../class_debouncer.html#a72f3e8d483555031d2ac21b0b7702c06',1,'Debouncer']]] ]; diff --git a/docs/files/search/namespaces_0.js b/docs/files/search/namespaces_0.js index d5f9c00..81c77a8 100644 --- a/docs/files/search/namespaces_0.js +++ b/docs/files/search/namespaces_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['bounce2_26',['Bounce2',['../namespace_bounce2.html',1,'']]] + ['bounce2_27',['Bounce2',['../namespace_bounce2.html',1,'']]] ]; diff --git a/docs/files/search/pages_0.js b/docs/files/search/pages_0.js index b5c0e13..59664cc 100644 --- a/docs/files/search/pages_0.js +++ b/docs/files/search/pages_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['bounce_202_48',['BOUNCE 2',['../index.html',1,'']]] + ['bounce_202_50',['BOUNCE 2',['../index.html',1,'']]] ]; diff --git a/docs/files/search/variables_0.js b/docs/files/search/variables_0.js index 415c185..88576ca 100644 --- a/docs/files/search/variables_0.js +++ b/docs/files/search/variables_0.js @@ -1,4 +1,4 @@ var searchData= [ - ['pin_47',['pin',['../class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a',1,'Bounce']]] + ['pin_49',['pin',['../class_bounce.html#a1cb79cb0ba2379cd12cc7c098d97053a',1,'Bounce']]] ]; diff --git a/library.json b/library.json index d8915db..c1ab47e 100644 --- a/library.json +++ b/library.json @@ -6,7 +6,7 @@ "type": "git", "url": "https://github.com/thomasfredericks/Bounce2.git" }, - "version": "2.70", + "version": "2.71", "exclude": [ "*.png", "*.zip" diff --git a/library.properties b/library.properties index 6e2c192..0d4a358 100644 --- a/library.properties +++ b/library.properties @@ -1,5 +1,5 @@ name=Bounce2 -version=2.70 +version=2.71 author=Thomas O Fredericks with contributions from Eric Lowry, Jim Schimpf, Tom Harkaway, Joachim Krüger and MrGradgrind. maintainer=Thomas O Fredericks sentence=Debouncing library for Arduino and Wiring. diff --git a/src/Bounce2.h b/src/Bounce2.h index 83363ec..7dea71e 100644 --- a/src/Bounce2.h +++ b/src/Bounce2.h @@ -128,6 +128,9 @@ public: @return True if the state changed on last update. Otherwise, returns false. */ bool changed( ) const { return getStateFlag(CHANGED_STATE); } + + + /** @brief Returns the duration in milliseconds of the current state. @@ -148,6 +151,19 @@ public: @return The duration in milliseconds (unsigned long) of the previous state. */ unsigned long previousDuration() const; + + /** + @brief DEPRECATED (i.e. do not use). Renamed currentDuration(). + + This member function is DEPRECATED will be removed next major version. DO NOT USE IT. USE currentDuration() INSTEAD. + It was renamed to avoid confusion with previousDuration(). + + @return The duration in milliseconds (unsigned long) of the current state. + */ + [[deprecated]] + unsigned long duration() { + return currentDuration(); + }; protected: void begin(); @@ -221,10 +237,12 @@ public: /** @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1 */ + [[deprecated]] bool risingEdge() const { return rose(); } /** @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1 */ + [[deprecated]] bool fallingEdge() const { return fell(); } /** @brief Deprecated (i.e. do not use). Included for partial compatibility for programs written with Bounce version 1