ver: Roll version to v1.3.4 (#46)

* remove note-c before re-add

* Squashed 'src/note-c/' content from commit ceceeb2
git-subtree-dir: src/note-c
git-subtree-split: ceceeb2c9a34540c5c3905c548378f00f6c58428

* Support `Notecard::newCommand` API

Added tests and syntax highlighting for `Notecard::newCommand` API

Author: zfields

keywords.txt

@@ -9,6 +9,7 @@ FUNCTIONS
 begin	KEYWORD2
 setDebugOutputStream	KEYWORD2
 i2cTest	KEYWORD2
+newCommand	KEYWORD2
 newRequest	KEYWORD2
 sendRequest	KEYWORD2
 requestAndResponse	KEYWORD2

library.properties

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

src/note-c/n_i2c.c

@@ -18,10 +18,10 @@ static void _DelayIO(void);
 
 /**************************************************************************/
 /*!
-    @brief  We've noticed that there's an instability in some cards'
-            implementations of I2C, and as a result we introduce an intentional
-            delay before each and every I2C I/O.The timing was computed
-            empirically based on a number of commercial devices.
+  @brief  We've noticed that there's an instability in some cards'
+  implementations of I2C, and as a result we introduce an intentional
+  delay before each and every I2C I/O.The timing was computed
+  empirically based on a number of commercial devices.
 */
 /**************************************************************************/
 static void _DelayIO()
@@ -31,12 +31,12 @@ static void _DelayIO()
 
 /**************************************************************************/
 /*!
-    @brief  Given a JSON string, perform an I2C transaction with the Notecard.
-    @param   json
-               A c-string containing the JSON request object.
-    @param   jsonResponse
-               An out parameter c-string buffer that will contain the JSON
-               response from the Notercard.
+  @brief  Given a JSON string, perform an I2C transaction with the Notecard.
+  @param   json
+  A c-string containing the JSON request object.
+  @param   jsonResponse
+  An out parameter c-string buffer that will contain the JSON
+  response from the Notercard.
   @returns a c-string with an error, or `NULL` if no error ocurred.
 */
 /**************************************************************************/
@@ -193,9 +193,9 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
 
 //**************************************************************************/
 /*!
-    @brief  Initialize or re-initialize the I2C subsystem, returning false if
-            anything fails.
-    @returns a boolean. `true` if the reset was successful, `false`, if not.
+  @brief  Initialize or re-initialize the I2C subsystem, returning false if
+  anything fails.
+  @returns a boolean. `true` if the reset was successful, `false`, if not.
 */
 /**************************************************************************/
 bool i2cNoteReset()
@@ -209,11 +209,16 @@ bool i2cNoteReset()
         return false;
     }
 
-    // Synchronize by guaranteeing not only that I2C works, but that we drain the remainder of any
-    // pending partial reply from a previously-aborted session.  This outer loop does retries on
-    // I2C error, and is simply here for robustness.
+    // Synchronize by guaranteeing not only that I2C works, but that after we send \n that we drain
+    // the remainder of any pending partial reply from a previously-aborted session.  This outer loop
+    // does retries on I2C error, and is simply here for robustness.
     bool notecardReady = false;
     int retries;
+    _LockI2C();
+    _DelayIO();
+    _I2CTransmit(_I2CAddress(), (uint8_t *)"\n", 1);
+    _DelayMs(CARD_REQUEST_I2C_SEGMENT_DELAY_MS);
+    _UnlockI2C();
     for (retries=0; !notecardReady && retries<3; retries++) {
 
         // Loop to drain all chunks of data that may be ready to transmit to us

test/Notecard.test.cpp

@@ -1017,6 +1017,67 @@ int test_notecard_begin_serial_default_parameter_for_baud_rate_is_passed_to_note
   return result;
 }
 
