Recent changes to PushButtonArray

PushButtonArray modified by Perrotti

Perrotti — Sun, 31 Mar 2019 00:20:56 -0000

--- v5
+++ v6
@@ -50,6 +50,7 @@

 **owner**: ButtonOwner instance. Events are sent to owner.

+---
 ######boolean begin(byte maxButtons)######
 Call before any other method. This method alloc the array, check the return to make sure that the array was successfully allocated.

PushButtonArray modified by Perrotti

Perrotti — Sun, 31 Mar 2019 00:19:54 -0000

--- v4
+++ v5
@@ -5,7 +5,7 @@

 * File: pPushButton.h
 * Dependences: pGlobals.h, pOwners.h
-* Em protuguês: [Classe PushButtonArray](https://perrobotica.fandom.com/pt-br/wiki/Classe_PushButtonArray)
+* Em português: [Classe PushButtonArray](https://perrobotica.fandom.com/pt-br/wiki/Classe_PushButtonArray)

 Public declarations:
 ~~~

PushButtonArray modified by Perrotti

Perrotti — Sun, 31 Mar 2019 00:19:32 -0000

--- v3
+++ v4
@@ -5,6 +5,7 @@

 * File: pPushButton.h
 * Dependences: pGlobals.h, pOwners.h
+* Em protuguês: [Classe PushButtonArray](https://perrobotica.fandom.com/pt-br/wiki/Classe_PushButtonArray)

 Public declarations:
 ~~~

PushButtonArray modified by Perrotti

Perrotti — Fri, 22 Mar 2019 20:18:35 -0000

--- v2
+++ v3
@@ -14,7 +14,7 @@
    virtual void buttonReleased(byte btID){}
 };

-class PushButtonArray: private ButtonOwner{
+class PushButtonArray{
 public:
    byte btCount=0;
    PushButton** but;
@@ -23,7 +23,7 @@
    PushButtonArray(ButtonOwner *owner);

    boolean begin(byte maxButtons);
-   byte addButton(byte buttonPin, boolean pullUp=true);
+   int addButton(byte buttonPin, boolean pullUp=true);
    void run();
    boolean isPressed(byte btID);

@@ -32,3 +32,59 @@
    virtual void onButtonReleased(byte btID){}
 };
 ~~~
+
+---
+#####How to use#####
+Call ***begin()*** before any method informing how many buttons you want in array.  Dont forget to check ***begin() ***return to make sure that the array was successfully allocated. 
+Add buttons to array calling ***addButton()*** informing pin and input mode.  
+Call ***run()*** at least once per loop to class trigger events.  
+Call ***isPressed()*** to check if one button is pressed. 
+
+***ButtonOwner***
+Is a abstract class to receive button's events. This is usefull when the class that respond the events, is not descending of ***PushButtonArray*** class. To use this way, derive ***ButtonOwner*** class, rewrite the events and use the constructor with owner to create ***PushButtonArray***'s instance.
+
+---
+######PushButtonArray(ButtonOwner *owner)######
+Constructor with button's owner. If you use this constructor, events will be send to owner and not to ***PushButtonArray*** class.
+
+**owner**: ButtonOwner instance. Events are sent to owner.
+
+######boolean begin(byte maxButtons)######
+Call before any other method. This method alloc the array, check the return to make sure that the array was successfully allocated. 
+
+* **maxButtons**: How many buttons in the array.
+* **return**: true if array was successfully allocated, false if not. 
+
+---
+######int addButton(byte buttonPin, boolean pullUp=true)######
+Add button on array. 
+
+* **buttonPin**: button pin.
+* **return**: The button's ID or negative value if any error occurred. 
+
+---
+######void run()######
+Call once per loop. This method trigger the events.
+
+---
+######boolean isPressed(byte btID)######
+Call to check if one button is pressed or not. 
+
+***btID***: ID of button
+**return**: true if the button is pressed , false if not.
+
+---
+######virtual void onButtonPressed(byte btID)######
+Event triggered when one button is pressed. To capture this event, derive ***PushButtonArray*** class and rewrite it. 
+This event is not triggered if the constructor with owner is used. 
+
+***btID***: ID of button
+
+---
+######virtual void onButtonReleased(byte btID)######
+Event triggered when button is released. To capture this event, derive ***PushButtonArray*** class and rewrite it. 
+This event is not triggered if the constructor with owner is used. 
+
+***btID***: ID of button
+
+

PushButtonArray modified by Perrotti

Perrotti — Wed, 20 Mar 2019 08:41:02 -0000

--- v1
+++ v2
@@ -1,7 +1,7 @@
-Class PushButton
+Class PushButtonArray
 ---

-Class to drive a single push button.
+Class to drive a array of push buttons.

 * File: pPushButton.h
 * Dependences: pGlobals.h, pOwners.h

PushButtonArray modified by Perrotti

Perrotti — Wed, 20 Mar 2019 08:39:06 -0000

Class PushButton

Class to drive a single push button.

File: pPushButton.h
Dependences: pGlobals.h, pOwners.h

Public declarations:

class ButtonOwner{
public:
    virtual void buttonPressed(byte btID){}
    virtual void buttonReleased(byte btID){}
};

class PushButtonArray: private ButtonOwner{
public:
    byte btCount=0;
    PushButton** but;

    PushButtonArray();
    PushButtonArray(ButtonOwner *owner);

    boolean begin(byte maxButtons);
    byte addButton(byte buttonPin, boolean pullUp=true);
    void run();
    boolean isPressed(byte btID);

protected:
    virtual void onButtonPressed(byte btID){}
    virtual void onButtonReleased(byte btID){}
};