Merge branch 'master' into feature/nano33sense_rx_example

Author: joextodd

CHANGELOG.md

@@ -2,6 +2,11 @@
 
 Recent changes to the [Chirp Arduino SDK](https://developers.chirp.io/docs).
 
+## v3.3.0 (beta)
+ - Added send-only support for cortex-m0plus (MKRZero, MKR Vidor 4000)
+ - Added support for cortex-m4 (Nano 33 Sense)
+ - Build v3.3.0-rc1
+
 ## v3.2.0 (14/03/2019)
 
  - Build v3.2.9

README.md

@@ -1,17 +1,36 @@
 # Chirp for Arduino
 
-*Version 3.2.5, January 2019*
+*Version 3.3.0, August 2019*
 
 ## Overview
 
 Chirp is a library enabling Arduino-based devices to send and receive data using sound. You'll need:
 
- * An ESP32 development board
+ * A compatible Arduino board
  * A digital I2S MEMS microphone
  * A digital I2S amplifier and compatible speaker
 
-You'll need an ESP32 (or a board with an equivalent processor). For sound input you will need a digital MEMS microphone such as the SPH0645 or ICS-43434. For sound output it is recommended to use a digital I2S output such as the UDA1334A or MAX98357A connected to a compatible speaker, however analogue output is also possible with this board.
-You can quickly test the sound input by playing random chirps from the [Developer Hub](https://developers.chirp.io). The quickest way to test the sound output would be to use Chirp on the [command line](https://developers.chirp.io/docs/tutorials/command-line).
+For sound input you will need a digital MEMS microphone such as the SPH0645 or ICS-43434. (Not necessary for the Nano 33 Sense as it comes with an on board microphone)
+For sound output it is recommended to use a digital I2S output such as the UDA1334A or MAX98357A connected to a compatible speaker.
+
+You can quickly test the sound input by playing random chirps from the [Developer Hub](https://developers.chirp.io).
+The easiest way to test the sound output would be to use Chirp on the [command line](https://developers.chirp.io/docs/tutorials/command-line) to receive data from the Arduino.
+
+## Supported hardware
+
+Send and receive capabilities
+
+ * Arduino Nano 33 Sense
+ * Microsoft MXChip
+ * ESP32
+
+Send only
+
+ * Arduino MKRZero
+ * Arduino Vidor 4000
+ * Genuino Zero
+ * MKR Fox 1200
+ * MKR1000 WiFi
 
 ## Installation
 
@@ -23,45 +42,50 @@ Install ChirpSDK as a library. For instructions, see
 
 Once installed, you can access the example programs from the menu :
 
-```File > Examples > ChirpSDK > example ```
+```File > Examples > ChirpSDK > Example ```
 
-and you can include the headers to use Chirp in your own code by using :
+and you can include the headers to use Chirp in your own code by adding :
 
-```Sketch > Import Library > ChirpSDK```
+```#include "chirp_connect.h"```
 
 ## Usage
 
-To set up the Chirp SDK, initialise and configure with your app key, secret and `arduino` config from the [Developer Hub](https://developers.chirp.io). Then set any required callbacks and start the SDK running.
+To set up the Chirp SDK, initialise and configure with your app key,
+secret and config from the [Developer Hub](https://developers.chirp.io).
+
+*Note* You must select the `arduino` protocol from the dropdown menu, when
+selecting your chirp configuration.
 
-    connect = new_chirp_connect(APP_KEY, APP_SECRET);
-    if (connect == NULL) {
+    chirp = new_chirp_connect(APP_KEY, APP_SECRET);
+    if (chirp == NULL) {
         Serial.println("Chirp initialisation failed.");
         return;
     }
 
-    chirp_connect_error_code_t err = chirp_connect_set_config(connect, APP_CONFIG);
+Then set any required callbacks and start the SDK running.
+
+    chirp_connect_error_code_t err = chirp_connect_set_config(chirp, APP_CONFIG);
     if (err != CHIRP_CONNECT_OK)
         return;
 
     chirp_connect_callback_set_t callbacks = {0};
     callbacks.on_received = onReceivedCallback;
-    err = chirp_connect_set_callbacks(connect, callbacks);
+    err = chirp_connect_set_callbacks(chirp, callbacks);
     if (err != CHIRP_CONNECT_OK)
         return;
 
-    err = chirp_connect_set_callback_ptr(connect, connect);
+    err = chirp_connect_set_callback_ptr(chirp, chirp);
     if (err != CHIRP_CONNECT_OK)
         return;
 
-    // Set input/output sample rates if not 44.1kHz
-    err = chirp_connect_set_input_sample_rate(connect, input_sample_rate);
+    err = chirp_connect_set_input_sample_rate(chirp, input_sample_rate);
     if (err != CHIRP_CONNECT_OK)
         return;
-    err = chirp_connect_set_output_sample_rate(connect, output_sample_rate);
+    err = chirp_connect_set_output_sample_rate(chirp, output_sample_rate);
     if (err != CHIRP_CONNECT_OK)
         return;
 
-    err = chirp_connect_start(connect);
+    err = chirp_connect_start(chirp);
     if (err != CHIRP_CONNECT_OK)
         return;
 
@@ -70,9 +94,9 @@ To set up the Chirp SDK, initialise and configure with your app key, secret and
 The received data is passed back to the `onReceivedCallback` function. If the payload pointer is null then there has been an error decoding the data.
 
     void
-    onReceivedCallback(void *connect, uint8_t *payload, size_t length, uint8_t channel) {
+    onReceivedCallback(void *chirp, uint8_t *payload, size_t length, uint8_t channel) {
         if (payload) {
-            char *hexString = chirp_connect_as_string(connect, payload, length);
+            char *hexString = chirp_connect_as_string(chirp, payload, length);
             Serial.printf("Received data = %s\n", hexString);
             chirp_connect_free(hexString);
         } else {
@@ -110,7 +134,7 @@ A complete list of callbacks is shown below.
         .on_receiving = on_receiving_callback,
         .on_received = on_received_callback
     };
-    err = chirp_connect_set_callbacks(connect, callbacks_set);
+    err = chirp_connect_set_callbacks(chirp, callbacks_set);
     if (err != CHIRP_CONNECT_OK)
     {
         const char *error_string = chirp_connect_error_code_to_string(err);
@@ -122,30 +146,31 @@ A complete list of callbacks is shown below.
 
 A Chirp payload is simply an array of bytes. You can send a random data payload to the speakers like so.
 
-    size_t payload_length = chirp_connect_get_max_payload_length(connect);
-    uint8_t *payload = chirp_connect_random_payload(connect, &payload_length);
+    size_t payload_length = chirp_connect_get_max_payload_length(chirp);
+    uint8_t *payload = chirp_connect_random_payload(chirp, &payload_length);
 
-    err = chirp_connect_send(chirp_connect, payload, payload_length);
+    err = chirp_connect_send(chirp, payload, payload_length);
     if (err != CHIRP_CONNECT_OK) {
-        const char *error_string = chirp_connect_error_code_to_string(error_code);
+        const char *error_string = chirp_connect_error_code_to_string(err);
         printf("%s\n", error_string);
     }
 
+Or you can easily send an ASCII string
+
+    char *identifier = "hello";
+    err = chirp_connect_send(chirp, (uint8_t *)identifier, strlen(identifier));
+    if (err != CHIRP_CONNECT_OK) {
+        const char *error_string = chirp_connect_error_code_to_string(err);
+        printf("%s\n", error_string);
+    }
 
 ## Processing
 
 To process audio data from the microphone, and fill the output buffer with audio data, call the following functions with data periodically.
 
-    err = chirp_connect_process_input(chirp_connect, input_buffer, input_buffer_length);
-
-    err = chirp_connect_process_output(chirp_connect, output_buffer, output_buffer_length);
-
-
-## Example
-
-Once ChirpSDK is installed as a library an example is supplied in the IDE menu ```File > Examples > ChirpSDK > Example```.
+    err = chirp_connect_process_input(chirp, input_buffer, input_buffer_length);
 
-This example script demonstrates how to receive data using the SPH0645 microphone.
+    err = chirp_connect_process_output(chirp, output_buffer, output_buffer_length);
 
 ***