rename Pins.h

Author: pschatzmann

Doxyfile

@@ -865,7 +865,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = README.md src examples docs/ext 
+INPUT                  = README.md src  
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses

License.txt

@@ -3,8 +3,8 @@ version=0.0.1
 author=Phil Schatzmann
 maintainer=Phil Schatzmann
 sentence=Audio Codecs
-paragraph=Arduino Library providing many Audio Codecs
+paragraph=Arduino Library which is providing many Audio Codecs
 category=Signal Input/Output
-url=https://github.com/pschatzmann/audio-driver
+url=https://github.com/pschatzmann/arduino-audio-driver
 architectures=*
 depends=

library.properties

@@ -1,12 +1,9 @@
 #pragma once
 #include "Driver.h"
-#include "Pins.h"
+#include "DriverPins.h"
 
 namespace audio_driver {
 
-/// @ingroup audio_driver @brief Pins need to be set up in the sketch
-static DriverPins NoPins;
-
 /**
  * @brief Defitintion for audio board pins and an audio driver
  * @ingroup audio_driver
@@ -48,34 +45,6 @@ class AudioBoard {
   AudioDriver* driver = nullptr;
 };
 
-// -- Drivers
-/// @ingroup audio_driver
-static AudioDriverES8388Class AudioDriverES8388;
-/// @ingroup audio_driver
-static AudioDriverAC101Class AudioDriverAC101;
-/// @ingroup audio_driver
-static AudioDriverCS43l22Class AudioDriverCS43l22;
-/// @ingroup audio_driver
-static AudioDriverES8311Class AudioDriverES8311;
-/// @ingroup audio_driver
-static AudioDriverES7243Class AudioDriverES7243;
-/// @ingroup audio_driver
-static AudioDriverLyratMiniClass AudioDriverLyratMini;
-
-// -- Pins 
-/// @ingroup audio_driver
-static PinsLyrat43Class PinsLyrat43;
-/// @ingroup audio_driver
-static PinsLyrat42Class PinsLyrat42;
-/// @ingroup audio_driver
-static PinsLyratMiniClass PinsLyratMini;
-/// @ingroup audio_driver
-static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1;
-/// @ingroup audio_driver
-static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2;
-/// @ingroup audio_driver
-static PinsAudioKitAC101Class PinsAudioKitAC101;
-
 // -- Boards
 /// @ingroup audio_driver
 static AudioBoard AudioKitEs8388V1{&AudioDriverES8388, PinsAudioKitEs8388v1};
@@ -90,4 +59,5 @@ static AudioBoard LyratV42{&AudioDriverES8388, PinsLyrat42};
 /// @ingroup audio_driver
 static AudioBoard LyratMini{&AudioDriverLyratMini, PinsLyratMini};
 
+
 }

src/AudioBoard.h

@@ -6,7 +6,7 @@
 #include "Driver/es7243/es7243.h"
 #include "Driver/es8311/es8311.h"
 #include "Driver/es8388/es8388.h"
-#include "Pins.h"
+#include "DriverPins.h"
 
 namespace audio_driver {
 
@@ -390,4 +390,20 @@ class AudioDriverCS43l22Class : public AudioDriver {
   }
 };
 
+// -- Drivers
+/// @ingroup audio_driver
+static AudioDriverES8388Class AudioDriverES8388;
+/// @ingroup audio_driver
+static AudioDriverAC101Class AudioDriverAC101;
+/// @ingroup audio_driver
+static AudioDriverCS43l22Class AudioDriverCS43l22;
+/// @ingroup audio_driver
+static AudioDriverES8311Class AudioDriverES8311;
+/// @ingroup audio_driver
+static AudioDriverES7243Class AudioDriverES7243;
+/// @ingroup audio_driver
+static AudioDriverLyratMiniClass AudioDriverLyratMini;
+
+
+
 } // namespace audio_driver

src/Driver.h

@@ -517,4 +517,25 @@ class PinsSTM32F411DiscoClass : public DriverPins {
 
 #endif
 
+
+// -- Pins 
+/**
+ * @brief Pins need to be set up in the sketch
+ * @ingroup audio_driver 
+ */
+static DriverPins NoPins;
+/// @ingroup audio_driver
+static PinsLyrat43Class PinsLyrat43;
+/// @ingroup audio_driver
+static PinsLyrat42Class PinsLyrat42;
+/// @ingroup audio_driver
+static PinsLyratMiniClass PinsLyratMini;
+/// @ingroup audio_driver
+static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1;
+/// @ingroup audio_driver
+static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2;
+/// @ingroup audio_driver
+static PinsAudioKitAC101Class PinsAudioKitAC101;
+
+
 } // namespace audio_driver