+int test_notecard_newCommand_does_not_modify_string_parameter_value_before_passing_to_note_c()
+{
+  int result;
+  Notecard notecard;
+  const char *str = "Hello, Test 23!";
+  char str_copy[32];
+
+  // Setup
+  strcpy(str_copy, str);
+  noteNewCommand_Parameters.request = nullptr;
+  noteNewCommand_Parameters.result = nullptr;
+
+  // Action
+  notecard.newCommand(str_copy);
+
+  // Evaluate Result
+  if (0 == strcmp(str, noteNewCommand_Parameters.request))
+  {
+    result = 0;
+  }
+  else
+  {
+    result = 40;
+  }
+
+  return result;
+}
+
+int test_notecard_newCommand_does_not_modify_note_c_result_value_before_returning_to_caller()
+{
+  int result;
+  Notecard notecard;
+  J *json_obj = reinterpret_cast<J *>(malloc(sizeof(J))); // JCreateObject();
+  assert(nullptr != json_obj);
+
+  // Setup
+  memset(json_obj, 0x55, sizeof(J)); //assert(nullptr != JAddStringToObject(json_obj,"key1", "value1"));
+  {
+    noteNewCommand_Parameters.result = reinterpret_cast<J *>(malloc(sizeof(J)));
+    assert(nullptr != noteNewCommand_Parameters.result);
+    memcpy(noteNewCommand_Parameters.result, json_obj, sizeof(J));
+  } //assert(nullptr != (noteNewCommand_Parameters.result = JDuplicate(json_obj,true)));
+
+  // Action
+  J *json_result = notecard.newCommand(nullptr);
+
+  // Evaluate Result
+  if (0 == memcmp(json_obj, json_result, sizeof(J)) /*JCompare(json_obj, json_result, false)*/)
+  {
+    result = 0;
+  }
+  else
+  {
+    result = 41;
+  }
+
+  free(noteNewCommand_Parameters.result);
+  free(json_obj);
+  return result;
+}
+
 int main(void)
 {
   TestFunction tests[] = {
@@ -1058,7 +1119,9 @@ int main(void)
       {test_notecard_responseError_does_not_modify_note_c_result_value_before_returning_to_caller, "test_notecard_responseError_does_not_modify_note_c_result_value_before_returning_to_caller"},
       {test_notecard_begin_i2c_default_parameter_for_wirePort_has_begin_method_called, "test_notecard_begin_i2c_default_parameter_for_wirePort_has_begin_method_called"},
       {test_notecard_begin_i2c_parameter_for_wirePort_has_begin_method_called, "test_notecard_begin_i2c_parameter_for_wirePort_has_begin_method_called"},
-      {test_notecard_begin_serial_default_parameter_for_baud_rate_is_passed_to_note_c, "test_notecard_begin_serial_default_parameter_for_baud_rate_is_passed_to_note_c"}
+      {test_notecard_begin_serial_default_parameter_for_baud_rate_is_passed_to_note_c, "test_notecard_begin_serial_default_parameter_for_baud_rate_is_passed_to_note_c"},
+      {test_notecard_newCommand_does_not_modify_string_parameter_value_before_passing_to_note_c, "test_notecard_newRequest_does_not_modify_string_parameter_value_before_passing_to_note_c"},
+      {test_notecard_newCommand_does_not_modify_note_c_result_value_before_returning_to_caller, "test_notecard_newRequest_does_not_modify_note_c_result_value_before_returning_to_caller"},
   };
 
   return TestFunction::runTests(tests, (sizeof(tests) / sizeof(TestFunction)));

test/mock/mock-note.c

@@ -3,6 +3,7 @@
 NoteDebug_Parameters noteDebug_Parameters;
 NoteDebugSyncStatus_Parameters noteDebugSyncStatus_Parameters;
 NoteDeleteResponse_Parameters noteDeleteResponse_Parameters;
+NoteNewCommand_Parameters noteNewCommand_Parameters;
 NoteNewRequest_Parameters noteNewRequest_Parameters;
 NoteRequest_Parameters noteRequest_Parameters;
 NoteRequestResponse_Parameters noteRequestResponse_Parameters;
@@ -59,6 +60,16 @@ NoteDebugSyncStatus(
     return noteDebugSyncStatus_Parameters.result;
 }
 
+J *
+NoteNewCommand(
+    const char *request
+) {
+    // Stash parameter(s)
+    noteNewCommand_Parameters.request = request;
+
+    return noteNewCommand_Parameters.result;
+}
+
 J *
 NoteNewRequest(
     const char *request

test/mock/mock-parameters.hpp

@@ -49,6 +49,17 @@ struct NoteDeleteResponse_Parameters {
     J *response;
 };
 
+struct NoteNewCommand_Parameters {
+    NoteNewCommand_Parameters(
+        void
+    ) :
+        request(nullptr),
+        result(nullptr)
+    { }
+    const char *request;
+    J *result;
+};
+
 struct NoteNewRequest_Parameters {
     NoteNewRequest_Parameters(
         void
@@ -151,6 +162,7 @@ struct NoteSetFnSerial_Parameters {
 extern NoteDebug_Parameters noteDebug_Parameters;
 extern NoteDebugSyncStatus_Parameters noteDebugSyncStatus_Parameters;
 extern NoteDeleteResponse_Parameters noteDeleteResponse_Parameters;
+extern NoteNewCommand_Parameters noteNewCommand_Parameters;
 extern NoteNewRequest_Parameters noteNewRequest_Parameters;
 extern NoteRequest_Parameters noteRequest_Parameters;
 extern NoteRequestResponse_Parameters noteRequestResponse_Parameters;