Skip to content

Add documentation for debounce time parameter #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
qubist wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add documentation for debounce time parameter #12

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,8 +75,8 @@ void loop() {

Documentation
-------------
**Button(int pin)**
Creates a new Button.
**Button(int pin, int debounce_ms = 100)**
Creates a new Button attached a specified pin. If you need to, you can specify the debounce time as a second parameter. If left out, it defaults to 100ms.

**void begin()**
Call this in your `setup` method to setup the button. All it does is set the correct pin mode.
Expand Down