Merge pull request #43 from evert-arias/v2

v2

Author: Evert Arias

examples/Interrupts/Interrupts.ino

@@ -8,14 +8,17 @@
 #include <Arduino.h>
 #include <EasyButton.h>
 
+// Arduino pin where the buttons are connected to.
 #define BUTTON_PIN 2
-#define BAUDRATE 9600
 
+#define BAUDRATE 115200
+
+// Instance of the button.
 EasyButton button(BUTTON_PIN);
 
 void buttonPressed()
 {
-  Serial.println("Button Pressed");
+  Serial.println("Button pressed");
 }
 
 void sequenceEllapsed()
@@ -25,17 +28,29 @@ void sequenceEllapsed()
 
 void buttonISR()
 {
-  //When button is being used through external interrupts, parameter INTERRUPT must be passed to read() function
-  button.read(EASYBUTTON_READ_TYPE_INTERRUPT);
+  /*
+    When button is being used through external interrupts, 
+    parameter INTERRUPT must be passed to read() function
+   */
+  button.read();
 }
 
 void setup()
 {
-  // put your setup code here, to run once:
+
+  // Initialize Serial for debuging purposes.
   Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton interrupts example <<<");
+
+  // Initialize the button.
   button.begin();
+
   button.onPressed(buttonPressed);
+
   button.onSequence(2, 1500, sequenceEllapsed);
+
   if (button.supportsInterrupt())
   {
     button.enableInterrupt(buttonISR);

examples/InterruptsOnPressedFor/InterruptsOnPressedFor.ino

@@ -8,36 +8,53 @@
 #include <Arduino.h>
 #include <EasyButton.h>
 
-#define BUTTON_PIN 2  //Should be a pin that supports external interrupts
-#define BAUDRATE 9600
+/* 
+  Arduino pin where the buttons are connected to.
+  Should be a pin that supports external interrupts. 
+ */
+#define BUTTON_PIN 2
 
+#define BAUDRATE 115200
+
+// Instance of the button.
 EasyButton button(BUTTON_PIN);
 
 void buttonPressedTwoSeconds()
 {
-  Serial.println("Button Pressed for two seconds");
+  Serial.println("Button pressed for two seconds");
 }
 
 void buttonISR()
 {
-  //When button is being used through external interrupts, parameter INTERRUPT must be passed to read() function
-  button.read(EASYBUTTON_READ_TYPE_INTERRUPT);
+  // When button is being used through external interrupts, parameter INTERRUPT must be passed to read() function.
+  button.read();
 }
 
-void setup() {
-  // put your setup code here, to run once:
+void setup()
+{
+  // Initialize Serial for debuging purposes.
   Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton onPressedFor interrupt example <<<");
+
+  // Initialize the button.
   button.begin();
+
   button.onPressedFor(2000, buttonPressedTwoSeconds);
+
   if (button.supportsInterrupt())
   {
     button.enableInterrupt(buttonISR);
-    Serial.println("EasyButton onPressedFor Interrupt example");
+    Serial.println("Button will be used through interrupts");
   }
 }
 
-void loop() {
-  // put your main code here, to run repeatedly:
-  // update() function must be called repeatedly only if onPressedFor functionality is being used and interrupt is enabled
+void loop()
+{
+  /*
+    update() function must be called repeatedly only if onPressedFor 
+    functionality is being used and interrupt is enabled.
+  */
   button.update();
 }

examples/MultipleButtons/MultipleButtons.ino

@@ -8,27 +8,36 @@
 #include <EasyButton.h>
 
 // Arduino pin where the buttons are connected to
-#define BUTTON_ONE_PIN 26
-#define BUTTON_TWO_PIN 27
+#define BUTTON_ONE_PIN 2
+#define BUTTON_TWO_PIN 4
+
+#define BAUDRATE 115200
 
 // Button1
 EasyButton button1(BUTTON_ONE_PIN);
 // Button2
 EasyButton button2(BUTTON_TWO_PIN);
 
 // Callback function to be called when button1 is pressed
-void onButton1Pressed() {
-  Serial.println("Button1 has been pressed!");
+void onButton1Pressed()
+{
+  Serial.println("Button1 pressed");
 }
 
 // Callback function to be called when button2 is pressed
-void onButton2Pressed() {
-  Serial.println("Button2 has been pressed!");
+void onButton2Pressed()
+{
+  Serial.println("Button2 pressed");
 }
 
-void setup() {
+void setup()
+{
   // Initialize Serial for debuging purposes
-  Serial.begin(115200);
+  Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton multiple buttons example <<<");
+
   // Initialize the button1
   button1.begin();
   // Initialize the button2
@@ -39,7 +48,8 @@ void setup() {
   button2.onPressed(onButton2Pressed);
 }
 
-void loop() {
+void loop()
+{
   // Continuously read the status of the buttons
   button1.read();
   button2.read();

examples/MultipleSequence/MultipleSequence.ino

@@ -8,8 +8,10 @@
 #include <Arduino.h>
 #include <EasyButton.h>
 
-#define BUTTON_PIN 16
-#define BAUDRATE 19200
+// Arduino pin where the button is connected to.
+#define BUTTON_PIN 2
+
+#define BAUDRATE 115200
 
 void sequenceEllapsed()
 {
@@ -21,18 +23,27 @@ void otherSequence()
   Serial.println("Other sequence");
 }
 
+// Instance of the button.
 EasyButton button(BUTTON_PIN);
 
-void setup() {
-  // put your setup code here, to run once:
+void setup()
+{
+  // Initialize Serial for debuging purposes.
   Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton multiple onSequence example <<<");
+
+  // Initialize the button.
   button.begin();
+
   button.onSequence(2, 1500, sequenceEllapsed);
+
   button.onSequence(3, 2500, otherSequence);
-  Serial.println("Multiple onSequence example");
 }
 
-void loop() {
-  // put your main code here, to run repeatedly:
+void loop()
+{
+  // Continuously read the status of the button.
   button.read();
 }

examples/Pressed/Pressed.ino

@@ -8,26 +8,35 @@
 #include <EasyButton.h>
 
 // Arduino pin where the button is connected to.
-#define BUTTON_PIN 26
+#define BUTTON_PIN 2
+
+#define BAUDRATE 115200
 
 // Instance of the button.
 EasyButton button(BUTTON_PIN);
 
 // Callback function to be called when the button is pressed.
-void onPressed() {
-  Serial.println("Button has been pressed!");
+void onPressed()
+{
+  Serial.println("Button pressed");
 }
 
-void setup() {
+void setup()
+{
   // Initialize Serial for debuging purposes.
-  Serial.begin(115200);
+  Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton pressed example <<<");
+
   // Initialize the button.
   button.begin();
   // Add the callback function to be called when the button is pressed.
   button.onPressed(onPressed);
 }
 
-void loop() {
-  // Continuously read the status of the button. 
+void loop()
+{
+  // Continuously read the status of the button.
   button.read();
 }

examples/PressedForDuration/PressedForDuration.ino

@@ -1,33 +1,42 @@
 /*
- Name:		PressedForDuration.ino
- Created:	9/5/2018 10:49:52 AM
- Author:	Evert Arias
- Description: Example to demostrate how to use the library to detect a pressed for a given duration on a button.
+  Name:		PressedForDuration.ino
+  Created:	9/5/2018 10:49:52 AM
+  Author:	Evert Arias
+  Description: Example to demostrate how to use the library to detect a pressed for a given duration on a button.
 */
 
 #include <EasyButton.h>
 
 // Arduino pin where the button is connected to.
-#define BUTTON_PIN 26
+#define BUTTON_PIN 2
+
+#define BAUDRATE 115200
 
 // Instance of the button.
 EasyButton button(BUTTON_PIN);
 
 // Callback function to be called when the button is pressed.
-void onPressedForDuration() {
-  Serial.println("Button has been pressed!");
+void onPressedForDuration()
+{
+  Serial.println("Button pressed");
 }
 
-void setup() {
+void setup()
+{
   // Initialize Serial for debuging purposes.
-  Serial.begin(115200);
+  Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton pressedFor example <<<");
+
   // Initialize the button.
   button.begin();
   // Add the callback function to be called when the button is pressed for at least the given time.
   button.onPressedFor(2000, onPressedForDuration);
 }
 
-void loop() {
-  // Continuously read the status of the button. 
+void loop()
+{
+  // Continuously read the status of the button.
   button.read();
 }

examples/Sequence/Sequence.ino

@@ -1,33 +1,42 @@
 /*
- Name:		Sequence.ino
- Created:	9/5/2018 10:49:52 AM
- Author:	Evert Arias
- Description: Example to demostrate how to use the library to detect a sequence of presses on a button.
+  Name:		Sequence.ino
+  Created:	9/5/2018 10:49:52 AM
+  Author:	Evert Arias
+  Description: Example to demostrate how to use the library to detect a sequence of presses on a button.
 */
 
 #include <EasyButton.h>
 
 // Arduino pin where the button is connected to.
-#define BUTTON_PIN 26
+#define BUTTON_PIN 2
+
+#define BAUDRATE 115200
 
 // Instance of the button.
 EasyButton button(BUTTON_PIN);
 
 // Callback function to be called when the button is pressed.
-void onSequenceMatched() {
-  Serial.println("Button has been pressed!");
+void onSequenceMatched()
+{
+  Serial.println("Button pressed");
 }
 
-void setup() {
+void setup()
+{
   // Initialize Serial for debuging purposes.
-  Serial.begin(115200);
+  Serial.begin(BAUDRATE);
+
+  Serial.println();
+  Serial.println(">>> EasyButton sequence example <<<");
+
   // Initialize the button.
   button.begin();
   // Add the callback function to be called when the given sequence of presses is matched.
   button.onSequence(5 /* number of presses */, 2000 /* timeout */, onSequenceMatched /* callback */);
 }
 
-void loop() {
-  // Continuously read the status of the button. 
+void loop()
+{
+  // Continuously read the status of the button.
   button.read();
 }