Skip to content

Commit

Permalink
Added singleClick and reorganized code
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin-Laclaustra authored and Martin-Laclaustra committed Jul 28, 2018
1 parent 3a24284 commit ae43662
Show file tree
Hide file tree
Showing 8 changed files with 248 additions and 139 deletions.
21 changes: 9 additions & 12 deletions Examples/SwitchCallbackExample/SwitchCallbackExample.ino
View file
Original file line number Diff line number Diff line change
@@ -1,15 +1,11 @@
#include "Arduino.h"
#include "avdweb_Switch.h"

const byte toggleSwitchpin = 13;
const byte buttonGNDpin = 4;
const byte ButtonVCCpin = 2;
const byte Button10mspin = 12;
const byte toggleSwitchpin = 4;
const byte multiresponseButtonpin = 12;

Switch buttonGND = Switch(buttonGNDpin); // button to GND, use internal 20K pullup resistor
Switch toggleSwitch = Switch(toggleSwitchpin);
Switch buttonVCC = Switch(ButtonVCCpin, INPUT, HIGH); // button to VCC, 10k pull-down resistor, no internal pull-up resistor, HIGH polarity
Switch button10ms = Switch(Button10mspin, INPUT_PULLUP, LOW, 1); // debounceTime 1ms
Switch multiresponseButton = Switch(multiresponseButtonpin);

