Move clock and data defs into variant files. Change begin to use globals by default.

Author: Nathan Seidle

libraries/PDM/examples/Example1_MicrophoneOutput/Example1_MicrophoneOutput.ino

@@ -2,13 +2,15 @@
   Created: July 24, 2019
   License: MIT. See SparkFun Arduino Apollo3 Project for more information
 
-  This example demonstrates how to use the PDM microphone on Artemis boards.
+  This example demonstrates how to use the pulse density microphone (PDM) on Artemis boards.
   This library and example are heavily based on the Apollo3 pdm_fft example.
 */
 
-//Global variables needed for this sketch
+//Global variables needed for PDM library
 #define pdmDataBufferSize 4096 //Default is array of 4096 * 32bit
 uint32_t pdmDataBuffer[pdmDataBufferSize];
+
+//Global variables needed for the FFT in this sketch
 float g_fPDMTimeDomain[pdmDataBufferSize * 2];
 float g_fPDMFrequencyDomain[pdmDataBufferSize * 2];
 float g_fPDMMagnitudes[pdmDataBufferSize * 2];
@@ -30,19 +32,13 @@ void setup()
   Serial.begin(9600);
   Serial.println("SparkFun PDM Example");
 
-  // Turn on the PDM, set it up for our chosen recording settings
-  if (myPDM.begin(22, 23) == false) //Data, clock - These are the pin names from variant file, not pad names
+  if (myPDM.begin() == false) // Turn on PDM with default settings
   {
     Serial.println("PDM Init failed. Are you sure these pins are PDM capable?");
     while (1);
   }
   Serial.println("PDM Initialized");
 
-  //myPDM.setClockSpeed(AM_HAL_PDM_CLK_3MHZ);
-  //myPDM.setClockDivider(AM_HAL_PDM_MCLKDIV_1);
-  //myPDM.setGain(AM_HAL_PDM_GAIN_P210DB);
-  //myPDM.setChannel(AM_HAL_PDM_CHANNEL_STEREO);
-
   printPDMConfig();
 
   myPDM.getData(pdmDataBuffer, pdmDataBufferSize); //This clears the current PDM FIFO and starts DMA

libraries/PDM/examples/Example2_ConfigureMic/Example2_ConfigureMic.ino

@@ -5,9 +5,11 @@
   This example shows how to modify the various PDM interface settings.
 */
 
-//Global variables needed for this sketch
+//Global variables needed for PDM library
 #define pdmDataBufferSize 4096 //Default is array of 4096 * 32bit
 uint32_t pdmDataBuffer[pdmDataBufferSize];
+
+//Global variables needed for the FFT in this sketch
 float g_fPDMTimeDomain[pdmDataBufferSize * 2];
 float g_fPDMFrequencyDomain[pdmDataBufferSize * 2];
 float g_fPDMMagnitudes[pdmDataBufferSize * 2];
@@ -29,20 +31,26 @@ void setup()
   Serial.begin(9600);
   Serial.println("SparkFun PDM Example");
 
-  // Turn on the PDM, set it up for our chosen recording settings.
-  if (myPDM.begin(22, 23) == false) //Data, clock - These are the pin names from variant file, not pad names
+  // The variant files for Artemis carrier boards have Mic data and clock pins defined
+  // but these pins can be passed to the the .begin function
+  //if (myPDM.begin() == false) //Use Data, clock defines from variant file
+  if (myPDM.begin(22, 23) == false) //Data, clock on Artemis Nano - These are the pin names from variant file, not pad names
   {
     Serial.println("PDM Init failed. Are you sure these pins are PDM capable?");
     while (1);
   }
   Serial.println("PDM Initialized");
 
