Merge pull request #11 from chirp/feature/send-messages-not-random

Send ascii messages instead of random chirps

Author: Damien Laidin

CHANGELOG.md

@@ -2,12 +2,12 @@
 
 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)
+## v3.3.0 (09/08/2019)
  - Added support for cortex-m4 (Nano 33 Sense)
+ - Added send-only support for cortex-m0plus (MKRZero, MKR Vidor 4000)
  - Build v3.3.0-rc1
 
-## v3.2.0 (14/03/2019)
+## v3.2.0 (14/03/2019)
 
  - Build v3.2.9
  - Optimised DSP for ESP32

README.md

@@ -53,7 +53,7 @@ and you can include the headers to use Chirp in your own code by adding :
 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
+*Note* You must select the `16khz-mono-embedded` protocol from the dropdown menu, when
 selecting your chirp configuration.
 
     chirp = new_chirp_connect(APP_KEY, APP_SECRET);

examples/ESP32Receive/ESP32Receive.ino

@@ -5,8 +5,8 @@
     @file ESP32Receive.ino
 
     @brief Create a developer account at https://developers.chirp.io,
-    and copy and paste your key, secret and config string for the "16khz-mono"
-    protocol into the credentials.h file.
+    and copy and paste your key, secret and config string for the
+    "16khz-mono-embedded" protocol into the credentials.h file.
 
     This example will start listening for chirps and print to the terminal
     when anything is received.
@@ -43,11 +43,13 @@
 #define CONVERT_INPUT(sample) (((int32_t)(sample) >> 14) + MIC_CALIBRATION)
 
 // Global variables ------------------------------------------------------------
+
 static chirp_connect_t *chirp = NULL;
 static chirp_connect_state_t currentState = CHIRP_CONNECT_STATE_NOT_CREATED;
 static bool startTasks = false;
 
 // Function definitions --------------------------------------------------------
+
 void setupChirp();
 void chirpErrorHandler(chirp_connect_error_code_t code);
 void setupAudioInput(int sample_rate);
@@ -137,10 +139,11 @@ void
 onReceivedCallback(void *chirp, uint8_t *payload, size_t length, uint8_t channel)
 {
   if (payload) {
-    char *data = chirp_connect_as_string((chirp_connect_t *)chirp, payload, length);
-    Serial.printf("data = %s\n", data);
-    digitalWrite(LED_PIN, LOW);
-    chirp_connect_free(data);
+    char *data = (char *)calloc(length + 1, sizeof(uint8_t));
+    memcpy(data, payload, length * sizeof(uint8_t));
+    Serial.print("Received data: ");
+    Serial.println(data);
+    free(data);
   } else {
     Serial.println("Decode failed.");
   }

examples/ESP32Send/ESP32Send.ino

@@ -5,8 +5,8 @@
     @file ESP32Send.ino
 
     @brief Create a developer account at https://developers.chirp.io,
-    and copy and paste your key, secret and config string for the "arduino"
-    protocol into the credentials.h file.
+    and copy and paste your key, secret and config string for the
+    "16khz-mono-embedded" protocol into the credentials.h file.
 
     When the EN switch is pressed on the board, a random chirp will be sent to
     the audio output.
@@ -30,16 +30,19 @@
 #define LED_PIN           2      // LED
 #define SWITCH_PIN        0      // Switch
 
+#define VOLUME            0.5    // Between 0 and 1
 #define BUFFER_SIZE       512
 #define SAMPLE_RATE       16000
 
 // Global variables ------------------------------------------------------------
+
 static chirp_connect_t *chirp = NULL;
 static chirp_connect_state_t currentState = CHIRP_CONNECT_STATE_NOT_CREATED;
 static volatile bool buttonPressed = false;
 static bool startTasks = false;
 
 // Function definitions --------------------------------------------------------
+
 void IRAM_ATTR handleInterrupt();
 void setupChirp();
 void chirpErrorHandler(chirp_connect_error_code_t code);
@@ -73,12 +76,12 @@ loop()
   }
 
   if (buttonPressed) {
-    size_t payloadLength = 0;
-    uint8_t *payload = chirp_connect_random_payload(chirp, &payloadLength);
-    chirp_connect_send(chirp, payload, payloadLength);
-    Serial.println("Sending data...");
+    char *payload = "hello";
+    chirpError = chirp_connect_send(chirp, (uint8_t *)payload, strlen(payload));
+    chirpErrorHandler(chirpError);
+    Serial.print("Sending data: ");
+    Serial.println(payload);
     buttonPressed = false;
-    chirp_connect_free(payload);
   }
 }
 
@@ -176,8 +179,8 @@ setupChirp()
   err = chirp_connect_start(chirp);
   chirpErrorHandler(err);
 
-  // Set volume to 0.5 to not distort output
-  chirp_connect_set_volume(chirp, 0.5);
+  err = chirp_connect_set_volume(chirp, VOLUME);
+  chirpErrorHandler(err);
 
   Serial.println("Chirp SDK initialised.");
 }

