Skip to content

Commit

Permalink
Properties and readme update.
Browse files Browse the repository at this point in the history
Properties and readme update.
  • Loading branch information
lendres committed Jun 20, 2021
1 parent 52d35ce commit 5647f8a
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# ButtonSuite

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.
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.

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

#### LatchingButton
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.
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.

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

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

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

#### CountingButton
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.
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.

#### CycleButton
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).
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).

## Software Design
Some abstract base classes provided common functionality and interface design. These cannot be instantiated.
Expand Down
6 changes: 3 additions & 3 deletions library.properties
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
name=ButtonSuite
version=1.0.0
version=1.1.0
author=Lance A. Endres <lendres@fifthrace.com>
maintainer=Lance A. Endres <lendres@fifthrace.com>
sentence=A set of classes for using a momentary buttons as momentary buttons, latching buttons, counters, and enumerators.
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.
sentence=A library for using a simple mechanical push (momentary) button as a momentary button, a latching button, a counter, or an enumerator.
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.
category=Signal Input/Output
url=https://github.com/lendres/ButtonSuite-Arduino
architectures=*
Expand Down

0 comments on commit 5647f8a

Please sign in to comment.