chore: Update note-c (#104)

* chore: bump version
* chore: Update CI
    - Lock CI container base image
    - Update Arduino CLI
    - Update actions/checkout
* remove note-c before re-add
* Squashed 'src/note-c/' content from commit 14953bf

git-subtree-dir: src/note-c
git-subtree-split: 14953bfe1c36187e88276d822cfd1d51701bd5c9

Author: zfields

.github/actions/compile-examples/Dockerfile

@@ -9,13 +9,13 @@
 # docker run --entrypoint bash --interactive --rm --tty --volume "$(pwd)":/host-volume/ --workdir /host-volume/ arduino-cli
 
 # Define global arguments
-ARG ARDUINO_CLI_VERSION=0.23.0
+ARG ARDUINO_CLI_VERSION=0.33.0
 ARG DEBIAN_FRONTEND="noninteractive"
 ARG UID=1000
 ARG USER="blues"
 
 # POSIX compatible (Linux/Unix) base image
-FROM debian:stable-slim
+FROM debian:bullseye-slim
 
 # Import global arguments
 ARG ARDUINO_CLI_VERSION

.github/actions/run-tests-in-container/Dockerfile

@@ -15,6 +15,7 @@ RUN ["ash", "-c", "\
     apk add --no-cache \
       g++ \
       gdb \
+      gzip \
       valgrind \
 "]
 

.github/workflows/note-arduino-ci.yml

@@ -12,7 +12,7 @@ jobs:
     steps:
       - name: Checkout Code
         id: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Run Tests In Container
         id: containerized_tests
         uses: ./.github/actions/run-tests-in-container
@@ -52,7 +52,7 @@ jobs:
     steps:
       - name: Checkout Code
         id: checkout
-        uses: actions/checkout@v2
+        uses: actions/checkout@v3
       - name: Compile Examples
         id: compile_examples
         uses: ./.github/actions/compile-examples

.vscode/extensions.json

@@ -3,6 +3,8 @@
     // for the documentation about the extensions.json format
     "recommendations": [],
     "unwantedRecommendations": [
-        "ms-vscode.cpptools-extension-pack"
+        "ms-vscode.cmake-tools",
+        "ms-vscode.cpptools-extension-pack",
+        "ms-azuretools.vscode-docker"
     ]
 }

library.properties

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

src/note-c/.github/actions/run_unit_tests/Dockerfile

@@ -12,7 +12,7 @@ ARG UID=1000
 ARG USER="blues"
 
 # POSIX compatible (Linux/Unix) base image.
-FROM debian:stable-slim
+FROM --platform=linux/amd64 debian:stable-slim
 
 # Import Global Argument(s)
 ARG DEBIAN_FRONTEND

src/note-c/.vscode/extensions.json

@@ -0,0 +1,9 @@
+{
+    // See http://go.microsoft.com/fwlink/?LinkId=827846
+    // for the documentation about the extensions.json format
+    "unwantedRecommendations": [
+        "ms-vscode.cmake-tools",
+        "ms-vscode.cpptools-extension-pack",
+        "ms-azuretools.vscode-docker"
+    ]
+}

src/note-c/n_cjson.c

@@ -89,7 +89,6 @@ typedef struct {
 static error global_error = { NULL, 0 };
 
 // Forwards
-void htoa16(uint16_t n, unsigned char *p);
 static J *JNew_Item(void);
 
 N_CJSON_PUBLIC(const char *) JGetErrorPtr(void)
@@ -712,7 +711,7 @@ static Jbool parse_string(J * const item, parse_buffer * const input_buffer)
 }
 
 /* Convert a 16-bit number to 4 hex digits, null-terminating it */
-void htoa16(uint16_t n, unsigned char *p)
+void n_htoa16(uint16_t n, unsigned char *p)
 {
     int i;
     for (i=0; i<4; i++) {
@@ -827,7 +826,7 @@ static Jbool print_string_ptr(const unsigned char * const input, printbuffer * c
             default:
                 /* escape and print as unicode codepoint */
                 *output_pointer++ = 'u';
-                htoa16(*input_pointer, output_pointer);
+                n_htoa16(*input_pointer, output_pointer);
                 output_pointer += 4;
                 break;
             }

src/note-c/n_hooks.c

@@ -469,15 +469,15 @@ void NoteDelayMs(uint32_t ms)
     }
 }
 
-#if NOTE_SHOW_MALLOC
+#if NOTE_SHOW_MALLOC || !defined(NOTE_LOWMEM)
 //**************************************************************************/
 /*!
-  @brief  If set for low-memory platforms, show a malloc call.
-  @param   len the number of bytes of memory allocated by the last call.
+  @brief  Convert number to a hex string
+  @param   the number
+  @param   the buffer to return it into
 */
 /**************************************************************************/