-  //For more settings see the 
+  //Note: The following settings will modifying the settings from default
+  //and therefore the loudest freq will be 1/2 of what is really happening
+  //For more AM_HAL_... defines see the am_hal_pdm.h file in the core (/mcu/apollo3/hal/)
   myPDM.setClockSpeed(AM_HAL_PDM_CLK_3MHZ);
   myPDM.setClockDivider(AM_HAL_PDM_MCLKDIV_1);
   myPDM.setGain(AM_HAL_PDM_GAIN_P210DB);
   myPDM.setChannel(AM_HAL_PDM_CHANNEL_STEREO);
 
+  //The equivalent getGain(), getClockSpeed(), etc are available
+
   printPDMConfig();
 
   myPDM.getData(pdmDataBuffer, pdmDataBufferSize); //This clears the current PDM FIFO and starts DMA

libraries/PDM/examples/Example3_FullConfigure/Example3_FullConfigure.ino

@@ -7,9 +7,11 @@
   that you can access all settings in one step.
 */
 
-//Global variables needed for this sketch
+//Global variables needed for PDM library
 #define pdmDataBufferSize 4096 //Default is array of 4096 * 32bit
 uint32_t pdmDataBuffer[pdmDataBufferSize];
+
+//Global variables needed for the FFT in this sketch
 float g_fPDMTimeDomain[pdmDataBufferSize * 2];
 float g_fPDMFrequencyDomain[pdmDataBufferSize * 2];
 float g_fPDMMagnitudes[pdmDataBufferSize * 2];
@@ -51,8 +53,8 @@ void setup()
   Serial.begin(9600);
   Serial.println("SparkFun PDM Example");
 
-  // Turn on the PDM, set it up for our chosen recording settings
-  if (myPDM.begin(22, 23) == false) //Data, clock - These are the pin names from variant file, not pad names
+  // Turn on the PDM with default settings
+  if (myPDM.begin() == false) //Use Data, clock defines from variant file
   {
     Serial.println("PDM Init failed. Are you sure these pins are PDM capable?");
     while (1);

libraries/PDM/src/PDM.h

@@ -85,7 +85,7 @@ const am_hal_pdm_config_t ap3_pdm_config_default = {
 class AP3_PDM
 {
 public:
-    bool begin(ap3_gpio_pin_t pinPDMData, ap3_gpio_pin_t pinPDMClock);
+    bool begin(ap3_gpio_pin_t pinPDMData = MIC_DATA, ap3_gpio_pin_t pinPDMClock = MIC_CLOCK);
     bool available(void); //Goes true once an interrupt has occured
 
     bool setClockSpeed(am_hal_pdm_clkspd_e clockSpeed);

variants/SparkFun_Artemis/config/variant.h

@@ -163,4 +163,9 @@ extern Uart Serial;
 // Many Arduino cores provide a built-in LED for quick verification, like in the Blink sketch
 #define LED_BUILTIN 13
 
+// Artemis has a variety of PDM capable pins. These defines can be modified, even excluded
+// and declared during myPDM.begin(pdm_data, pdm_clock)
+#define MIC_DATA 36
+#define MIC_CLOCK 37
+
 #endif // _AP3_VARIANT_H_

variants/SparkFun_BlackBoard_Artemis/config/variant.h

@@ -75,4 +75,7 @@ extern Uart Serial1;
 #define TX1 1
 #define RX1 0
 
+#define MIC_DATA 30
+#define MIC_CLOCK 31
+
 #endif // _AP3_VARIANT_H_

variants/SparkFun_BlackBoard_Artemis_ATP/config/variant.h

@@ -75,4 +75,7 @@ extern Uart Serial1;
 #define TX1 24
 #define RX1 25
 
+#define MIC_DATA 36
+#define MIC_CLOCK 37
+
 #endif // _AP3_VARIANT_H_

variants/SparkFun_BlackBoard_Artemis_Nano/config/variant.h

@@ -74,4 +74,7 @@ extern Uart Serial1;
 #define TX1 9
 #define RX1 10
 
+#define MIC_DATA 22
+#define MIC_CLOCK 23
+
 #endif // _AP3_VARIANT_H_