Moving to Library Standards

Moving out the pinMode and Debounce into a library. Should probably make it a true object and wrap up all of the debounce and global varaibles there. But/and this works for now and should fullfill the library requirements.

Author: plancherb1

LICENSE.txt

@@ -0,0 +1,9 @@
+# Released under MIT License
+
+Copyright (c) 2021 TinyMLx.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

examples/test_microphone/test_microphone.ino

@@ -5,28 +5,20 @@
 */
 
 #include <PDM.h>
-
-#define BUTTON_PIN 13
+#include <TinyMLShield.h>
 
 // PDM buffer
 short sampleBuffer[256];
 volatile int samplesRead;
 
-// Variables for button debouncing
-unsigned long lastDebounceTime = 0;
-unsigned long debounceDelay = 50;
-bool lastButtonState = HIGH;
-bool buttonState;
-
 bool record = false;
 
 void setup() {
   Serial.begin(9600);
   while (!Serial);  
 
-  pinMode(BUTTON_PIN, OUTPUT);
-  digitalWrite(BUTTON_PIN, HIGH);
-  nrf_gpio_cfg_out_with_input(digitalPinToPinName(BUTTON_PIN));
+  // Initialize the TinyML Shield
+  initializeShield();
 
   PDM.onReceive(onPDMdata);
   // Initialize PDM microphone in mono mode with 16 kHz sample rate
@@ -41,23 +33,11 @@ void setup() {
 }
 
 void loop() {
-  bool buttonRead = nrf_gpio_pin_read(digitalPinToPinName(BUTTON_PIN));
-
-  if (buttonRead != lastButtonState) {
-    lastDebounceTime = millis();
+  // see if the button is pressed and turn off or on recording accordingly
+  bool clicked = readShieldButton();
+  if (clicked){
+    record = !record;
   }
-
-  if (millis() - lastDebounceTime >= debounceDelay) {
-    if (buttonRead != buttonState) {
-      buttonState = buttonRead;
-
-      if (!buttonState) {
-        record = !record;
-      }
-    }
-  }
-
-  lastButtonState = buttonRead;
 
   if (samplesRead) {
 
@@ -82,13 +62,3 @@ void onPDMdata() {
 
   samplesRead = bytesAvailable / 2;
 }
-
-void nrf_gpio_cfg_out_with_input(uint32_t pin_number) {
-  nrf_gpio_cfg(
-    pin_number,
-    NRF_GPIO_PIN_DIR_OUTPUT,
-    NRF_GPIO_PIN_INPUT_CONNECT,
-    NRF_GPIO_PIN_PULLUP,
-    NRF_GPIO_PIN_S0S1,
-    NRF_GPIO_PIN_NOSENSE);
-}

library.properties

@@ -0,0 +1,10 @@
+name=Harvard_TinyMLx
+version=0.0.1-Alpha
+author=TinyMLx Authors
+maintainer=Brian Plancher <brian.plancher@gmail.com>
+sentence=Supports the TinyML edX Course and TinyML Shield.
+paragraph=This library supports the TinyML Shield and provides examples that suppor the TinyML edX course. The examples work best with the Arduino Nano 33 BLE Sense board and the Tiny Machine Learning Kit from Arduino.
+category=Sensors
+url=http://www.tinymlx.org
+includes=TinyMLShield.h
+ldflags=-lm

src/TinyMLShield.h

@@ -0,0 +1,48 @@
+#define BUTTON_PIN 13
+
+// Custom shield button pin setting
+void nrf_gpio_cfg_out_with_input(uint32_t pin_number) {
+  nrf_gpio_cfg(
+    pin_number,
+    NRF_GPIO_PIN_DIR_OUTPUT,
+    NRF_GPIO_PIN_INPUT_CONNECT,
+    NRF_GPIO_PIN_PULLUP,
+    NRF_GPIO_PIN_S0S1,
+    NRF_GPIO_PIN_NOSENSE);
+}
+
+// Variables for button debouncing
+unsigned long lastDebounceTime = 0;
+unsigned long debounceDelay = 50;
+bool lastButtonState = HIGH;
+bool buttonState;
+
+// set the pin modes for the button
+void initializeShield(){
+  pinMode(BUTTON_PIN, OUTPUT);
+  digitalWrite(BUTTON_PIN, HIGH);
+  nrf_gpio_cfg_out_with_input(digitalPinToPinName(BUTTON_PIN));
+}
+
+// debounce the button and return true on new click
+bool readShieldButton(){
+  bool buttonRead = nrf_gpio_pin_read(digitalPinToPinName(BUTTON_PIN));
+  
+  if (buttonRead != lastButtonState) {
+    lastDebounceTime = millis();
+  }
+
+  if (millis() - lastDebounceTime >= debounceDelay) {
+    if (buttonRead != buttonState) {
+      buttonState = buttonRead;
+
+      if (!buttonState) {
+        lastButtonState = buttonRead;
+        return true;
+      }
+    }
+  }
+
+  lastButtonState = buttonRead;
+  return false;
+}