Bump note-c to latest master. (#102)

Co-authored-by: Zachary J. Fields <[email protected]>

Author: haydenroche5

examples/Example1_NotecardBasics/Example1_NotecardBasics.ino

@@ -165,13 +165,12 @@ void loop()
     if (req != NULL)
     {
         JAddBoolToObject(req, "sync", true);
-        J *body = JCreateObject();
+        J *body = JAddObjectToObject(req, "body");
         if (body != NULL)
         {
             JAddNumberToObject(body, "temp", temperature);
             JAddNumberToObject(body, "voltage", voltage);
             JAddNumberToObject(body, "count", eventCounter);
-            JAddItemToObject(req, "body", body);
         }
         notecard.sendRequest(req);
     }

examples/Example2_PeriodicCommunications/Example2_PeriodicCommunications.ino

@@ -199,13 +199,12 @@ void loop()
     J *req = notecard.newRequest("note.add");
     if (req != NULL)
     {
-        J *body = JCreateObject();
+        J *body = JAddObjectToObject(req, "body");
         if (body != NULL)
         {
             JAddNumberToObject(body, "temp", temperature);
             JAddNumberToObject(body, "voltage", voltage);
             JAddNumberToObject(body, "count", eventCounter);
-            JAddItemToObject(req, "body", body);
         }
         notecard.sendRequest(req);
     }

examples/Example5_UsingTemplates/Example5_UsingTemplates.ino

@@ -122,21 +122,18 @@ void setup()
     // look "similar" to the Notes that will later be added with note.add, in
     // that the data types are used to intuit what the ultimate field data types
     // will be, and their maximum length.
-    req = notecard.newRequest("note.add");
+    req = notecard.newRequest("note.template");
     if (req != NULL)
     {
         // Create the body for a template that will be used to send notes below
-        J *body = JCreateObject();
+        J *body = JAddObjectToObject(req, "body");
         if (body != NULL)
         {
             // Define the JSON template
-            JAddStringToObject(body, "status", "AAAAAAAAAAAA"); // maximum string length
-            JAddNumberToObject(body, "temp", 1.1);              // floating point (double)
-            JAddNumberToObject(body, "voltage", 1.1);           // floating point (double)
-            JAddNumberToObject(body, "count", 1);               // integer
-
-            // Add the body to the request
-            JAddItemToObject(req, "body", body);
+            JAddStringToObject(body, "status", TSTRING(12)); // maximum string length
+            JAddNumberToObject(body, "temp", TFLOAT64);      // floating point (double)
+            JAddNumberToObject(body, "voltage", TFLOAT64);   // floating point (double)
+            JAddNumberToObject(body, "count", TUINT32);      // 32-bit unsigned integer
         }
 
         // Create a template of the payload that will be used to send
@@ -145,7 +142,6 @@ void setup()
 
         // Register the template in the output queue notefile
         JAddStringToObject(req, "file", "sensors.qo");
-        JAddBoolToObject(req, "template", true);
         notecard.sendRequest(req);
     }
 }
