updated changelog and release files

chirp · Sep 18, 2019 · 8dd4731 · 8dd4731
1 parent 45caf1d
commit 8dd4731
Show file tree

Hide file tree

Showing 5 changed files with 14 additions and 2 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 Recent changes to the [Chirp Arduino SDK](https://developers.chirp.io/docs).
 
-## v3.4.0 (beta)
+## v3.4.0 (18/09/2019)
  - All functions have been renamed to `chirp_sdk*` from `chirp_connect*`
  - `chirp_sdk_get_heap_usage` has been added. This gives you the current dynamic memory allocated and used at any time by the SDK.
  - `chirp_connect_pause` has been removed.

diff --git a/src/chirp_sdk.h b/src/chirp_sdk.h
@@ -68,7 +68,19 @@ PUBLIC_SYM chirp_sdk_t *new_chirp_sdk(const char *key, const char *secret);
 PUBLIC_SYM chirp_sdk_error_code_t del_chirp_sdk(chirp_sdk_t **sdk);
 
 /**
- * Free some memory previously allocated and returned by the SDK.
+ * Free memory previously allocated and returned by the SDK.
+ *
+ * Note that this does not free the SDK itself. For this, use `del_chirp_sdk`
+ * above.
+ *
+ * This function should be called to free the memory returned by the
+ * following functions:
+ *
+ *   `chirp_sdk_get_info`
+ *   `chirp_sdk_random_payload`
+ *
+ * As well as freeing the memory, this function tracks the ongoing heap
+ * allocation which can be queried with `chirp_sdk_get_heap_usage`.
  *
  * @param ptr The pointer to the memory to be freed.
  */

diff --git a/src/cortex-m0plus/libChirpSDK.a b/src/cortex-m0plus/libChirpSDK.a
diff --git a/src/cortex-m4/libChirpSDK.a b/src/cortex-m4/libChirpSDK.a
diff --git a/src/esp32/libChirpSDK.a b/src/esp32/libChirpSDK.a