chore:update note-c (#66)

* remove note-c before re-add

* Squashed 'src/note-c/' content from commit 931dc8a

git-subtree-dir: src/note-c
git-subtree-split: 931dc8a38d7095d9ade84eaf8e9b23562ae61060

Author: bsatrom

src/note-c/n_cjson_helpers.c

@@ -305,7 +305,7 @@ bool JContainsString(J *rsp, const char *field, const char *substr)
 //**************************************************************************/
 /*!
     @brief  Add a binary to a Note as a Base64-encoded string.
-    @param   req The JSON request object.
+    @param   req The JSON object to which the field should be added
     @param   fieldName The field to set.
     @param   binaryData The binary data to set.
     @param   binaryDataLen The length of the binary string.
@@ -329,6 +329,38 @@ bool JAddBinaryToObject(J *req, const char *fieldName, const void *binaryData, u
     return true;
 }
 
+//**************************************************************************/
+/*!
+    @brief  Get binary from an object that is expected to be a Base64-encoded string.
+    @param   rsp The JSON object containing the  field.
+    @param   fieldName The field to get data from.
+    @param   retBinaryData The binary data object allocated.  (Use standard "free" method to free it.)
+    @param   retBinaryDataLen The length of the binary data.
+    @returns bool. Whether the binary data was allocated and returned.
+*/
+/**************************************************************************/
+bool JGetBinaryFromObject(J *rsp, const char *fieldName, uint8_t **retBinaryData, uint32_t *retBinaryDataLen)
+{
+
+    char *payload = JGetString(rsp, fieldName);
+    if (payload[0] == '\0') {
+        return false;
+    }
+
+    // Allocate a buffer for the payload
+    char *p = (char *) _Malloc(JB64DecodeLen(payload));
+    if (p == NULL) {
+		return false;
+	}
+    uint32_t actualLen = JB64Decode(p, payload);
+
+	// Return the binary to the caller
+	*retBinaryData = p;
+	*retBinaryDataLen = actualLen;
+	return true;
+
+}
+
 //**************************************************************************/
 /*!
     @brief  Get the object name.

src/note-c/n_request.c

@@ -312,21 +312,6 @@ char *NoteRequestResponseJSON(char *reqJSON)
 
 }
 
-/**************************************************************************/
-/*!
-    @brief  Override-able method to return user agent object
-  @returns a `J` cJSON object with the user agent object.
-*/
-/**************************************************************************/
-#if defined(_MSC_VER)
-J *NoteUserAgent()
-#else
-__attribute__((weak)) J *NoteUserAgent()
-#endif
-{
-    return NULL;
-}
-
 /**************************************************************************/
 /*!
     @brief  Initiate a transaction to the Notecard and return the response.

src/note-c/n_ua.c

@@ -29,11 +29,29 @@ static char *n_cpu_name = NULL;
 
 /**************************************************************************/
 /*!
-    @brief  Method to return user agent object
+    @brief  Override-able method to add more data to the user agent object
   @returns a `J` cJSON object with the user agent object.
 */
 /**************************************************************************/
+#if defined(_MSC_VER)
+void NoteUserAgentUpdate(J *ua)
+#else
+__attribute__((weak)) void NoteUserAgentUpdate(J *ua)
+#endif
+{
+}
+
+/**************************************************************************/
+/*!
+    @brief  Override-able method to return user agent object
+  @returns a `J` cJSON object with the user agent object.
+*/
+/**************************************************************************/
+#if defined(_MSC_VER)
 J *NoteUserAgent()
+#else
+__attribute__((weak)) J *NoteUserAgent()
+#endif
 {
 
     J *ua = JCreateObject();
@@ -76,8 +94,6 @@ J *NoteUserAgent()
     n_cpu_name = "esp32";
 #elif defined(ARDUINO_ARCH_ESP8266)
     n_cpu_name = "esp8266";
-#elif defined(ARDUINO_ARCH_MBED)
-    n_cpu_name = "mbed";
 #elif defined(ARDUINO_ARCH_MEGAAVR)
     n_cpu_name = "megaavr";
 #elif defined(ARDUINO_ARCH_NRF52840)
@@ -145,6 +161,9 @@ J *NoteUserAgent()
         JAddStringToObject(ua, "os_version", n_os_version);
     }
 
+    // Add more data to the UA from a higher level
+    NoteUserAgentUpdate(ua);
+
     return ua;
 
 }

src/note-c/note.h

@@ -139,6 +139,7 @@ void NoteSetI2CAddress(uint32_t i2caddress);
 
 // User agent
 J *NoteUserAgent(void);
+void NoteUserAgentUpdate(J *ua);
 void NoteSetUserAgent(char *agent);
 void NoteSetUserAgentOS(char *os_name, char *os_platform, char *os_family, char *os_version);
 void NoteSetUserAgentCPU(int cpu_mem, int cpu_mhz, int cpu_cores, char *cpu_vendor, char *cpu_name);
@@ -181,6 +182,7 @@ bool JIsNullString(J *rsp, const char *field);
 bool JIsExactString(J *rsp, const char *field, const char *teststr);
 bool JContainsString(J *rsp, const char *field, const char *substr);
 bool JAddBinaryToObject(J *req, const char *fieldName, const void *binaryData, uint32_t binaryDataLen);
+bool JGetBinaryFromObject(J *rsp, const char *fieldName, uint8_t **retBinaryData, uint32_t *retBinaryDataLen);
 const char *JGetItemName(const J * item);
 char *JAllocString(uint8_t *buffer, uint32_t len);
 const char *JType(J *item);