Update note-c for release (#95)

* updated version information
* remove note-c before re-add
* Squashed 'src/note-c/' content from commit afa46a6
git-subtree-dir: src/note-c
git-subtree-split: afa46a6708ba4dd491ea4b844db73eed82b4ece5

Author: zfields

library.properties

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

src/note-c/.github/workflows/ci.yml

@@ -22,4 +22,4 @@ jobs:
       - name: Install astyle
         run: sudo apt-get install -y astyle
       - name: Check formatting
-        run: ./scripts/run_astyle.sh --check
+        run: ./scripts/run_astyle.sh

src/note-c/.gitignore

@@ -5,4 +5,4 @@ html/
 
 # VS Code workspace files
 *.code-workspace
-*.orig
+*.orig

src/note-c/CMakeLists.txt

@@ -73,7 +73,16 @@ if(BUILD_TESTS)
          NoteI2CReceive;
          NoteLockI2C;
          NoteUnlockI2C;
-         NoteI2CReset"
+         NoteI2CReset;
+         NoteSerialAvailable;
+         NoteSerialTransmit;
+         NoteSerialReceive;
+         NoteSerialReset;
+         NoteIsDebugOutputActive;
+         NoteDebug;
+         NotePrint;
+         NoteNewCommand;
+         NoteRequest"
     )
     foreach(MOCKED_FN ${MOCKED_FNS})
         string(APPEND OBJCOPY_WEAKEN "-W ${MOCKED_FN} ")

src/note-c/n_cjson_helpers.c

@@ -83,7 +83,7 @@ J *JGetObject(J *rsp, const char *field)
 
 //**************************************************************************/
 /*!
-    @brief  Return the boolean repsentation of an item.
+    @brief  Return the boolean representation of an item.
     @param   item The JSON item.
     @returns The boolean value.
 */
@@ -98,7 +98,7 @@ bool JBoolValue(J *item)
 
 //**************************************************************************/
 /*!
-    @brief  Return the string repsentation of an item.
+    @brief  Return the string representation of an item.
     @param   item The JSON item.
     @returns The string value, or empty string, if NULL.
 */
@@ -113,7 +113,7 @@ char *JStringValue(J *item)
 
 //**************************************************************************/
 /*!
-    @brief  Return the number repsentation of an item.
+    @brief  Return the number representation of an item.
     @param   item The JSON item.
     @returns The number, or 0.0, if NULL.
 */
@@ -151,7 +151,7 @@ JNUMBER JGetNumber(J *rsp, const char *field)
 
 //**************************************************************************/
 /*!
-    @brief  Return the integer repsentation of an item.
+    @brief  Return the integer representation of an item.
     @param   item The JSON item.
     @returns The number, or 0, if NULL.
 */
@@ -546,7 +546,7 @@ int JGetType(J *rsp, const char *field)
         }
         return JTYPE_NUMBER;
     case JRaw:
-    case JString:
+    case JString: {
         v = item->valuestring;
         if (v == NULL || v[0] == 0) {
             return JTYPE_STRING_BLANK;
@@ -576,6 +576,7 @@ int JGetType(J *rsp, const char *field)
             return JTYPE_STRING_BOOL_FALSE;
         }
         return JTYPE_STRING;
+    }
     case JObject:
         return JTYPE_OBJECT;
     case JArray:

src/note-c/n_helpers.c

@@ -182,19 +182,16 @@ void NotePrintln(const char *line)
 bool NotePrint(const char *text)
 {
     bool success = false;
+
     if (NoteIsDebugOutputActive()) {
         NoteDebug(text);
         return true;
     }
-    int inLog = 0;
-    if (inLog++ != 0) {
-        inLog--;
-        return false;
-    }
+
     J *req = NoteNewRequest("card.log");
     JAddStringToObject(req, "text", text);
     success = NoteRequest(req);
-    inLog--;
+
     return success;
 }
 
