Ray memory (#84)

* remove note-c before re-add

* Squashed 'src/note-c/' content from commit 4487b27

git-subtree-dir: src/note-c
git-subtree-split: 4487b2723f2bb4f72ebe83bab76fafc2f6e63546

* feat: v1.3.14

Author: zfields

examples/Example0_LibrarylessCommunication/Example0_LibrarylessCommunication.ino

@@ -14,14 +14,14 @@
 // would use Serial2.
 //
 // Note that both of these definitions are optional; just prefix either line with // to remove it.
-//  Remove serialNotecard if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
+//  Remove txRxPinsSerial if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
 
 #if defined(ARDUINO_ARCH_AVR) && not defined(HAVE_HWSERIAL1)
-#define serialNotecard Serial
+#define txRxPinsSerial Serial
 #elif defined(ARDUINO_ARCH_STM32) && not defined(HAVE_HWSERIAL1)
-#define serialNotecard Serial
+#define txRxPinsSerial Serial
 #else
-#define serialNotecard Serial1
+#define txRxPinsSerial Serial1
 #endif
 
 #ifdef ARDUINO_NRF52840_FEATHER
@@ -44,21 +44,21 @@ void setup()
     // Initialize the serial port being used by the Notecard, and send a newline to clear out any data
     // that the Arduino software may have pending so that we always start sending commands "cleanly".
     // We use the speed of 9600 because the Notecard's RX/TX pins are always configured for that speed.
-    serialNotecard.begin(9600);
-    serialNotecard.println("\n");
+    txRxPinsSerial.begin(9600);
+    txRxPinsSerial.println("\n");
 
     // This command (required) causes the data to be delivered to the Project on notehub.io that has claimed
     // this Product ID.  (see above)
-    serialNotecard.println("{\"req\":\"service.set\",\"product\":\"" myProductID "\"}");
+    txRxPinsSerial.println("{\"req\":\"service.set\",\"product\":\"" myProductID "\"}");
 
     // This command determines how often the Notecard connects to the service.  If "continuous" the Notecard
     // immediately establishes a session with the service at notehub.io, and keeps it active continuously.
     // Because of the power requirements of a continuous connection, a battery powered device would instead
     // only sample its sensors occasionally, and would only upload to the service on a periodic basis.
 #if myLiveDemo
-    serialNotecard.println("{\"req\":\"service.set\",\"mode\":\"continuous\"}");
+    txRxPinsSerial.println("{\"req\":\"service.set\",\"mode\":\"continuous\"}");
 #else
-    serialNotecard.println("{\"req\":\"service.set\",\"mode\":\"periodic\",\"outbound\":60}");
+    txRxPinsSerial.println("{\"req\":\"service.set\",\"mode\":\"periodic\",\"outbound\":60}");
 #endif
 
 }
@@ -97,7 +97,7 @@ void loop()
              (int)temperature, abs(((int)(temperature*100.0)%100)),
              (int)voltage, (int)(voltage*100.0)%100,
              eventCounter);
-    serialNotecard.println(message);
+    txRxPinsSerial.println(message);
 
     // Delay between simulated measurements
 #if myLiveDemo

examples/Example1_NotecardBasics/Example1_NotecardBasics.ino

@@ -30,11 +30,11 @@
 // can use any available port.
 //
 // Note that both of these definitions are optional; just prefix either line with // to remove it.
-//  Remove serialNotecard if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
-//  Remove serialDebug if you don't want the Notecard library to output debug information
+//  Remove txRxPinsSerial if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
+//  Remove usbSerial if you don't want the Notecard library to output debug information
 
-//#define serialNotecard Serial1
-#define serialDebugOut Serial
+//#define txRxPinsSerial Serial1
+#define usbSerial Serial
 
 // This is the unique Product Identifier for your device.  This Product ID tells the Notecard what
 // type of device has embedded the Notecard, and by extension which vendor or customer is in charge
@@ -57,15 +57,15 @@ void setup()
     // Note that the initial 2.5s delay is required by some Arduino cards before debug
     // UART output can be successfully displayed in the Arduino IDE, including the
     // Adafruit Feather nRF52840 Express.
-#ifdef serialDebugOut
+#ifdef usbSerial
     delay(2500);
-    serialDebugOut.begin(115200);
-    notecard.setDebugOutputStream(serialDebugOut);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 #endif
 
     // Initialize the physical I/O channel to the Notecard
-#ifdef serialNotecard
-    notecard.begin(serialNotecard, 9600);
+#ifdef txRxPinsSerial
+    notecard.begin(txRxPinsSerial, 9600);
 #else
     Wire.begin();
 

examples/Example2_PeriodicCommunications/Example2_PeriodicCommunications.ino