examples/MKRZeroSend/MKRZeroSend.ino

@@ -5,8 +5,8 @@
     @file MKRZeroSend.ino
 
     @brief Create a developer account at https://developers.chirp.io,
-    and copy and paste your key, secret and config string for chosen
-    protocol into the credentials.h file.
+    and copy and paste your key, secret and config string for the
+    "16khz-mono-embedded" protocol into the credentials.h file.
 
     This example will start sending a random chirp payload on start up.
 
@@ -18,6 +18,9 @@
     *Note*: This board is send-only, so cannot be configured to receive
     data due to the minimal memory available on the board
 
+    *Important*: The example will not start until this Serial Monitor is opened.
+    To disable this behaviour, comment out the while(!Serial) line.
+
     Circuit:
       - Arduino MKRZero
       - Adafruit UDA1334
@@ -38,13 +41,13 @@
 #include "chirp_connect.h"
 #include "credentials.h"
 
-#define VOLUME            12000
+#define VOLUME            0.5  // Between 0 and 1
 
 #define NUM_BUFFERS       2
-#define BUFFER_SIZE       256
+#define BUFFER_SIZE       1024
 #define SAMPLE_RATE       44100
 
-// Global variables -------------------------------------------
+// Global variables ------------------------------------------------------------
 
 int buffer[NUM_BUFFERS][BUFFER_SIZE];
 short tmpBuffer[BUFFER_SIZE / 2];
@@ -57,14 +60,15 @@ DmacDescriptor  *desc;
 static chirp_connect_t *chirp = NULL;
 static volatile bool dma_complete = true;
 
-// Function definitions ---------------------------------------
+// Function definitions --------------------------------------------------------
 
 void dmaCallback(Adafruit_ZeroDMA *dma);
 void dmaErrorCallback(Adafruit_ZeroDMA *dma);
 void setupDMA(void);
 void setupChirp(void);
+void sendChirp(void);
 
-// Function declarations --------------------------------------
+// Function declarations -------------------------------------------------------
 
 void setup()
 {
@@ -80,16 +84,7 @@ void setup()
   i2s.enableMCLK();
   i2s.enableTx();
 
-  size_t payload_len = 5;
-  uint8_t *payload = chirp_connect_random_payload(chirp, &payload_len);
-
-  char *hex = chirp_connect_as_string(chirp, payload, payload_len);
-  Serial.print("Generated payload: ");
-  Serial.println(hex);
-  chirp_connect_free(hex);
-
-  chirp_connect_error_code_t err = chirp_connect_send(chirp, payload, payload_len);
-  chirpErrorHandler(err);
+  sendChirp();
 
   ZeroDMAstatus stat = dma.startJob();
   if (stat != DMA_STATUS_OK)
@@ -110,7 +105,7 @@ void loop()
 
     // Copy the data into a stereo buffer for audio output
     for (int i = 0; i < BUFFER_SIZE / 2; i++) {
-      int value = tmpBuffer[i] * VOLUME;
+      int value = tmpBuffer[i] * INT16_MAX;
       buffer[next][i * 2] = value;
       buffer[next][i * 2 + 1] = value;
     }
@@ -119,7 +114,7 @@ void loop()
   }
 }
 
