Skip to content

Commit 923165a

Browse files
committed
Added demo gif for the SSD1301306
1 parent 7ff53e7 commit 923165a

File tree

2 files changed

+5
-3
lines changed

2 files changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# MyButton Library for Arduino IDE
22

3-
<img src="images/demo.png" width=640>
3+
<img src="images/demo.gif" width=640>
44

55
> Demo using the ```readInSteps``` function (check examples for demo)
66
@@ -19,7 +19,7 @@ This library allows for:
1919

2020
## How to use ?
2121

22-
Instanciate the button object with the required options:
22+
### 1 - Instanciate the button object with the required options:
2323

2424
- Default debouncing time of **5ms**:
2525

@@ -31,7 +31,9 @@ Instanciate the button object with the required options:
3131

3232
The ```NORMAL_UP```, and ```NORMAL_DOWN``` keywords refer to whether the push button is normally UP or DOWN (pulled UP or DOWN).
3333

34-
Then call any function following the examples.
34+
### 2 - Then call a function following the examples, though:
35+
36+
One thing to take into consideration, is that for saving on resources, and since there's no apparent use-case where someone would configure one button to exert more than one of the behaviors possible through the functions, the time tracking and the state variables are **shared** between functions, so calling _ as an example _ ```readRisingClick()```, and ```readFallingClick``` back to back in the same loop would make the code behave unpredictibly.
3537

3638
## How to install ?
3739

images/demo.gif

9.37 MB
Loading

0 commit comments

Comments
 (0)