@@ -50,10 +50,10 @@
 #include <Wire.h>
 
 // Note that both of these definitions are optional; just prefix either line with // to remove it.
-//  Remove serialNotecard if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
-//  Remove serialDebug if you don't want the Notecard library to output debug information
-// #define serialNotecard Serial1
-#define serialDebugOut Serial
+//  Remove txRxPinsSerial if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
+//  Remove usbSerial if you don't want the Notecard library to output debug information
+// #define txRxPinsSerial Serial1
+#define usbSerial Serial
 
 // This is the unique Product Identifier for your device.
 #define myProductID "com.your-company.your-name:your_project"
@@ -76,15 +76,15 @@ void setup()
     // During development, set up for debug output from the Notecard.  Note that the initial delay is
     // required by some Arduino cards before debug UART output can be successfully displayed in the
     // Arduino IDE, including the Adafruit Feather nRF52840 Express.
-#ifdef serialDebugOut
+#ifdef usbSerial
     delay(2500);
-    serialDebugOut.begin(115200);
-    notecard.setDebugOutputStream(serialDebugOut);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 #endif
 
     // Initialize the physical I/O channel to the Notecard
-#ifdef serialNotecard
-    notecard.begin(serialNotecard, 9600);
+#ifdef txRxPinsSerial
+    notecard.begin(txRxPinsSerial, 9600);
 #else
     Wire.begin();
 

examples/Example3_InboundPolling/Example3_InboundPolling.ino

@@ -27,10 +27,10 @@
 #define INBOUND_QUEUE_COMMAND_FIELD "my-request-type"
 
 // Note that both of these definitions are optional; just prefix either line with // to remove it.
-//  Remove serialNotecard if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
-//  Remove serialDebug if you don't want the Notecard library to output debug information
-// #define serialNotecard Serial1
-#define serialDebugOut Serial
+//  Remove txRxPinsSerial if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
+//  Remove usbSerial if you don't want the Notecard library to output debug information
+// #define txRxPinsSerial Serial1
+#define usbSerial Serial
 
 // This is the unique Product Identifier for your device.
 #define myProductID "com.your-company.your-name:your_project"