@@ -328,7 +325,7 @@ bool NoteRegion(char **retCountry, char **retArea, char **retZone, int *retZoneO
     if (retZoneOffset != NULL) {
         *retZoneOffset = curZoneOffsetMins;
     }
-    return true;;
+    return true;
 }
 
 //**************************************************************************/
@@ -757,7 +754,7 @@ bool NoteGetLocation(JNUMBER *retLat, JNUMBER *retLon, JTIME *time, char *status
     J *rsp = NoteRequestResponse(NoteNewRequest("card.location"));
     if (rsp != NULL) {
         if (statusBuf != NULL) {
-            strlcpy(statusBuf, JGetString(rsp, "err"), statusBufLen);
+            strlcpy(statusBuf, JGetString(rsp, "status"), statusBufLen);
         }
         if (JIsPresent(rsp, "lat") && JIsPresent(rsp, "lon")) {
             if (retLat != NULL) {
@@ -992,7 +989,7 @@ bool NoteGetStatus(char *statusBuf, int statusBufLen, JTIME *bootTime, bool *ret
 
 //**************************************************************************/
 /*!
-  @brief  Get Status of the Notecard, with a supression timer.
+  @brief  Get Status of the Notecard, with a suppression timer.
   @param  statusBuf (out) a buffer to populate with the Notecard status
   from the response.
   @param  statusBufLen The length of the status buffer.
@@ -1117,7 +1114,7 @@ bool NoteSleep(char *stateb64, uint32_t seconds, const char *modes)
     if (req != NULL) {
         // Add the base64 item in a wonderful way that doesn't strdup the huge string
         if (stateb64 != NULL) {
-            J *stringReferenceItem = JCreateStringValue(stateb64);
+            J *stringReferenceItem = JCreateStringReference(stateb64);
             if (stringReferenceItem != NULL) {
                 JAddItemToObject(req, "payload", stringReferenceItem);
             }

src/note-c/n_i2c.c

@@ -42,14 +42,14 @@ static void _DelayIO()
   @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.
+  @returns a c-string with an error, or `NULL` if no error occurred.
 */
 /**************************************************************************/
 const char *i2cNoteTransaction(char *json, char **jsonResponse)
 {
 
     // Append newline to the transaction
-    int jsonLen = strlen(json);
+    size_t jsonLen = strlen(json);
     uint8_t *transmitBuf = (uint8_t *) _Malloc(jsonLen+1);
     if (transmitBuf == NULL) {
         return ERRSTR("insufficient memory",c_mem);
@@ -63,11 +63,16 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
     // Transmit the request in chunks, but also in segments so as not to overwhelm the notecard's interrupt buffers
     const char *estr;
     uint8_t *chunk = transmitBuf;
-    uint32_t sentInSegment = 0;
+    uint16_t sentInSegment = 0;
     while (jsonLen > 0) {
-        int chunklen = (uint8_t) (jsonLen > (int)_I2CMax() ? (int)_I2CMax() : jsonLen);
+        // Constrain chunkLen to fit into 16 bits (_I2CTransmit takes the buffer
+        // size as a uint16_t).
+        uint16_t chunkLen = (jsonLen > 0xFFFF) ? 0xFFFF : jsonLen;
+        // Constrain chunkLen to be <= _I2CMax().
+        chunkLen = (chunkLen > _I2CMax()) ? _I2CMax() : chunkLen;
+
         _DelayIO();
-        estr = _I2CTransmit(_I2CAddress(), chunk, chunklen);
+        estr = _I2CTransmit(_I2CAddress(), chunk, chunkLen);
         if (estr != NULL) {
             _Free(transmitBuf);
             _I2CReset(_I2CAddress());
@@ -79,9 +84,9 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
             _UnlockI2C();
             return estr;
         }
-        chunk += chunklen;
-        jsonLen -= chunklen;
-        sentInSegment += chunklen;
+        chunk += chunkLen;
+        jsonLen -= chunkLen;
+        sentInSegment += chunkLen;
         if (sentInSegment > CARD_REQUEST_I2C_SEGMENT_MAX_LEN) {
             sentInSegment = 0;
             if (!cardTurboIO) {
@@ -107,7 +112,7 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
     // our json parser requires a null-terminated string.
     int growlen = ALLOC_CHUNK;
     int jsonbufAllocLen = growlen;
-    char *jsonbuf = (char *) _Malloc(jsonbufAllocLen+1);
+    uint8_t *jsonbuf = (uint8_t *) _Malloc(jsonbufAllocLen+1);
     if (jsonbuf == NULL) {
 #ifdef ERRDBG
         _Debug("transaction: jsonbuf malloc failed\n");
@@ -120,18 +125,18 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
     // buffer we used to transmit, and will grow it as necessary.
     bool receivedNewline = false;
     int jsonbufLen = 0;
-    int chunklen = 0;
+    uint16_t chunkLen = 0;
     uint32_t startMs = _GetMs();
     while (true) {
 
         // Grow the buffer as necessary to read this next chunk
-        if (jsonbufLen + chunklen > jsonbufAllocLen) {
-            if (chunklen > growlen) {
-                jsonbufAllocLen += chunklen;
+        if (jsonbufLen + chunkLen > jsonbufAllocLen) {
+            if (chunkLen > growlen) {
+                jsonbufAllocLen += chunkLen;
             } else {
                 jsonbufAllocLen += growlen;
             }
-            char *jsonbufNew = (char *) _Malloc(jsonbufAllocLen+1);
+            uint8_t *jsonbufNew = (uint8_t *) _Malloc(jsonbufAllocLen+1);
             if (jsonbufNew == NULL) {
 #ifdef ERRDBG
                 _Debug("transaction: jsonbuf grow malloc failed\n");
@@ -148,7 +153,8 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
         // Read the chunk
         uint32_t available;
         _DelayIO();
-        const char *err = _I2CReceive(_I2CAddress(), (uint8_t *) &jsonbuf[jsonbufLen], chunklen, &available);
+        const char *err = _I2CReceive(_I2CAddress(), &jsonbuf[jsonbufLen],
+                                      chunkLen, &available);
         if (err != NULL) {
             _Free(jsonbuf);
 #ifdef ERRDBG
@@ -159,7 +165,7 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
         }
 
         // We've now received the chunk
-        jsonbufLen += chunklen;
+        jsonbufLen += chunkLen;
 
         // If the last byte of the chunk is \n, chances are that we're done.  However, just so
         // that we pull everything pending from the module, we only exit when we've received
@@ -168,11 +174,14 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
             receivedNewline = true;
         }
 
-        // For the next iteration, read the min of what's available and what we're permitted to read
-        chunklen = (int) (available > _I2CMax() ? _I2CMax() : available);
+        // Constrain chunkLen to fit into 16 bits (_I2CReceive takes the buffer
+        // size as a uint16_t).
+        chunkLen = (available > 0xFFFF) ? 0xFFFF : available;
+        // Constrain chunkLen to be <= _I2CMax().
+        chunkLen = (chunkLen > _I2CMax()) ? _I2CMax() : chunkLen;
 
         // If there's something available on the notecard for us to receive, do it
-        if (chunklen > 0) {
+        if (chunkLen > 0) {
             continue;
         }
 
@@ -205,7 +214,7 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
     jsonbuf[jsonbufLen] = '\0';
 
     // Return it
-    *jsonResponse = jsonbuf;
+    *jsonResponse = (char *)jsonbuf;
     return NULL;
 }
 
@@ -242,16 +251,16 @@ bool i2cNoteReset()
     for (retries=0; transmitErr==NULL && !notecardReady && retries<3; retries++) {
 
         // Loop to drain all chunks of data that may be ready to transmit to us
-        int chunklen = 0;
+        uint16_t chunkLen = 0;
         while (true) {
 
             // Read the next chunk of available data
             uint32_t available;
             uint8_t buffer[128];
-            chunklen = (chunklen > (int)sizeof(buffer)) ? (int)sizeof(buffer) : chunklen;
-            chunklen = (chunklen > (int)_I2CMax()) ? (int)_I2CMax() : chunklen;
+            chunkLen = (chunkLen > sizeof(buffer)) ? sizeof(buffer) : chunkLen;
+            chunkLen = (chunkLen > _I2CMax()) ? _I2CMax() : chunkLen;
             _DelayIO();
-            const char *err = _I2CReceive(_I2CAddress(), buffer, chunklen, &available);
+            const char *err = _I2CReceive(_I2CAddress(), buffer, chunkLen, &available);
             if (err) {
                 break;
             }
@@ -262,8 +271,10 @@ bool i2cNoteReset()
                 break;
             }
 
-            // Read everything that's left on the module
-            chunklen = available;
+            // Read the minimum of the available bytes left to read and what
+            // will fit into a 16-bit unsigned value (_I2CReceive takes the
+            // buffer size as a uint16_t).
+            chunkLen = (available > 0xFFFF) ? 0xFFFF : available;
 
         }
 

src/note-c/n_serial.c

@@ -48,7 +48,7 @@ const char *serialNoteTransaction(char *json, char **jsonResponse)
         if (segLen > CARD_REQUEST_SERIAL_SEGMENT_MAX_LEN) {
             segLen = CARD_REQUEST_SERIAL_SEGMENT_MAX_LEN;
         }
-        _SerialTransmit((uint8_t *)&transmitBuf[segOff], segLen, false);
+        _SerialTransmit(&transmitBuf[segOff], segLen, false);
         segOff += segLen;
         segLeft -= segLen;
         if (segLeft == 0) {
@@ -212,8 +212,9 @@ bool serialNoteReset()
         _Debug("no notecard\n");
 #endif
         _DelayMs(500);
-        _SerialReset();
-
+        if (!_SerialReset()) {
+            return false;
+        }
     }
 
     // Done

src/note-c/scripts/run_astyle.sh

@@ -6,12 +6,6 @@
 # If a file shouldn't be formatted, it needs to be listed in the EXCLUDE_FILES
 # array below with a path relative to the source code root.
 #
-# Options:
-#   --check: After formatting, check if any necessary formatting changes weren't
-#            committed. If there are uncommitted changes, fail. This allows us
-#            to ensure all committed code has been formatted prior to being
-#            merged.
-#
 
 if [[ ! $(which astyle) ]]; then
     echo "astyle binary not found. Please install it and try again."
@@ -23,21 +17,9 @@ EXCLUDE_FILES=(
     test/include/fff.h
 )
 
-CHECK=0
-
-while [[ "$#" -gt 0 ]]; do
-    case $1 in
-        --check) CHECK=1 ;;
-        *) echo "Unknown parameter: $1"; exit 1 ;;
-    esac
-    shift
-done
-
-if [ $CHECK -eq 1 ]; then
-    if [[ `git status --porcelain --untracked=no` ]]; then
-        echo "Uncommitted changes detected. Please commit or discard any working tree changes prior to running this script with --check."
-        exit 1
-    fi
+if [[ `git status --porcelain --untracked=no` ]]; then
+    echo "Local changes detected. Please commit, stash, or discard any working tree changes prior to running this script."
+    exit 1
 fi
 
 # Run astyle on all version-controlled C and C++ files.
@@ -49,13 +31,11 @@ do
     fi
 done
 
-# If --check was given, fail the script if running astyle produced any new,
-# uncommitted changes.
-if [ $CHECK -eq 1 ]; then
-    if [[ `git status --porcelain --untracked=no` ]]; then
-        echo "Unformatted files detected. Run scripts/run_astyle.sh and amend your commit with the resulting formatting changes."
-        exit 1
-    else
-        echo "Formatting clean."
-    fi
+# If there are new formatting changes after running astyle, exit with a non-zero
+# value.
+if [[ `git status --porcelain --untracked=no` ]]; then
+    echo "New formatting changes left in working tree."
+    exit 1
+else
+    echo "No new formatting changes."
 fi