Skip to content

Commit

Permalink
Add detail for creating instances of the class
Browse files Browse the repository at this point in the history
  • Loading branch information
ncmreynolds committed Nov 19, 2021
1 parent 238d8dc commit 75ee9bc
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ If you turn on debugging it will show the row and column selection making it eas
## Methods

```c++
TapCode tapInput(uint8_t tap_button, uint8_t mode = INPUT_PULLUP); //Declare an instance 'tapInput' and start a tap input on pin tap_button. The library controls the pin and does not need pinMode setting before this. Default is INPUT_PULLUP but this can be overriden.

void begin(uint8_t max_length = 64, uint32_t press_timeout = 1000, uint32_t word_timeout = 5000); //Start the tap input

void read(); //Do housekeeping checking for pushes, run in loop to update the word as the button is tapped
Expand Down

0 comments on commit 75ee9bc

Please sign in to comment.