-// Chirp -----------------------------------------------------
+// Chirp -----------------------------------------------------------------------
 
 void chirpErrorHandler(chirp_connect_error_code_t code)
 {
@@ -141,7 +136,19 @@ void onSentCallback(void *chirp, uint8_t *payload, size_t length, uint8_t channe
   Serial.println("Sent data...");
 }
 
-void setupChirp(void)
+void sendChirp()
+{
+  chirp_connect_error_code_t err;
+
+  char *payload = "hello";
+  err = chirp_connect_send(chirp, (uint8_t *)payload, strlen(payload));
+  chirpErrorHandler(err);
+
+  Serial.print("Sending data: ");
+  Serial.println(payload);
+}
+
+void setupChirp()
 {
   chirp = new_chirp_connect(CHIRP_APP_KEY, CHIRP_APP_SECRET);
   if (chirp == NULL)
@@ -167,14 +174,17 @@ void setupChirp(void)
   err = chirp_connect_set_output_sample_rate(chirp, SAMPLE_RATE);
   chirpErrorHandler(err);
 
+  err = chirp_connect_set_volume(chirp, VOLUME);
+  chirpErrorHandler(err);
+
   err = chirp_connect_start(chirp);
   chirpErrorHandler(err);
 
   Serial.println("Chirp SDK initialised.");
   Serial.flush();
 }
 
-// I2S DMA ---------------------------------------------------
+// I2S DMA ---------------------------------------------------------------------
 
 void dmaCallback(Adafruit_ZeroDMA *dma)
 {

examples/MXChipSendReceive/MXChipSendReceive.ino

@@ -5,7 +5,7 @@
  *  @file MXChipSendReceive.ino
  *
  *  @brief After creating a developer account on https://developers.chirp.io, get
- *  your key, secret and config string from your account using the "16kHz-mono"
+ *  your key, secret and config string from your account using the "16kHz-mono-embedded"
  *  protocol, and set them in this file (in CHIRP_APP_KEY, CHIRP_APP_SECRET, CHIRP_APP_CONFIG).
  *
  *  This example will start in listening mode. The listening and playing modes

examples/Nano33SenseReceive/Nano33SenseReceive.ino

@@ -5,15 +5,18 @@
     @file Nano33SenseReceive.ino
 
     @brief Create a developer account at https://developers.chirp.io,
-    and copy and paste your key, secret and config string for the "arduino"
-    protocol into the credentials.h file.
+    and copy and paste your key, secret and config string for the
+    "16khz-mono-embedded" protocol into the credentials.h file.
 
     This example will start listening for chirps and print to the terminal
     when anything is received.
 
-    Note: this example can be used in conjunction with the send example,
+    *Note*: this example can be used in conjunction with the send example,
     to send and receive data in the same application.
 
+    *Important*: The example will not start until this Serial Monitor is opened.
+    To disable this behaviour, comment out the while(!Serial) line.
+
     Circuit:
       - Arduino Nano 33 BLE board
 

examples/Nano33SenseSend/Nano33SenseSend.ino

@@ -6,12 +6,15 @@
     @file Nano33SenseSend.ino
 
     @brief Create a developer account at https://developers.chirp.io,
-    and copy and paste your key, secret and config string for the "arduino"
-    protocol into the credentials.h file.
+    and copy and paste your key, secret and config string for the
+    "16khz-mono-embedded" protocol into the credentials.h file.
 
     This example will start listening for chirps and print to the terminal
     when anything is received.
 
+    *Important*: The example will not start until this Serial Monitor is opened.
+    To disable this behaviour, comment out the while(!Serial) line.
+
     Circuit:
       - Arduino Nano 33 BLE board
       - Adafruit MAX98357A amplifier
@@ -24,11 +27,12 @@
 #include "chirp_connect.h"
 #include "credentials.h"
 
+#define VOLUME                 0.3  // Between 0 and 1
 #define BUFFER_SIZE            256
 #define OUTPUT_SAMPLE_RATE     16667
 
-#define I2S_SCK_PIN            23  // D7
-#define I2S_DATA_PIN           21  // D8
+#define I2S_DATA_PIN           23  // D7
+#define I2S_SCK_PIN            21  // D8
 #define I2S_LRCK_PIN           27  // D9
 
 // Global variables ------------------------------------------------------------
@@ -42,6 +46,7 @@ short buffer_two[BUFFER_SIZE];
 
 void chirpErrorHandler(chirp_connect_error_code_t code);
 void setupChirp(void);
+void sendChirp(void);
 void i2s_init(void);
 void i2s_start(void);
 
@@ -53,7 +58,7 @@ void setup()
   while(!Serial);  // Wait for Serial monitor before continuing
 
   setupChirp();
-  sendRandomChirp();
+  sendChirp();
 
   i2s_init();
   i2s_start();
@@ -123,7 +128,7 @@ void setupChirp(void)
   err = chirp_connect_set_output_sample_rate(chirp, OUTPUT_SAMPLE_RATE);
   chirpErrorHandler(err);
 
-  err = chirp_connect_set_volume(chirp, 0.5);
+  err = chirp_connect_set_volume(chirp, VOLUME);
   chirpErrorHandler(err);
 
   err = chirp_connect_start(chirp);
@@ -133,19 +138,16 @@ void setupChirp(void)
   Serial.flush();
 }
 
-void sendRandomChirp()
+void sendChirp()
 {
-  size_t payload_len = 5;
-  uint8_t *payload = chirp_connect_random_payload(chirp, &payload_len);
-
-  char *hex = chirp_connect_as_string(chirp, payload, payload_len);
-  Serial.print("Generated payload: ");
-  Serial.println(hex);
+  chirp_connect_error_code_t err;
 
-  chirp_connect_error_code_t err = chirp_connect_send(chirp, payload, payload_len);
+  char *payload = "hello";
+  err = chirp_connect_send(chirp, (uint8_t *)payload, strlen(payload));
   chirpErrorHandler(err);
 
-  chirp_connect_free(payload);
+  Serial.print("Sending data: ");
+  Serial.println(payload);
 }
 
 // I2S Audio -------------------------------------------------------------------

keywords.txt

@@ -38,7 +38,7 @@ chirp_connect_get_output_sample_rate	KEYWORD2
 chirp_connect_set_input_sample_rate		KEYWORD2
 chirp_connect_set_output_sample_rate	KEYWORD2
 chirp_connect_get_auto_mute				KEYWORD2
-chirp_connect_set_auto_mute				KEYWORD2
+chirp_connect_set_listen_to_self		KEYWORD2
 chirp_connect_set_callback_ptr			KEYWORD2
 chirp_connect_set_frequency_correction	KEYWORD2
 chirp_connect_get_version				KEYWORD2