Skip to content

Commit 85f70db

Browse files
committed
add ref to README.md to examples
1 parent 261772d commit 85f70db

File tree

8 files changed

+65
-5
lines changed

8 files changed

+65
-5
lines changed

examples/adc-a2dp/adc-a2dp.ino

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* @file adc-a2dp.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/adc-a2dp/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*
9+
*/
110
#include "Arduino.h"
211
#include "BluetoothA2DPSource.h"
312
#include "AudioTools.h"

examples/adc-serial/adc-serial.ino

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* @file adc-serial.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/adc-serial/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*/
9+
110
#include "Arduino.h"
211
#include "BluetoothA2DPSource.h"
312
#include "AudioTools.h"

examples/file_mp3-a2dp/file_mp3-a2dp.ino

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* @file file_mp3-a2dp.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/file_mp3-a2dp/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*/
9+
110
#include <SPI.h>
211
#include <SD.h>
312
#include "AudioFileSourceSD.h"

examples/file_raw-a2dp/file_raw-a2dp.ino

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,11 @@
1+
/**
2+
* @file file_raw-a2dp.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/file_raw-a2dp/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*/
19

210
#include "BluetoothA2DPSource.h"
311
#include <SPI.h>

examples/file_raw-serial/file_raw-serial.ino

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* @file file_raw-serial.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/file_raw-serial/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*/
9+
110
#include <Arduino.h>
211
#include <SPI.h>
312
#include <SD.h>

examples/i2s-a2dp/i2s-a2dp.ino

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
1+
/**
2+
* @file i2s-a2dp.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/i2s-a2dp/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*/
9+
10+
111
#include "Arduino.h"
212
#include "AudioTools.h"
313

414
using namespace audio_tools;
515

6-
/**
7-
* @brief We use a ADS1015 I2S microphone as input and send the data to A2DP
8-
* Unfortunatly the data type from the microphone (int32_t) does not match with the required data type by A2DP (int16_t),
9-
* so we need to convert.
10-
*/
1116

1217
BluetoothA2DPSource a2dp_source;
1318
I2S<int32_t> i2s;

examples/i2s-serial/i2s-serial.ino

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,12 @@
1+
/**
2+
* @file i2s-serial.ino
3+
* @author Phil Schatzmann
4+
* @brief see https://github.com/pschatzmann/arduino-audio-tools/blob/main/examples/i2s-serial/README.md
5+
*
6+
* @author Phil Schatzmann
7+
* @copyright GPLv3
8+
*/
9+
110
#include "Arduino.h"
211
#include "AudioTools.h"
312
#include "BluetoothA2DPSource.h"

src/AudioOutputWithCallback.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,8 @@ namespace audio_tools {
1010
/**
1111
* @brief ESP8266Audio AudioOutput class which stores the data in a temporary buffer.
1212
* The buffer can be consumed e.g. by a callback function by calling read();
13+
* @author Phil Schatzmann
14+
* @copyright GPLv3
1315
*/
1416
class AudioOutputWithCallback : public AudioOutput
1517
{

0 commit comments

Comments
 (0)