-void htoa32(uint32_t n, char *p);
-void htoa32(uint32_t n, char *p)
+void n_htoa32(uint32_t n, char *p)
 {
     int i;
     for (i=0; i<8; i++) {
@@ -491,6 +491,15 @@ void htoa32(uint32_t n, char *p)
     }
     *p = '\0';
 }
+#endif
+
+#if NOTE_SHOW_MALLOC
+//**************************************************************************/
+/*!
+  @brief  If set for low-memory platforms, show a malloc call.
+  @param   len the number of bytes of memory allocated by the last call.
+*/
+/**************************************************************************/
 void *malloc_show(size_t len)
 {
     char str[16];
@@ -501,7 +510,7 @@ void *malloc_show(size_t len)
     if (p == NULL) {
         hookDebugOutput("FAIL");
     } else {
-        htoa32((uint32_t)p, str);
+        n_htoa32((uint32_t)p, str);
         hookDebugOutput(str);
     }
     return p;
@@ -537,7 +546,7 @@ void NoteFree(void *p)
     if (hookFree != NULL) {
 #if NOTE_SHOW_MALLOC
         char str[16];
-        htoa32((uint32_t)p, str);
+        n_htoa32((uint32_t)p, str);
         hookDebugOutput("free");
         hookDebugOutput(str);
 #endif

src/note-c/n_i2c.c

@@ -110,8 +110,8 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
     // Dynamically grow the buffer as we read.  Note that we always put the +1 in the alloc
     // so we can be assured that it can be null-terminated, which must be the case because
     // our json parser requires a null-terminated string.
-    int growlen = ALLOC_CHUNK;
-    int jsonbufAllocLen = growlen;
+    size_t growlen = ALLOC_CHUNK;
+    size_t jsonbufAllocLen = growlen;
     uint8_t *jsonbuf = (uint8_t *) _Malloc(jsonbufAllocLen+1);
     if (jsonbuf == NULL) {
 #ifdef ERRDBG
@@ -124,7 +124,7 @@ const char *i2cNoteTransaction(char *json, char **jsonResponse)
     // Loop, building a reply buffer out of received chunks.  We'll build the reply in the same
     // buffer we used to transmit, and will grow it as necessary.
     bool receivedNewline = false;
-    int jsonbufLen = 0;
+    size_t jsonbufLen = 0;
     uint16_t chunkLen = 0;
     uint32_t startMs = _GetMs();
     while (true) {

src/note-c/n_lib.h

@@ -97,6 +97,11 @@ bool NoteHardReset(void);
 const char *NoteJSONTransaction(char *json, char **jsonResponse);
 bool NoteIsDebugOutputActive(void);
 
+// Utilities
+void n_htoa32(uint32_t n, char *p);
+void n_htoa16(uint16_t n, unsigned char *p);
+uint64_t n_atoh(char *p, int maxlen);
+
 // Constants, a global optimization to save static string memory
 extern const char *c_null;
 #define c_null_len 4

src/note-c/n_md5.c

@@ -29,7 +29,7 @@
 #include "n_lib.h"
 
 // Forwards
-void htoa8(unsigned char n, unsigned char *p);
+void n_htoa8(unsigned char n, unsigned char *p);
 static void putu32 (unsigned long data, unsigned char *addr);
 static unsigned long getu32 (const unsigned char *addr);
 
@@ -54,7 +54,7 @@ static void putu32 (unsigned long data, unsigned char *addr)
 }
 
 /* Convert an 8-bit number to 2 hex digits, null-terminating it */
-void htoa8(unsigned char n, unsigned char *p)
+void n_htoa8(unsigned char n, unsigned char *p)
 {
     unsigned char nibble = (n >> 4) & 0xf;
     if (nibble >= 10) {
@@ -304,7 +304,7 @@ void NoteMD5HashString(unsigned char *data, unsigned long len, char *strbuf, uns
     NoteMD5Hash(data, len, hash);
     char hashstr[NOTE_MD5_HASH_SIZE*3] = {0};
     for (int i=0; i<NOTE_MD5_HASH_SIZE; i++) {
-        htoa8(hash[i], (unsigned char *)&hashstr[i*2]);
+        n_htoa8(hash[i], (unsigned char *)&hashstr[i*2]);
     }
     hashstr[NOTE_MD5_HASH_SIZE*2+1] = 0;
     strlcpy(strbuf, hashstr, buflen);
@@ -315,7 +315,7 @@ void NoteMD5HashToString(unsigned char *hash, char *strbuf, unsigned long buflen
 {
     char hashstr[NOTE_MD5_HASH_SIZE*3] = {0};
     for (int i=0; i<NOTE_MD5_HASH_SIZE; i++) {
-        htoa8(hash[i], (unsigned char *)&hashstr[i*2]);
+        n_htoa8(hash[i], (unsigned char *)&hashstr[i*2]);
     }
     strlcpy(strbuf, hashstr, buflen);
 }