@@ -42,15 +42,15 @@ void setup()
 {
 
     // Set up for debug output.
-#ifdef serialDebugOut
+#ifdef usbSerial
     delay(2500);
-    serialDebugOut.begin(115200);
-    notecard.setDebugOutputStream(serialDebugOut);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 #endif
 
     // Initialize the physical I/O channel to the Notecard
-#ifdef serialNotecard
-    notecard.begin(serialNotecard, 9600);
+#ifdef txRxPinsSerial
+    notecard.begin(txRxPinsSerial, 9600);
 #else
     Wire.begin();
 

examples/Example4_InboundInterrupts/Example4_InboundInterrupts.ino

@@ -32,10 +32,10 @@
 #define INBOUND_QUEUE_COMMAND_FIELD "my-request-type"
 
 // Note that both of these definitions are optional; just prefix either line with // to remove it.
-//  Remove serialNotecard if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
-//  Remove serialDebug if you don't want the Notecard library to output debug information
-// #define serialNotecard Serial1
-#define serialDebugOut Serial
+//  Remove txRxPinsSerial if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
+//  Remove usbSerial if you don't want the Notecard library to output debug information
+// #define txRxPinsSerial Serial1
+#define usbSerial Serial
 
 // This is the unique Product Identifier for your device.
 #define myProductID "com.your-company.your-name:your_project"
@@ -54,15 +54,15 @@ void setup()
 {
 
     // Set up for debug output.
-#ifdef serialDebugOut
+#ifdef usbSerial
     delay(2500);
-    serialDebugOut.begin(115200);
-    notecard.setDebugOutputStream(serialDebugOut);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 #endif
 
     // Initialize the physical I/O channel to the Notecard
-#ifdef serialNotecard
-    notecard.begin(serialNotecard, 9600);
+#ifdef txRxPinsSerial
+    notecard.begin(txRxPinsSerial, 9600);
 #else
     Wire.begin();
     notecard.begin();

examples/Example5_UsingTemplates/Example5_UsingTemplates.ino

@@ -31,10 +31,10 @@
 #include <stdlib.h>
 
 // Note that both of these definitions are optional; just prefix either line with // to remove it.
-//  Remove serialNotecard if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
-//  Remove serialDebug if you don't want the Notecard library to output debug information
-// #define serialNotecard Serial1
-#define serialDebugOut Serial
+//  Remove txRxPinsSerial if you wired your Notecard using I2C SDA/SCL pins instead of serial RX/TX
+//  Remove usbSerial if you don't want the Notecard library to output debug information
+// #define txRxPinsSerial Serial1
+#define usbSerial Serial
 
 // This is the unique Product Identifier for your device.  This Product ID tells the Notecard what
 // type of device has embedded the Notecard, and by extension which vendor or customer is in charge
@@ -55,15 +55,15 @@ void setup()
 {
 
     // Set up for debug output.
-#ifdef serialDebugOut
+#ifdef usbSerial
     delay(2500);
-    serialDebugOut.begin(115200);
-    notecard.setDebugOutputStream(serialDebugOut);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 #endif
 
     // Initialize the physical I/O channel to the Notecard
-#ifdef serialNotecard
-    notecard.begin(serialNotecard, 9600);
+#ifdef txRxPinsSerial
+    notecard.begin(txRxPinsSerial, 9600);
 #else
     Wire.begin();
 

examples/Example6_SensorTutorial/Example6_SensorTutorial.ino

@@ -17,24 +17,24 @@
 
 Adafruit_BME680 bmeSensor;
 
-//#define serialNotecard Serial1
-#define serialDebug Serial
+//#define txRxPinsSerial Serial1
+#define usbSerial Serial
 
 #define productUID "com.your-company.your-name:your_project"
 Notecard notecard;
 
 // One-time Arduino initialization
 void setup()
 {
-#ifdef serialDebug
+#ifdef usbSerial
     delay(2500);
-    serialDebug.begin(115200);
-    notecard.setDebugOutputStream(serialDebug);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 #endif
 
     // Initialize the physical I/O channel to the Notecard
-#ifdef serialNotecard
-    notecard.begin(serialNotecard, 9600);
+#ifdef txRxPinsSerial
+    notecard.begin(txRxPinsSerial, 9600);
 #else
     Wire.begin();
 
@@ -47,9 +47,9 @@ void setup()
     notecard.sendRequest(req);
 
     if (!bmeSensor.begin()) {
-        serialDebug.println("Could not find a valid BME680 sensor...");
+        usbSerial.println("Could not find a valid BME680 sensor...");
     } else {
-        serialDebug.println("BME680 Connected...");
+        usbSerial.println("BME680 Connected...");
     }
 
     bmeSensor.setTemperatureOversampling(BME680_OS_8X);
@@ -59,18 +59,18 @@ void setup()
 void loop()
 {
     if (! bmeSensor.performReading()) {
-        serialDebug.println("Failed to obtain a reading...");
+        usbSerial.println("Failed to obtain a reading...");
         delay(15000);
         return;
     }
 
-    serialDebug.print("Temperature = ");
-    serialDebug.print(bmeSensor.temperature);
-    serialDebug.println(" *C");
+    usbSerial.print("Temperature = ");
+    usbSerial.print(bmeSensor.temperature);
+    usbSerial.println(" *C");
 
-    serialDebug.print("Humidity = ");
-    serialDebug.print(bmeSensor.humidity);
-    serialDebug.println(" %");
+    usbSerial.print("Humidity = ");
+    usbSerial.print(bmeSensor.humidity);
+    usbSerial.println(" %");
 
     J *req = notecard.newRequest("note.add");
     if (req != NULL) {

examples/Example7_PowerControl/Example7_PowerControl.ino

@@ -19,7 +19,7 @@
 #define	hostSleepSeconds		60
 
 // Arduino serial debug monitor port definitions
-#define serialDebug Serial
+#define usbSerial Serial
 
 // Notecard I2C port definitions
 Notecard notecard;
@@ -49,8 +49,8 @@ void setup()
 	// Arduino IDE requires a delay to move the serial port over
 	// from programming the MCU to the debug monitor.
     delay(2500);
-    serialDebug.begin(115200);
-    notecard.setDebugOutputStream(serialDebug);
+    usbSerial.begin(115200);
+    notecard.setDebugOutputStream(usbSerial);
 
     // Initialize the physical I2C I/O channel to the Notecard
     Wire.begin();

keywords.txt

@@ -8,8 +8,9 @@ FUNCTIONS
 ==================================
 begin	KEYWORD2
 setDebugOutputStream	KEYWORD2
-newCommand	KEYWORD2
+clearDebugOutputStream	KEYWORD2
 newRequest	KEYWORD2
+newCommand	KEYWORD2
 sendRequest	KEYWORD2
 requestAndResponse	KEYWORD2
 deleteResponse	KEYWORD2

library.properties

@@ -1,5 +1,5 @@
 name=Blues Wireless Notecard
-version=1.3.13
+version=1.3.14
 author=Blues Wireless
 maintainer=Blues Wireless <[email protected]>
 sentence=An easy to use Notecard Library for Arduino.