Updating/adding example sketches to demonstrate each Devlpr method.

Author: finnkuusisto

examples/flex_detection/flex_detection.ino

@@ -1,23 +1,21 @@
-#include "Devlpr.h"
+#include <libdevlpr.h>
 
-Devlpr devlpr;
-
-void printEMG(Devlpr *d) {
-    int result = d->windowPeakToPeakAmplitude();
-    Serial.print("0 1024 ");
-    Serial.println(result);
-}
+// create a DEVLPR object with the pin we have connected on the shield
+// can create multiple for different pins if stacking shields
+Devlpr devlpr(A0);
 
 void writeFlex(Devlpr *d) {
+    // since this function is called when a flex is detected, just print
     Serial.println("FLEX");
 }
 
 void setup() {
+    // prepare Serial for printing to the monitor
     Serial.begin(2000000);
-    // add our print function to our DEVLPR schedule
-    // try to run once every 1ms
-    devlpr.scheduleFunction(printEMG, 1);
-    //devlpr.setFlexCallback(writeFlex);
+    // set the callback for flex detection
+    // flex detection is based on a multiple of peak-to-peak amplitude
+    // here we set the mutliple to be 1.7x baseline and a cooldown of 300ms
+    devlpr.setFlexCallback(writeFlex, 1.7, 300);
 }
 
 void loop() {

examples/plot_avg_emg/plot_avg_emg.ino

@@ -0,0 +1,28 @@
+#include <libdevlpr.h>
+
+// create a DEVLPR object with the pin we have connected on the shield
+// can create multiple for different pins if stacking shields
+Devlpr devlpr(A0);
+
+void printAvg(Devlpr *d) {
+    // first grab the most recent window average of EMG values sampled
+    // this is effectively a low-pass filter
+    int result = d->windowAvg();
+    // we will print three values each time: 0, 1024, and the measurement
+    // the 0 and 1024 simply give us a top and bottom line in the plotter
+    Serial.print("0 1024 ");
+    Serial.println(result);
+}
+
+void setup() {
+    // prepare Serial for printing to the plotter
+    Serial.begin(2000000);
+    // add a printing function as a scheduled callback for our Devlpr
+    // here we set the function to be called every 1ms
+    devlpr.scheduleFunction(printAvg, 1);
+}
+
+void loop() {
+    // let the DEVLPR library do its job
+    devlpr.tick();
+}

examples/plot_centered_raw_emg/plot_centered_raw_emg.ino

@@ -0,0 +1,28 @@
+#include <libdevlpr.h>
+
+// create a DEVLPR object with the pin we have connected on the shield
+// can create multiple for different pins if stacking shields
+Devlpr devlpr(A0);
+
+void printEMG(Devlpr *d) {
+    // first grab the most recent raw EMG value sampled and then centered
+    // this method subtracts a window average to roughly center around 0
+    int result = d->lastValueCentered();
+    // we will print three values each time: -1024, 1024, and the measurement
+    // the -1024 and 1024 simply give us a top and bottom line in the plotter
+    Serial.print("-1024 1024 ");
+    Serial.println(result);
+}
+
+void setup() {
+    // prepare Serial for printing to the plotter
+    Serial.begin(2000000);
+    // add a printing function as a scheduled callback for our Devlpr
+    // here we set the function to be called every 1ms
+    devlpr.scheduleFunction(printEMG, 1);
+}
+
+void loop() {
+    // let the DEVLPR library do its job
+    devlpr.tick();
+}

examples/plot_peak/plot_peak.ino

@@ -0,0 +1,27 @@
+#include <libdevlpr.h>
+
+// create a DEVLPR object with the pin we have connected on the shield
+// can create multiple for different pins if stacking shields
+Devlpr devlpr(A0);
+
+void printPeak(Devlpr *d) {
+    // first grab the peak amplitude (max) as measured in the current window
+    int result = d->windowPeakAmplitude();
+    // we will print three values each time: 0, 1024, and the measurement
+    // the 0 and 1024 simply give us a top and bottom line in the plotter
+    Serial.print("0 1024 ");
+    Serial.println(result);
+}
+
+void setup() {
+    // prepare Serial for printing to the plotter
+    Serial.begin(2000000);
+    // add a printing function as a scheduled callback for our Devlpr
+    // here we set the function to be called every 1ms
+    devlpr.scheduleFunction(printPeak, 1);
+}
+
+void loop() {
+    // let the DEVLPR library do its job
+    devlpr.tick();
+}

examples/plot_peak_to_peak/plot_peak_to_peak.ino

@@ -1,23 +1,24 @@
-#include "Devlpr.h"
+#include <libdevlpr.h>
 
-Devlpr devlpr;
+// create a DEVLPR object with the pin we have connected on the shield
+// can create multiple for different pins if stacking shields
+Devlpr devlpr(A0);
 
-void printEMG(Devlpr *d) {
+void printP2P(Devlpr *d) {
+    // first grab the peak-to-peak amplitude (max-min) as measured in the current window
     int result = d->windowPeakToPeakAmplitude();
+    // we will print three values each time: 0, 1024, and the measurement
+    // the 0 and 1024 simply give us a top and bottom line in the plotter
     Serial.print("0 1024 ");
     Serial.println(result);
 }
 
-void writeFlex(Devlpr *d) {
-    Serial.println("FLEX");
-}
-
 void setup() {
+    // prepare Serial for printing to the plotter
     Serial.begin(2000000);
-    // add our print function to our DEVLPR schedule
-    // try to run once every 1ms
-    devlpr.scheduleFunction(printEMG, 1);
-    //devlpr.setFlexCallback(writeFlex);
+    // add a printing function as a scheduled callback for our Devlpr
+    // here we set the function to be called every 1ms
+    devlpr.scheduleFunction(printP2P, 1);
 }
 
 void loop() {

examples/plot_raw_emg/plot_raw_emg.ino

@@ -0,0 +1,27 @@
+#include <libdevlpr.h>
+
+// create a DEVLPR object with the pin we have connected on the shield
+// can create multiple for different pins if stacking shields
+Devlpr devlpr(A0);
+
+void printEMG(Devlpr *d) {
+    // first grab the most recent raw EMG value sampled
+    int result = d->lastValue();
+    // we will print three values each time: 0, 1024, and the measurement
+    // the 0 and 1024 simply give us a top and bottom line in the plotter
+    Serial.print("0 1024 ");
+    Serial.println(result);
+}
+
+void setup() {
+    // prepare Serial for printing to the plotter
+    Serial.begin(2000000);
+    // add a printing function as a scheduled callback for our Devlpr
+    // here we set the function to be called every 1ms
+    devlpr.scheduleFunction(printEMG, 1);
+}
+
+void loop() {
+    // let the DEVLPR library do its job
+    devlpr.tick();
+}

library.properties

@@ -1,5 +1,5 @@
 name=Libdevlpr
-version=0.1.2
+version=0.1.3
 author=Finn Kuusisto <finn@getfantm.com>, Ezra Boley <ezra@getfantm.com>
 maintainer=Finn Kuusisto <finn@getfantm.com>
 sentence=A library that makes using the FANTM DEVLPR shield easier.

src/libdevlpr.h

@@ -1,7 +1,7 @@
 #ifndef libdevlpr_h
 #define libdevlpr_h
 
-#define LIBDEVLPR_VERSION "0.1.2"
+#define LIBDEVLPR_VERSION "0.1.3"
 
 #include "Devlpr.h"