Skip to content

Commit 5647f8a

Browse files
committed
Properties and readme update.
Properties and readme update.
1 parent 52d35ce commit 5647f8a

2 files changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ButtonSuite
22

3-
A library for adding functionality to simple mechanical push (momentary) buttons. This library allows a simple momentary push button to be used as a momentary button, a latching button, a counter, or an enumerator. This library uses the Bounce2 library to add debouncing functionality.
3+
A library for using a simple mechanical push (momentary) button as a momentary button, a latching button, a counter, or an enumerator. 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, and an enumerator. The Bounce2 library is used to add debouncing functionality.
44

55
## Types of Buttons
66
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,22 +12,22 @@ These buttons are either on or off.
1212
This is standard push (momentary) button. It returns true when the button is pressed (held down) and false when it is not.
1313

1414
#### LatchingButton
15-
Turns a push button (momentary button) into a toggle button (latching button). Pressing the button alternates between on (true) and off (false). This is a virtual latching switch controled by a mechanical momentary button. The toggle button can be reset to the base (known) state by the user by using a long press or programmically.
15+
Turns a push button (momentary button) into a toggle button (latching button). Pressing the button alternates between on (true) and off (false). This is a virtual latching switch controled by a mechanical momentary button. The toggle button can be reset to the base (known) state by the user (with a long press) or programmically.
1616

1717
#### AlwaysOnButton
18-
Always returns true (on). Useful if you want to temporarily disable user input.
18+
Always returns that the button is on. Useful if you want to temporarily disable user input.
1919

2020
#### AlwaysOffButton
21-
Always returns false (off). Useful if you want to temporarily disable user input.
21+
Always returns that the button is off. Useful if you want to temporarily disable user input.
2222

2323
### Incrementing Buttons
2424
These buttons provide different types of counting behavior.
2525

2626
#### CountingButton
27-
Turns a push button (momentary button) into a counter. The counter is incremented each time the button is pushed. The counter continues to increment until it is either reset by the user (with a long press) or reset programically.
27+
Turns a push button (momentary button) into a counter. The counter is incremented each time the button is pushed. The counter continues to increment until it is reset either by the user (with a long press) or programically.
2828

2929
#### CycleButton
30-
Turns a push button (momentary button) into a button used to cycle through states (for example, an enum). Pressing the button causes the value to increment. Once the maximum value is reached, the value automatically resets to the initial value. The value can also be reset to the initial value programmically or by the user (with a long press).
30+
Turns a push button (momentary button) into a button used to cycle through states (for example, an enumeration). Pressing the button causes the value to increment. Once the maximum value is reached, the value automatically resets to the initial value. The value can also be reset to the initial value programmically or by the user (with a long press).
3131

3232
## Software Design
3333
Some abstract base classes provided common functionality and interface design. These cannot be instantiated.

library.properties

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
name=ButtonSuite
2-
version=1.0.0
2+
version=1.1.0
33
author=Lance A. Endres <lendres@fifthrace.com>
44
maintainer=Lance A. Endres <lendres@fifthrace.com>
5-
sentence=A set of classes for using a momentary buttons as momentary buttons, latching buttons, counters, and enumerators.
6-
paragraph=A set of classes for using momentary buttons as momentary buttons, latching buttons, counters, and enumerators. Includes debouncing. The library is designed so other classes can take a class as an argument and have always on, momentary, and/or latching behavior automatically handled without further effort.
5+
sentence=A library for using a simple mechanical push (momentary) button as a momentary button, a latching button, a counter, or an enumerator.
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, and an enumerator. The Bounce2 library is used to add debouncing functionality.
77
category=Signal Input/Output
88
url=https://github.com/lendres/ButtonSuite-Arduino
99
architectures=*

0 commit comments

Comments
 (0)