@@ -199,14 +195,13 @@ void loop()
     if (req != NULL)
     {
         JAddStringToObject(req, "file", "sensors.qo");
-        J *body = JCreateObject();
+        J *body = JAddObjectToObject(req, "body");
         if (body != NULL)
         {
             JAddStringToObject(body, "status", temperature > 26.67 ? "hot" : "normal"); // 80F
             JAddNumberToObject(body, "temp", temperature);
             JAddNumberToObject(body, "voltage", voltage);
             JAddNumberToObject(body, "count", eventCounter);
-            JAddItemToObject(req, "body", body);
         }
         JAddBinaryToObject(req, "payload", &binaryData, sizeof(binaryData));
         notecard.sendRequest(req);

examples/Example7_PowerControl/Example7_PowerControl.ino

@@ -166,15 +166,14 @@ void loop()
     if (req != NULL)
     {
         JAddStringToObject(req, "file", "example.qo");
-        J *body = JCreateObject();
+        J *body = JAddObjectToObject(req, "body");
         if (body != NULL)
         {
             JAddNumberToObject(body, "cycles", globalState.cycles);
             JAddNumberToObject(body, "temperature", currentTemperature);
             JAddNumberToObject(body, "temperature_measurements", tempSensorState.measurements);
             JAddNumberToObject(body, "voltage", currentVoltage);
             JAddNumberToObject(body, "voltage_measurements", voltSensorState.measurements);
-            JAddItemToObject(req, "body", body);
         }
         notecard.sendRequest(req);
     }

library.properties

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

src/note-c/CMakeLists.txt

@@ -14,10 +14,10 @@ if(NOT EXISTS ${PROJECT_BINARY_DIR}/.gitignore)
     file(WRITE ${PROJECT_BINARY_DIR}/.gitignore "*")
 endif()
 
-option(BUILD_TESTS "Build tests." OFF)
-option(BUILD_SHARED_LIBS "Build note-c as a shared library." OFF)
-option(COVERAGE "Compile for test coverage reporting." OFF)
-option(MEM_CHECK "Run tests with Valgrind." OFF)
+option(NOTE_C_BUILD_TESTS "Build tests." OFF)
+option(BUILD_SHARED_LIBS "Build shared libraries instead of static." OFF)
+option(NOTE_C_COVERAGE "Compile for test NOTE_C_COVERAGE reporting." OFF)
+option(NOTE_C_MEM_CHECK "Run tests with Valgrind." OFF)
 
 set(NOTE_C_SRC_DIR ${CMAKE_CURRENT_SOURCE_DIR})
 add_library(
@@ -51,22 +51,26 @@ target_include_directories(
     PUBLIC ${NOTE_C_SRC_DIR}
 )
 
-if(BUILD_TESTS)
+if(NOTE_C_BUILD_TESTS)
     # Including CTest here rather than in test/CMakeLists.txt allows us to run
     # ctest from the root build directory (e.g. build/ instead of build/test/).
     # We also need to set MEMORYCHECK_COMMAND_OPTIONS before including this.
     # See: https://stackoverflow.com/a/60741757
-    if(MEM_CHECK)
+    if(NOTE_C_MEM_CHECK)
         # Go ahead and make sure we can find valgrind while we're here.
         find_program(VALGRIND valgrind REQUIRED)
         message(STATUS "Found valgrind: ${VALGRIND}")
         set(MEMORYCHECK_COMMAND_OPTIONS "--leak-check=full --error-exitcode=1")
-    endif(MEM_CHECK)
+    endif(NOTE_C_MEM_CHECK)
     include(CTest)
 
     target_compile_definitions(
         note_c
-        PUBLIC TEST
+        PUBLIC NOTE_C_TEST
+    )
+    target_include_directories(
+        note_c
+        PRIVATE ${CMAKE_CURRENT_LIST_DIR}/test/include
     )
 
     # If we don't weaken the functions we're mocking in the tests, the linker
@@ -124,4 +128,4 @@ if(BUILD_TESTS)
     )
 
     add_subdirectory(test)
-endif(BUILD_TESTS)
+endif(NOTE_C_BUILD_TESTS)

src/note-c/n_cjson.c

@@ -67,9 +67,6 @@
 
 #include "n_lib.h"
 
-#define STRINGIFY(x) STRINGIFY_(x)
-#define STRINGIFY_(x) #x
-
 #ifdef ENABLE_LOCALES
 #include <locale.h>
 #endif
@@ -112,7 +109,7 @@ N_CJSON_PUBLIC(char *) JGetStringValue(J *item)
 
 N_CJSON_PUBLIC(const char*) JVersion(void)
 {
-    return STRINGIFY(N_CJSON_VERSION_MAJOR) "." STRINGIFY(N_CJSON_VERSION_MINOR) "." STRINGIFY(N_CJSON_VERSION_PATCH);
+    return NOTE_C_STRINGIZE(N_CJSON_VERSION_MAJOR) "." NOTE_C_STRINGIZE(N_CJSON_VERSION_MINOR) "." NOTE_C_STRINGIZE(N_CJSON_VERSION_PATCH);
 }
 
 /* Case insensitive string comparison, doesn't consider two NULL pointers equal though */

src/note-c/n_helpers.c

@@ -16,6 +16,12 @@
 #include <stdarg.h>
 #include "n_lib.h"
 
+#ifdef NOTE_C_TEST
+#include "test_static.h"
+#else
+#define NOTE_C_STATIC static
+#endif
+
 // When interfacing with the Notecard, it is generally encouraged that the JSON object manipulation and
 // calls to the note-arduino library are done directly at point of need.  However, there are cases in which
 // it's convenient to have a wrapper.  The most common reason is when it's best to have a suppression timer
@@ -68,8 +74,8 @@ static short normalYearDaysByMonth[] = {0, 31, 59, 90, 120, 151, 181, 212, 243,
 static const char *daynames[] = {"Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"};
 
 // Forwards
-STATIC bool timerExpiredSecs(uint32_t *timer, uint32_t periodSecs);
-STATIC int ytodays(int year);
+NOTE_C_STATIC bool timerExpiredSecs(uint32_t *timer, uint32_t periodSecs);
+NOTE_C_STATIC int ytodays(int year);
 
 //**************************************************************************/
 /*!
@@ -127,7 +133,7 @@ void NoteTimeRefreshMins(uint32_t mins)
   @param   seconds The UNIX Epoch time.
 */
 /**************************************************************************/
-STATIC void setTime(JTIME seconds)
+NOTE_C_STATIC void setTime(JTIME seconds)
 {
     timeBaseSec = seconds;
     timeBaseSetAtMs = _GetMs();
@@ -444,7 +450,7 @@ bool NoteLocalTimeST(uint16_t *retYear, uint8_t *retMonth, uint8_t *retDay, uint
 }
 
 // Figure out how many days at start of the year
-STATIC int ytodays(int year)
+NOTE_C_STATIC int ytodays(int year)
 {
     int days = 0;
     if (0 < year) {
@@ -1621,7 +1627,7 @@ bool NoteSetContact(char *nameBuf, char *orgBuf, char *roleBuf, char *emailBuf)
 // A simple suppression timer based on a millisecond system clock.  This clock is reset to 0
 // after boot and every wake.  This returns true if the specified interval has elapsed, in seconds,
 // and it updates the timer if it expires so that we will go another period.
-STATIC bool timerExpiredSecs(uint32_t *timer, uint32_t periodSecs)
+NOTE_C_STATIC bool timerExpiredSecs(uint32_t *timer, uint32_t periodSecs)
 {
     bool expired = false;
 

src/note-c/n_hooks.c

@@ -418,6 +418,29 @@ void NoteDebug(const char *line)
 #endif
 }
 
+//**************************************************************************/
+/*!
+  @brief       Write the message to the debug stream, if the level is less than
+               or equal to NOTE_C_LOG_LEVEL_MAX. Otherwise, the message is
+               dropped.
+  @param level The log level of the message. See the NOTE_C_LOG_LEVEL_* macros
+               in note.h for possible values.
+  @param msg   The debug message.
+*/
+/**************************************************************************/
+void NoteDebugWithLevel(uint8_t level, const char *msg)
+{
+#ifndef NOTE_NODEBUG
+
+    if (level > NOTE_C_LOG_LEVEL_MAX) {
+        return;
+    }
+
+    NoteDebug(msg);
+
+#endif // !NOTE_NODEBUG
+}
+
 //**************************************************************************/
 /*!
   @brief  Get the current milliseconds value from the platform-specific

src/note-c/n_ua.c

@@ -109,13 +109,10 @@ __attribute__((weak)) J *NoteUserAgent()
 #define PLUS ""
 #endif
 
-#define STRINGIFY(x) STRINGIFY_(x)
-#define STRINGIFY_(x) #x
-
 #if defined(__ICCARM__)
-    char *compiler = (char *) ("iar arm" PLUS " " STRINGIFY(__VER__));
+    char *compiler = (char *) ("iar arm" PLUS " " NOTE_C_STRINGIZE(__VER__));
 #elif defined(__IAR_SYSTEMS_ICC__)
-    char *compiler = (char *) ("iar" PLUS " " STRINGIFY(__VER__));
+    char *compiler = (char *) ("iar" PLUS " " NOTE_C_STRINGIZE(__VER__));
 #elif defined(__clang__)
     char *compiler = (char *) ("clang" PLUS " " __VERSION__);
 #elif defined(__ATOLLIC__) && defined(__GNUC__)

src/note-c/note.h

@@ -73,15 +73,6 @@
 // originates from the Notecard, which synchronizes the time from both the cell network and GPS.
 typedef unsigned long int JTIME;
 
-// If we're building the tests, STATIC is defined to nothing. This allows the
-// tests to access the static functions in note-c. Among other things, this
-// let's us mock these normally static functions.
-#ifdef TEST
-#define STATIC
-#else
-#define STATIC static
-#endif
-
 // C-callable functions
 #ifdef __cplusplus
 extern "C" {
@@ -169,6 +160,47 @@ void NoteDebug(const char *message);
 void NoteDebugln(const char *message);
 void NoteDebugIntln(const char *message, int n);
 void NoteDebugf(const char *format, ...);
+
+#define NOTE_C_LOG_LEVEL_ERROR  0
+#define NOTE_C_LOG_LEVEL_WARN   1
+#define NOTE_C_LOG_LEVEL_INFO   2
+#define NOTE_C_LOG_LEVEL_DEBUG  3
+
+void NoteDebugWithLevel(uint8_t level, const char *msg);
+
+#define _NOTE_C_STRINGIZE(x) #x
+#define NOTE_C_STRINGIZE(x) _NOTE_C_STRINGIZE(x)
+
+#define NOTE_C_LOG_ERROR(msg) do { \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_ERROR, __FILE__ ":" \
+  NOTE_C_STRINGIZE(__LINE__) " (ERROR) "); \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_ERROR, msg); \
+} while (0);
+
+#define NOTE_C_LOG_WARN(msg) do { \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_WARN, __FILE__ ":" \
+  NOTE_C_STRINGIZE(__LINE__) " (WARN) "); \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_WARN, msg); \
+} while (0);
+
+#define NOTE_C_LOG_INFO(msg) do { \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_INFO, __FILE__ ":" \
+  NOTE_C_STRINGIZE(__LINE__) " (INFO) "); \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_INFO, msg); \
+} while (0);
+
+#define NOTE_C_LOG_DEBUG(msg) do { \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_DEBUG, __FILE__ ":" \
+  NOTE_C_STRINGIZE(__LINE__) " (DEBUG) "); \
+  NoteDebugWithLevel(NOTE_C_LOG_LEVEL_DEBUG, msg); \
+} while (0);
+
+// The max log level for NoteDebugWithLevel is only configurable at
+// compile-time, via NOTE_C_LOG_LEVEL_MAX.
+#ifndef NOTE_C_LOG_LEVEL_MAX
+#define NOTE_C_LOG_LEVEL_MAX NOTE_C_LOG_LEVEL_ERROR
+#endif
+
 void *NoteMalloc(size_t size);
 void NoteFree(void *);
 long unsigned int NoteGetMs(void);
@@ -316,33 +348,24 @@ bool NotePayloadAddSegment(NotePayloadDesc *desc, const char segtype[NP_SEGTYPE_
 bool NotePayloadFindSegment(NotePayloadDesc *desc, const char segtype[NP_SEGTYPE_LEN], void *pdata, uint32_t *plen);
 bool NotePayloadGetSegment(NotePayloadDesc *desc, const char segtype[NP_SEGTYPE_LEN], void *pdata, uint32_t len);
 
-// C macro to convert a number to a string for use below
-#define _tstring(x)     #x
-
 // Hard-wired constants used to specify field types when creating note templates
-#define TBOOL           true                // bool
-#define TINT8           11                  // 1-byte signed integer
-#define TINT16          12                  // 2-byte signed integer
-#define TINT24          13                  // 3-byte signed integer
-#define TINT32          14                  // 4-byte signed integer
-#define TINT64          18                  // 8-byte signed integer (note-c support depends upon platform)
-#define TUINT8          21                  // 1-byte unsigned integer (requires notecard firmware >= build 14444)
-#define TUINT16         22                  // 2-byte unsigned integer (requires notecard firmware >= build 14444)
-#define TUINT24         23                  // 3-byte unsigned integer (requires notecard firmware >= build 14444)
-#define TUINT32         24                  // 4-byte unsigned integer (requires notecard firmware >= build 14444)
-#define TFLOAT16        12.1                // 2-byte IEEE 754 floating point
-#define TFLOAT32        14.1                // 4-byte IEEE 754 floating point (a.k.a. "float")
-#define TFLOAT64        18.1                // 8-byte IEEE 754 floating point (a.k.a. "double")
-#define TSTRING(N)      _tstring(N)         // UTF-8 text of N bytes maximum (fixed-length reserved buffer)
-#define TSTRINGV        _tstring(0)         // variable-length string
+#define TBOOL           true                 // bool
+#define TINT8           11                   // 1-byte signed integer
+#define TINT16          12                   // 2-byte signed integer
+#define TINT24          13                   // 3-byte signed integer
+#define TINT32          14                   // 4-byte signed integer
+#define TINT64          18                   // 8-byte signed integer (note-c support depends upon platform)
+#define TUINT8          21                   // 1-byte unsigned integer (requires notecard firmware >= build 14444)
+#define TUINT16         22                   // 2-byte unsigned integer (requires notecard firmware >= build 14444)
+#define TUINT24         23                   // 3-byte unsigned integer (requires notecard firmware >= build 14444)
+#define TUINT32         24                   // 4-byte unsigned integer (requires notecard firmware >= build 14444)
+#define TFLOAT16        12.1                 // 2-byte IEEE 754 floating point
+#define TFLOAT32        14.1                 // 4-byte IEEE 754 floating point (a.k.a. "float")
+#define TFLOAT64        18.1                 // 8-byte IEEE 754 floating point (a.k.a. "double")
+#define TSTRING(N)      _NOTE_C_STRINGIZE(N) // UTF-8 text of N bytes maximum (fixed-length reserved buffer)
+#define TSTRINGV        _NOTE_C_STRINGIZE(0) // variable-length string
 bool NoteTemplate(const char *notefileID, J *templateBody);
 
-// Make these normally static functions externally visible if building tests.
-#ifdef TEST
-bool timerExpiredSecs(uint32_t *timer, uint32_t periodSecs);
-void setTime(JTIME seconds);
-#endif
-
 // End of C-callable functions
 #ifdef __cplusplus
 }