Skip to content

Commit 4c6ef05

Browse files
committed
Documentation update
1 parent bb9f258 commit 4c6ef05

6 files changed

Lines changed: 2 additions & 1 deletion

File tree

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22

33
A library for using a simple mechanical push (momentary) button as a momentary button, a latching button, a counter, an enumerator, and more. The library allows a mechanical momentary button to be used as a virtual button with different functionality. The library implements the behavior of a momentary button, a latching button, a counter, an enumerator, and more. It also makes it very easy to develop buttons with your own custom behavior. The Bounce2 library is used to add debouncing functionality.
44

5+
Note that because some input devices like optical sensors or limit switches are functionally equivilent to tactile buttons, they can also be used with this library.
56

67
## Types of Buttons
78
This library contains two categories of button types. The first category is two state buttons; these are either on or off. The second category provides incrementing buttons that can perform different types of counting. These two categories of buttons are described here. See "Software Design" below for information about how the source code implements these behaviors.
12.9 KB
Loading

documentation/Documentation.pptx

593 Bytes
Binary file not shown.
67.2 KB
Loading
70.1 KB
Loading

library.properties

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ version=2.0.0
33
author=Lance A. Endres <lendres@fifthrace.com>
44
maintainer=Lance A. Endres <lendres@fifthrace.com>
55
sentence=A library for using a simple mechanical push (momentary) button as a momentary button, a latching button, a counter, an enumerator, and more.
6-
paragraph=The library allows a mechanical momentary button to be used as a virtual button with different functionality. The library implements the behavior of a momentary button, a latching button, a counter, an enumerator, and more. It also makes it very easy to develop buttons with your own custom behavior. The Bounce2 library is used to add debouncing functionality.
6+
paragraph=The library allows a mechanical momentary button to be used as a virtual button with different functionality. The library implements the behavior of a momentary button, a latching button, a counter, an enumerator, and more. It also makes it very easy to develop buttons with your own custom behavior. The Bounce2 library is used to add debouncing functionality. Note that because some input devices like optical sensors or limit switches are functionally equivilent to tactile buttons, they can also be used with this library.
77
category=Signal Input/Output
88
url=https://github.com/lendres/ButtonSuite-Arduino
99
architectures=*

0 commit comments

Comments
 (0)