chore: silence UART on begin (#141)

* chore: Remove chatter from `begin` method (serial)
* chore: remove old tests
* updated 'src/note-c/'
    * git-subtree-dir: src/note-c
    * git-subtree-split: 022e83c8e54d72edf01502dc9b7bcd3be1d0d9c5

Author: zfields

src/Notecard.cpp

@@ -44,15 +44,6 @@
 
 #include "NoteTime.h"
 
-// AUX serial throttling is based on the Arduino define `SERIAL_RX_BUFFER_SIZE`.
-// Unfortunately, some platforms do NOT specify the define. In this case, 64
-// bytes is selected as the default value, because it is a common buffer size
-// across several platforms.
-#ifndef SERIAL_RX_BUFFER_SIZE
-#define SERIAL_RX_BUFFER_SIZE 64
-#pragma message "\n\x1B[0;33mSERIAL_RX_BUFFER_SIZE has not been specified for this platform!\n\nThe value is used to set the default Notecard AUX Serial write speeds.\nA value (" NOTE_C_STRINGIZE(SERIAL_RX_BUFFER_SIZE) ") has been specified on your behalf. Use the 'card.aux.serial'\nrequest to tailor the AUX Serial speed to your board and/or application.\nhttps://dev.blues.io/api-reference/notecard-api/card-requests/#card-aux-serial\x1B[0;0m"
-#endif
-
 /***************************************************************************
  SINGLETON ABSTRACTION (REQUIRED BY NOTE-C)
  ***************************************************************************/
@@ -254,15 +245,6 @@ void Notecard::begin(NoteSerial * noteSerial_)
     if (noteSerial) {
         NoteSetFnSerial(noteSerialReset, noteSerialTransmit,
                         noteSerialAvailable, noteSerialReceive);
-
-        // Set the default debug serial throttling
-        J *req = NoteNewRequest("card.aux.serial");
-        if (req != NULL)
-        {
-            JAddIntToObject(req, "max", SERIAL_RX_BUFFER_SIZE - 1);
-            JAddIntToObject(req, "ms", 1);
-            NoteRequestWithRetry(req, 15);
-        }
     } else {
         NoteSetFnSerial(nullptr, nullptr, nullptr, nullptr);
     }

src/note-c/.gitignore

@@ -10,4 +10,6 @@ __pycache__/
 settings.json
 
 # Development Artifacts
+CMakeFiles/
+CMakeCache.txt
 cppcheck_output.txt

src/note-c/Dockerfile

@@ -80,6 +80,31 @@ NOTE_C_STATIC int _yToDays(int year);
 
 static const char NOTE_C_BINARY_EOP = '\n';
 
+//**************************************************************************/
+/*!
+  @brief  Configure the flow control for the auxiliary serial port.
+  @param   bufSize The size of the receive buffer.
+  @param   delayMs The time to wait between reads.
+
+  @returns `true` on success, `false` on failure.
+*/
+/**************************************************************************/
+bool NoteAuxSerialFlowControl(int bufSize, int delayMs)
+{
+    bool result = false;
+
+    J *req = NoteNewRequest("card.aux.serial");
+    if (req != NULL) {
+        JAddIntToObject(req, "max", bufSize - 1);
+        JAddIntToObject(req, "ms", delayMs);
+        result = NoteRequest(req);
+    } else {
+        NOTE_C_LOG_ERROR(ERRSTR("Failed to configure AUX serial flow control", c_mem));
+    }
+
+    return result;
+}
+
 //**************************************************************************/
 /*!
   @brief  Decode binary data received from the Notecard.

src/note-c/n_helpers.c

@@ -207,25 +207,25 @@ NOTE_C_STATIC void _noteSetActiveInterface(int interface)
     hookActiveInterface = interface;
 
     switch (interface) {
-        case NOTE_C_INTERFACE_SERIAL:
-            notecardReset = _serialNoteReset;
-            notecardTransaction = _serialNoteTransaction;
-            notecardChunkedReceive = _serialChunkedReceive;
-            notecardChunkedTransmit = _serialChunkedTransmit;
-            break;
-        case NOTE_C_INTERFACE_I2C:
-            notecardReset = _i2cNoteReset;
-            notecardTransaction = _i2cNoteTransaction;
-            notecardChunkedReceive = _i2cNoteChunkedReceive;
-            notecardChunkedTransmit = _i2cNoteChunkedTransmit;
-            break;
-        default:
-            hookActiveInterface = NOTE_C_INTERFACE_NONE; // unrecognized interfaces are disabled
-            notecardReset = NULL;
-            notecardTransaction = NULL;
-            notecardChunkedReceive = NULL;
-            notecardChunkedTransmit = NULL;
-            break;
+    case NOTE_C_INTERFACE_SERIAL:
+        notecardReset = _serialNoteReset;
+        notecardTransaction = _serialNoteTransaction;
+        notecardChunkedReceive = _serialChunkedReceive;
+        notecardChunkedTransmit = _serialChunkedTransmit;
+        break;
+    case NOTE_C_INTERFACE_I2C:
+        notecardReset = _i2cNoteReset;
+        notecardTransaction = _i2cNoteTransaction;
+        notecardChunkedReceive = _i2cNoteChunkedReceive;
+        notecardChunkedTransmit = _i2cNoteChunkedTransmit;
+        break;
+    default:
+        hookActiveInterface = NOTE_C_INTERFACE_NONE; // unrecognized interfaces are disabled
+        notecardReset = NULL;
+        notecardTransaction = NULL;
+        notecardChunkedReceive = NULL;
+        notecardChunkedTransmit = NULL;
+        break;
     }
 }
 
@@ -404,6 +404,38 @@ void NoteSetFnSerial(serialResetFn resetFn, serialTransmitFn transmitFn,
     _UnlockNote();
 }
 
+/*!
+ * @brief Set the default Serial hooks if they aren't already set
+ * @param   resetFn The platform-specific serial reset function.
+ * @param   transmitFn The platform-specific serial transmit function.
+ * @param   availFn The platform-specific serial available function.
+ * @param   receiveFn The platform-specific serial receive function.
+ */
+void NoteSetFnSerialDefault(serialResetFn resetFn, serialTransmitFn transmitFn,
+                            serialAvailableFn availFn, serialReceiveFn receiveFn)
+{
+    _LockNote();
+
+    if (hookSerialReset == NULL) {
+        hookSerialReset = resetFn;
+    }
+    if (hookSerialTransmit == NULL) {
+        hookSerialTransmit = transmitFn;
+    }
+    if (hookSerialAvailable == NULL) {
+        hookSerialAvailable = availFn;
+    }
+    if (hookSerialReceive == NULL) {
+        hookSerialReceive = receiveFn;
+    }
+
+    if (hookActiveInterface == NOTE_C_INTERFACE_NONE) {
+        _noteSetActiveInterface(NOTE_C_INTERFACE_SERIAL);
+    }
+
+    _UnlockNote();
+}
+
 /*!
  @brief Set the platform-specific hooks for communicating with the Notecard over
         I2C, as well as the I2C address of the Notecard and maximum transmission
@@ -436,6 +468,46 @@ void NoteSetFnI2C(uint32_t notecardAddr, uint32_t maxTransmitSize,
     _UnlockNote();
 }
 
+/*!
+ * @brief Set the default I2C hooks if they aren't already set
+ * @param   notecardAddr The I2C address of the Notecard. Pass 0 to use the default
+ *         address.
+ * @param   maxTransmitSize The max number of bytes to send to the Notecard in a
+ *         single I2C segment. Pass 0 to use the default maximum transmission
+ *         size.
+ * @param   resetFn The platform-specific I2C reset function.
+ * @param   transmitFn The platform-specific I2C transmit function.
+ * @param   receiveFn The platform-specific I2C receive function.
+ */
+void NoteSetFnI2cDefault(uint32_t notecardAddr, uint32_t maxTransmitSize,
+                         i2cResetFn resetFn, i2cTransmitFn transmitFn,
+                         i2cReceiveFn receiveFn)
+{
+    _LockNote();
+
+    if (i2cAddress == 0) {
+        i2cAddress = notecardAddr;
+    }
+    if (i2cMax == 0) {
+        i2cMax = maxTransmitSize;
+    }
+    if (hookI2CReset == NULL) {
+        hookI2CReset = resetFn;
+    }
+    if (hookI2CTransmit == NULL) {
+        hookI2CTransmit = transmitFn;
+    }
+    if (hookI2CReceive == NULL) {
+        hookI2CReceive = receiveFn;
+    }
+
+    if (hookActiveInterface == NOTE_C_INTERFACE_NONE) {
+        _noteSetActiveInterface(NOTE_C_INTERFACE_I2C);
+    }
+
+    _UnlockNote();
+}
+
 //**************************************************************************/
 /*!
   @brief  Set the platform-specific communications method to be disabled

src/note-c/n_hooks.c

@@ -301,7 +301,7 @@ bool _i2cNoteReset(void)
             break;
         }
 
-        NOTE_C_LOG_DEBUG("retrying I2C interface reset...")
+        NOTE_C_LOG_DEBUG("retrying I2C interface reset...");
     }
 
     // Done with the I2C bus