void buttonCallbackFunction(void* s) {
Serial.print("Button: ");
Expand All @@ -24,15 +20,16 @@ void toggleCallbackFunction(void* s) {
void setup()
{
Serial.begin(9600);
buttonGND.setPushedCallback(&buttonCallbackFunction, (void*)"pushed");
buttonGND.setReleasedCallback(&buttonCallbackFunction, (void*)"released");
toggleSwitch.setPushedCallback(&toggleCallbackFunction, (void*)"turned on");
toggleSwitch.setReleasedCallback(&toggleCallbackFunction, (void*)"turned off");

toggleSwitch.setLongPressCallback(&toggleCallbackFunction, (void*)"long press");
toggleSwitch.setDoubleClickCallback(&toggleCallbackFunction, (void*)"double click");
multiresponseButton.setLongPressCallback(&buttonCallbackFunction, (void*)"long press");
multiresponseButton.setDoubleClickCallback(&buttonCallbackFunction, (void*)"double click");
multiresponseButton.setSingleClickCallback(&buttonCallbackFunction, (void*)"single click");
}

void loop()
{
buttonGND.poll();
toggleSwitch.poll();
multiresponseButton.poll();
}
46 changes: 46 additions & 0 deletions Examples/SwitchExample/SwitchExample.ino
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
#include "Arduino.h"
#include "avdweb_Switch.h"

const byte pushButtonpin = 2;
const byte toggleSwitchpin = 4;
const byte multiresponseButtonpin = 12;
const byte alleventsButtonpin = 13;
int i;

Switch pushButton = Switch(pushButtonpin); // button to GND, use internal 20K pullup resistor
Switch toggleSwitch = Switch(toggleSwitchpin);
Switch multiresponseButton = Switch(multiresponseButtonpin);
Switch alleventsButton = Switch(alleventsButtonpin);
// Other examples of constructors
// Switch pushButtonVCC = Switch(pushButtonpin, INPUT, HIGH); // button to VCC, 10k pull-down resistor, no internal pull-up resistor, HIGH polarity
// Switch pushButton1ms = Switch(pushButtonpin, INPUT_PULLUP, LOW, 1); // debounceTime 1ms

void setup()
{ Serial.begin(9600);
}

void loop()
{ // pushButton simple events
pushButton.poll();
if(pushButton.switched()) Serial.print("pushButton switched ");
if(pushButton.pushed()) {Serial.print("pushButton pushed "); Serial.print(++i); Serial.println(" times");}
if(pushButton.released()) Serial.println("pushButton released");

// toggleSwitch report status only when changed
if(toggleSwitch.poll()) {Serial.print("toggleSwitch status changed to "); Serial.println(toggleSwitch.on());}

// multiresponseButton complex events
multiresponseButton.poll();
if(multiresponseButton.longPress()) Serial.println("multiresponseButton longPress");
if(multiresponseButton.doubleClick()) Serial.println("multiresponseButton doubleClick");
if(multiresponseButton.singleClick()) Serial.println("multiresponseButton singleClick");

// alleventsButton complex events
alleventsButton.poll();
if(alleventsButton.switched()) {Serial.println("all_e_B switched."); Serial.print(" all_e_B status to "); Serial.print(alleventsButton.on()); Serial.println(".");}
if(alleventsButton.pushed()) {Serial.println(" all_e_B pushed.");}
if(alleventsButton.released()) Serial.println(" all_e_B released.");
if(alleventsButton.longPress()) Serial.println(" ==> all_e_B longPress.");
if(alleventsButton.doubleClick()) Serial.println(" ==> all_e_B doubleClick.");
if(alleventsButton.singleClick()) Serial.println(" ==> all_e_B singleClick.");
}
30 changes: 0 additions & 30 deletions Examples/Test_switch/Test_switch.ino
View file

This file was deleted.

104 changes: 67 additions & 37 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Available at: https://github.com/avandalen/avdweb_Switch
#### General features of the Switch library
- Performs not just de-bouncing, but also de-glitching against EMC pulses.
- External pull-up resistors are not required.
- Supports also long press and double click detection.
- Supports also long press, double click, and single click detection.
- Callback functions.

## Introduction
Expand Down Expand Up @@ -52,7 +52,7 @@ It returns "true" if the pin voltage agrees with the one defined by `polarity` (

#### pushed()

It returns "true" if a button was pushed (switched towards the on position). Use only for push buttons. Note that this is in fact "single-click".
It returns "true" if a button was pushed (switched towards the on position). Use only for push buttons. Note that this provides instant response and can be used as "single-click" if "double-click" and "long-press" are not watched events. "Pushed" occurs simultaneously with "double-click" and "long-press".

#### released()

Expand All @@ -68,6 +68,11 @@ It returns "true" if a push button is double clicked within 250ms (by default).

The anteceding pushed() event can't be avoided, because to restrict the pushed() function to single clicks it would have to wait for a possible second click, which would introduce an annoying delay. So, the action on doubleClick() has to undo the previous action on pushed().

#### singleClick()

It returns "true" if a push button is clicked once and the requirements for doubleClick and longPress are not met. The event thus occur several miliseconds after the actual push, because it depends on the other events not happening after the push. Use this if three different interactions are needed in combination with doubleClick and longPress. Note that a singleClick() always will be preceded by pushed(). Use pushed() instead if immediate response is required and there is no interest in monitoring doubleClick and longPress.


#### Example

See the example in the library for a complete working program.
Expand Down Expand Up @@ -104,7 +109,7 @@ void setup() {
}
```

The available callback setting functions are `setPushedCallback()`, `setReleasedCallback()`, `setLongPressCallback()`, and `setDoubleClickCallback()` which allow defining the functions that will be called on such events. If using a toggle switch and not a push button, the "pushed" event will be of interest when the switch is turned on, and "released" when it is turned off.
The available callback setting functions are `setPushedCallback()`, `setReleasedCallback()`, `setLongPressCallback()`, `setDoubleClickCallback()`, and `setSingleClickCallback()` which allow defining the functions that will be called on such events. If using a toggle switch and not a push button, the "pushed" event will be of interest when the switch is turned on, and "released" when it is turned off.

If the conditions for more than one event occur simultaneously and there are callback functions registered for them, they will be executed in the order of the functions above.

Expand Down Expand Up @@ -169,6 +174,10 @@ A long-press generates first a pushed event and after 300ms (by default) the lon
The same happens with doubleClick, which also generates two pushed() events. When doubleClick is used, ignore the second pushed() result or don't call pushed(). When doubleClick is not needed, simply don't call doubleClick().
#### Combining singleClick, doubleClick, and longPress events
If these three events must be used toghether the best strategy is to stick to their get functions and avoid using pushed().
## Hardware considerations
#### Connecting switches to the microcontroler
Expand Down Expand Up @@ -222,68 +231,89 @@ Several discrete signals (updated at poll times) are created. The raw signal is

```
..........................................DEGLITCHING..............................
________________ _
on | | | | _
| | | | | |
| |_| |___| |__
analog off_____|_____________________________|____________________________
on | | | | _
| | | | | |
| |_| |___| |__
analog off_____|_____________________________|____________________________
________________ _ _
input _____| |_| |___| |_______________________________
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
input _____| |_| |___| |_______________________________
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
equal 0 1 1 0 1 1 1 1 1 1 1 1 0 0 0 1 0 0 1 1 1 1 1 1 1 1 1 1 1 1 1 1 1
deglitchPeriod <--------><-- <-- <- <--------><--------><--------
___________________________
deglitched _________________| |__________________
deglitched _________________| |__________________
deglitchTime ^ ^ ^ ^ ^ ^ ^
..........................................DEBOUNCING.............................
debouncePeriod <-------------------------------->
debouncePeriod <-------------------------------->
_________________________________
debounced _________________| |____________
debounced _________________| |____________
_ _
_switched _________________| |_______________________________| |__________
switchedTime ^ ^
_switched _________________| |_______________________________| |__________
switchedTime ^ ^
**********************************************************************************
........................................DOUBLE CLICK..............................
__________ ______
debounced ________| |_______| |_____________________________
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
__________ ______
debounced ________| |_______| |_____________________________
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
_ _
pushed _________| |________________| |__________________________________
pushedTime ^ ^
pushed _________| |________________| |__________________________________
doubleClickPeriod <------------------------------------->
pushedTime ^ ^
_ _
released ____________________| |____________| |___________________________
releasedTime ^ ^
doubleClickPeriod <------------------------------------->
_
_doubleClick ___________________________| |__________________________________
........................................LONG PRESS................................
___________________________
debounced ________| |___________________________
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
longPressPeriod <--------------->
___________________________
debounced ________| |___________________________
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
longPressPeriod <--------------->
_ _
_switched _________| |_________________________| |________________________
_switched _________| |_________________________| |________________________
__________
longPressDisable ___________________________| |_________________________
longPressDisable ___________________________| |_________________________
_
_longPress ___________________________| |__________________________________
_longPress ___________________________| |__________________________________
........................................SINGLE CLICK..............................
__________ ______
debounced ________| |_______________________________| |_____
poll ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^ ^
longPressPeriod <--------------->
doubleClickPeriod <------------------------------------->
_ _ _ _
_switched _________| |_______| |_____________________________| |____| |___
_____
singleClickDisable______________________________________________| |__________
_
_singleClick _______________________________________________| |______________
```

### Additional information
Expand Down
Loading

0 comments on commit ae43662

Please sign in to comment.