Custom Board Code on LyraT #13

lufa07 · 2024-02-28T14:16:30Z

lufa07
Feb 28, 2024

The selected scenario/sketch: audiotools-custom-max.ino
what exactly I am trying to do: Trying to make this code work on standard LyraT board. I am doing this as part of I2S FW bring up for my custom design board. If this works, I will modify the pins according to my design and try to reproduce it on the custom PCB
Hardware: Currently working on LyraT but later on move to custom designed board
Software versions: Arduino IDE 2.3.0, audio drivers updated today
Problem: audiotools-custom-max.ino sketch on LyraT with its pin definitions explicitly defined to mimick the FW to be later on ported to a custom board.

Please let me know if audiotools-custom-max.ino sketch could be mimicked to work with LyraT

Feb 29, 2024

That was an interesting one!
I changed to pass the pins by reference and now my proposed sketch from above is working.
Just update this library...

16:31:11.038 -> Setup starting...
16:31:11.038 -> I2C pin ...
16:31:11.038 -> I2S pin ...
16:31:11.038 -> I2S begin ...
16:31:11.038 -> Debug: AudioBoard::pins::begin
16:31:11.038 -> Debug: DriverPins::begin
16:31:11.046 -> Debug: DriverPins::begin::setupPinMode
16:31:11.046 -> Debug: DriverPins::begin::SPI
16:31:11.046 -> Debug: DriverPins::begin::I2C
16:31:11.046 -> Debug: DriverPins::begin::I2C port:32
16:31:11.046 -> Debug: PinsI2C::begin for 7
16:31:11.046 -> Info: setting up I2C scl: 32, sda: 33
16:31:11.047 -> Info: Setting i2c clock: 10…

View full answer

pschatzmann · 2024-02-28T14:34:43Z

pschatzmann
Feb 28, 2024
Maintainer

Sure, this is very flexible, just adjust the pin definitions. By the way the following Lyrat boards are already predefined

LyratV43{AudioDriverES8388, PinsLyrat43};
LyratV42{AudioDriverES8388, PinsLyrat42};

e.g.PinsLyrat42Class is

class PinsLyrat42Class : public DriverPins {
 public:
  PinsLyrat42Class() {
    // sd pins
    addSPI(ESP32PinsSD);
    // add i2c codec pins: scl, sda, port, frequency
    addI2C(PinFunction::CODEC, 23, 18);
    // add i2s pins: mclk, bck, ws,data_out, data_in ,(port)
    addI2S(PinFunction::CODEC, 0, 5, 25, 26, 35);

    // add other pins
    addPin(PinFunction::KEY, 36, PinLogic::InputActiveLow, 1);
    addPin(PinFunction::KEY, 39, PinLogic::InputActiveLow, 2);
    addPin(PinFunction::KEY, 33, PinLogic::InputActiveLow, 3);
    addPin(PinFunction::KEY, 32, PinLogic::InputActiveLow, 4);
    addPin(PinFunction::KEY, 13, PinLogic::InputActiveLow, 5);
    addPin(PinFunction::KEY, 27, PinLogic::InputActiveLow, 6);
    addPin(PinFunction::AUXIN_DETECT, 12, PinLogic::InputActiveLow);
    addPin(PinFunction::PA, 21, PinLogic::Output);
    addPin(PinFunction::LED, 22, PinLogic::Output, 1);
    addPin(PinFunction::LED, 19, PinLogic::Output, 2);
  }
};

7 replies

lufa07 Feb 28, 2024
Author

Adding full code here for clarity:

/**
 * @brief We define a custom board with the i2c and i2s pins and output a sine
 * with the help of the AudioTools I2SCodecStream
 * @author phil schatzmann
 */

#include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
#include "AudioLibs/I2SCodecStream.h"
#include "AudioBoard.h"

// I2C
#define SDAPIN               18 // I2C Data,  Adafruit ESP32 S3 3, Sparkfun Thing Plus C 23
#define SCLPIN               23 // I2C Clock, Adafruit ESP32 S3 4, Sparkfun Thing Plus C 22
#define I2CSPEED        100000 // Clock Rate
#define ES8388ADDR        0x20 // Address of ES8388 I2C port

// I2S, your configuration for the ES8388 board
#define MCLKPIN             0 // Master Clock
#define BCLKPIN             5 // Bit Clock
#define WSPIN                25 // Word select
#define DOPIN               26 // This is connected to DI on ES8388 (MISO)
#define DIPIN               35 // This is connected to DO on ES8388 (MOSI)

AudioInfo                     audio_info(44200, 1, 16);                // sampling rate, # channels, bit depth
SineWaveGenerator<int16_t>    sine_wave(32767);                        // amplitude
GeneratedSoundStream<int16_t> sound_stream(sine_wave);                 // sound generator
DriverPins                    my_pins;                                 // board pins
AudioBoard                    audio_board(AudioDriverES8388, my_pins); // audio board
I2SCodecStream                i2s_out_stream(audio_board);             // i2s coded
//I2SCodecStream                i2s_in_stream(audio_board);             // i2s coded
StreamCopy                    copier(i2s_out_stream, sound_stream);    // stream copy sound generator to i2s codec
TwoWire                       myWire = TwoWire(0);                     // universal I2C interface

void setup() {
  // Setup logging
  Serial.begin(115200);
  AudioLogger::instance().begin(Serial, AudioLogger::Warning);
  LOGLEVEL_AUDIODRIVER = AudioDriverWarning;
  delay(2000);

  Serial.println("Setup starting...");

  Serial.println("I2C pin ...");
  my_pins.addI2C(PinFunction::CODEC, SCLPIN, SDAPIN, ES8388ADDR, I2CSPEED, myWire);
  Serial.println("I2S pin ...");
  my_pins.addI2S(PinFunction::CODEC, MCLKPIN, BCLKPIN, WSPIN, DOPIN, DIPIN);

  Serial.println("Pins begin ..."); 
  my_pins.begin();

  Serial.println("Board begin ..."); 
  audio_board.begin();

  Serial.println("I2S begin ..."); 
  auto i2s_config = i2s_out_stream.defaultConfig(RXTX_MODE);
  i2s_config.input_device = ADC_INPUT_ALL;
  i2s_config.output_device = DAC_OUTPUT_LINE2;
  i2s_config.sd_active = false;
  //i2s_config.i2s.fmt = I2S_NORMAL;
  //i2s_config.i2s.mode = MODE_SLAVE;
  i2s_config.copyFrom(audio_info);  
  //i2s_in_stream.begin(i2s_config); // this should apply I2C and I2S configuration
  i2s_out_stream.begin(i2s_config); // this should apply I2C and I2S configuration

  /*  // configure codec
  CodecConfig cfg;
  cfg.input_device = ADC_INPUT_ALL;
  cfg.output_device = DAC_OUTPUT_ALL;
  cfg.i2s.bits = BIT_LENGTH_16BITS;
  cfg.i2s.rate = RATE_44K;
  cfg.i2s.fmt = I2S_NORMAL;
  cfg.i2s.mode = MODE_SLAVE; 
  audio_board.begin(cfg);   */

  // Setup sine wave
  Serial.println("Sine wave begin...");
  sine_wave.begin(audio_info, N_C6); // 493.88 Hz

  Serial.println("Setup completed ...");
}

// Arduino loop - copy sound to out
void loop() { copier.copy(); }

I believe my pin definitions are according to PinsLyrat43

Debug Screen:

pschatzmann Feb 28, 2024
Maintainer

very confusing, you are mixing the APIs from different levels! I2SCodecStream is already configuring the codec, so there is no need for your additional logic. I suggest that you clean up your code and then let it run with the log level info or debug, so that you can check what it is doing...

By the way if you work with the LyraT, there can only be one I2S connection (which can be douplex, so that you can read from it and write to it at the same time)!

#include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
#include "AudioLibs/I2SCodecStream.h"
#include "AudioBoard.h"

// I2C
#define SDAPIN 18 // I2C Data, Adafruit ESP32 S3 3, Sparkfun Thing Plus C 23
#define SCLPIN 23 // I2C Clock, Adafruit ESP32 S3 4, Sparkfun Thing Plus C 22
#define I2CSPEED 100000 // Clock Rate
#define ES8388ADDR 0x20 // Address of ES8388 I2C port

// I2S, your configuration for the ES8388 board
#define MCLKPIN 0 // Master Clock
#define BCLKPIN 5 // Bit Clock
#define WSPIN 25 // Word select
#define DOPIN 26 // This is connected to DI on ES8388 (MISO)
#define DIPIN 35 // This is connected to DO on ES8388 (MOSI)

AudioInfo audio_info(44200, 1, 16); // sampling rate, # channels, bit depth
SineWaveGenerator<int16_t> sine_wave(32767); // amplitude
GeneratedSoundStream<int16_t> sound_stream(sine_wave); // sound generator
DriverPins my_pins; // board pins
AudioBoard audio_board(AudioDriverES8388, my_pins); // audio board
I2SCodecStream i2s_out_stream(audio_board); // i2s coded
StreamCopy copier(i2s_out_stream, sound_stream); // stream copy sound generator to i2s codec
TwoWire myWire = TwoWire(0); // universal I2C interface

void setup() {
// Setup logging
Serial.begin(115200);
AudioLogger::instance().begin(Serial, AudioLogger::Warning);
LOGLEVEL_AUDIODRIVER = AudioDriverWarning;
delay(2000);

Serial.println("Setup starting...");

Serial.println("I2C pin ...");
my_pins.addI2C(PinFunction::CODEC, SCLPIN, SDAPIN, ES8388ADDR, I2CSPEED, myWire);
Serial.println("I2S pin ...");
my_pins.addI2S(PinFunction::CODEC, MCLKPIN, BCLKPIN, WSPIN, DOPIN, DIPIN);

Serial.println("I2S begin ...");
auto i2s_config = i2s_out_stream.defaultConfig(RXTX_MODE);
i2s_config.input_device = ADC_INPUT_ALL;
i2s_config.output_device = DAC_OUTPUT_LINE2;
i2s_config.sd_active = false;
//i2s_config.i2s.fmt = I2S_NORMAL;
//i2s_config.i2s.mode = MODE_SLAVE;
i2s_config.copyFrom(audio_info);
i2s_out_stream.begin(i2s_config); // this should apply I2C and I2S configuration

// Setup sine wave
Serial.println("Sine wave begin...");
sound_stream.begin(audio_info);
sine_wave.begin(audio_info, N_C6); // 493.88 Hz

Serial.println("Setup completed ...");
}

// Arduino loop - copy sound to out
void loop() { copier.copy(); }`

lufa07 Feb 28, 2024
Author

I take it my code has been altered a lot; hence I run the audiotools_custom_max.ino and only change the pin numbers in the #defines.

Code as below:

/**
 * @brief We define a custom board with the i2c and i2s pins and output a sine
 * with the help of the AudioTools I2SCodecStream
 * @author phil schatzmann
 */

#include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
#include "AudioLibs/I2SCodecStream.h"

// I2C
#define SDAPIN               18 // I2C Data,  Adafruit ESP32 S3 3, Sparkfun Thing Plus C 23
#define SCLPIN               23 // I2C Clock, Adafruit ESP32 S3 4, Sparkfun Thing Plus C 22
#define I2CSPEED        100000 // Clock Rate
#define ES8388ADDR        0x10 // Address of ES8388 I2C port

// I2S, your configuration for the ES8388 board
#define MCLKPIN             0 // Master Clock
#define BCLKPIN             5 // Bit Clock
#define WSPIN                25 // Word select
#define DOPIN               26 // This is connected to DI on ES8388 (MISO)
#define DIPIN               35 // This is connected to DO on ES8388 (MOSI)

AudioInfo                     audio_info(44200, 2, 16);                // sampling rate, # channels, bit depth
SineWaveGenerator<int16_t>    sine_wave(32000);                        // amplitude
GeneratedSoundStream<int16_t> sound_stream(sine_wave);                 // sound generator
DriverPins                    my_pins;                                 // board pins
AudioBoard                    audio_board(AudioDriverES8388, my_pins); // audio board
I2SCodecStream                i2s_out_stream(audio_board);             // i2s coded
StreamCopy                    copier(i2s_out_stream, sound_stream);    // stream copy sound generator to i2s codec
TwoWire                       myWire = TwoWire(0);                     // universal I2C interface

void setup() {
  // Setup logging
  Serial.begin(115200);
  AudioLogger::instance().begin(Serial, AudioLogger::Warning);
  LOGLEVEL_AUDIODRIVER = AudioDriverWarning;
  delay(2000);

  Serial.println("Setup starting...");

  Serial.println("I2C pin ...");
  my_pins.addI2C(PinFunction::CODEC, SCLPIN, SDAPIN, ES8388ADDR, I2CSPEED, myWire);
  Serial.println("I2S pin ...");
  my_pins.addI2S(PinFunction::CODEC, MCLKPIN, BCLKPIN, WSPIN, DOPIN, DIPIN);

  Serial.println("Pins begin ..."); 
  my_pins.begin();

  Serial.println("Board begin ..."); 
  audio_board.begin();

  Serial.println("I2S begin ..."); 
  auto i2s_config = i2s_out_stream.defaultConfig();
  i2s_config.copyFrom(audio_info);  
  i2s_out_stream.begin(i2s_config); // this should apply I2C and I2S configuration

  // Setup sine wave
  Serial.println("Sine wave begin...");
  sine_wave.begin(audio_info, N_B4); // 493.88 Hz

  Serial.println("Setup completed ...");
}

// Arduino loop - copy sound to out
void loop() { copier.copy(); }

Debug as below:

Still I do not hear anything on my earphone :(

Also, to ensure my setup works fine, I tested the output.ino from audiokit, the sketch works and I hear some tone on my earphone.

pschatzmann Feb 28, 2024
Maintainer

The custom_max example is thought to be used e.g. with the standard ESP32 i2s API. If you want to use it with the AudioTools you need to that that example!

pschatzmann Feb 28, 2024
Maintainer

go back to my last answer!

lufa07 · 2024-02-28T15:40:47Z

lufa07
Feb 28, 2024
Author

The custom_max example is thought to be used e.g. with the standard ESP32 i2s API. If you want to use it with the AudioTools you need to that that example!

You mean define my own AudioKit with the necessary pins?

14 replies

lufa07 Feb 29, 2024
Author

I cloned your repo again now, to have the latest files.

LOGLEVEL_AUDIODRIVER = AudioDriverDebug output as below:

In your proposal, my_pins.begin();, audio_board.begin();, were missed. I think thats why the Info were not getting printed.

Are you able to reproduce this on your test system?

pschatzmann Feb 29, 2024
Maintainer

No, in this case you forgot to call i2s_out_stream.begin()!
This is automatically calling audio_board.begin() which calls my_pins.begin().
If you scroll up to my proposed code: it is definitely there...

But I am wondering: why is it still not working ? The pins are right now and the address as well...
I don't see what could be wrong. Maybe some loose connections

lufa07 Feb 29, 2024
Author

Now I think either you can try reproducing it in your test system or I can hard code your PinsLyrat43Class and use the program from audio-kit.

I am using LyraT standard kit. No wires, ES8388 is soldered on-board.

Also, I commented out the my_pins.begin(); & audio_board.begin(); but i2s_out_stream.begin(i2s_config); // this should apply I2C and I2S configuration called and I see no Info prints :)

Full code FYR:

#include "AudioTools.h" // install https://github.com/pschatzmann/arduino-audio-tools
#include "AudioLibs/I2SCodecStream.h"
#include "AudioBoard.h"

// I2C
#define SDAPIN 18 // I2C Data, Adafruit ESP32 S3 3, Sparkfun Thing Plus C 23
#define SCLPIN 23 // I2C Clock, Adafruit ESP32 S3 4, Sparkfun Thing Plus C 22
#define I2CSPEED 100000 // Clock Rate
#define ES8388ADDR 0x10 // Address of ES8388 I2C port

// I2S, your configuration for the ES8388 board
#define MCLKPIN 0 // Master Clock
#define BCLKPIN 5 // Bit Clock
#define WSPIN 25 // Word select
#define DOPIN 26 // This is connected to DI on ES8388 (MISO)
#define DIPIN 35 // This is connected to DO on ES8388 (MOSI)

AudioInfo audio_info(44200, 1, 16); // sampling rate, # channels, bit depth
SineWaveGenerator<int16_t> sine_wave(32767); // amplitude
GeneratedSoundStream<int16_t> sound_stream(sine_wave); // sound generator
DriverPins my_pins;   // board pins
AudioBoard audio_board(AudioDriverES8388, my_pins); // audio board
I2SCodecStream i2s_out_stream(audio_board); // i2s coded
StreamCopy copier(i2s_out_stream, sound_stream); // stream copy sound generator to i2s codec
TwoWire myWire = TwoWire(0); // universal I2C interface

void setup() {
// Setup logging
Serial.begin(115200);
AudioLogger::instance().begin(Serial, AudioLogger::Info);
LOGLEVEL_AUDIODRIVER = AudioDriverDebug;
delay(2000);

Serial.println("Setup starting...");

Serial.println("I2C pin ...");
my_pins.addI2C(PinFunction::CODEC, SCLPIN, SDAPIN, ES8388ADDR, I2CSPEED, myWire);
Serial.println("I2S pin ...");
my_pins.addI2S(PinFunction::CODEC, MCLKPIN, BCLKPIN, WSPIN, DOPIN, DIPIN);


  /*Serial.println("Pins begin ..."); 
  my_pins.begin();

  Serial.println("Board begin ..."); 
  audio_board.begin();*/

Serial.println("I2S begin ...");
auto i2s_config = i2s_out_stream.defaultConfig(RXTX_MODE);
i2s_config.input_device = ADC_INPUT_ALL;
i2s_config.output_device = DAC_OUTPUT_LINE2;
i2s_config.sd_active = false;
//i2s_config.i2s.fmt = I2S_NORMAL;
//i2s_config.i2s.mode = MODE_SLAVE;
i2s_config.copyFrom(audio_info);
i2s_out_stream.begin(i2s_config); // this should apply I2C and I2S configuration

// Setup sine wave
Serial.println("Sine wave begin...");
sound_stream.begin(audio_info);
sine_wave.begin(audio_info, N_C6); // 493.88 Hz

Serial.println("Setup completed ...");
}

// Arduino loop - copy sound to out
void loop() { copier.copy(); }

pschatzmann Feb 29, 2024
Maintainer

That was an interesting one!
I changed to pass the pins by reference and now my proposed sketch from above is working.
Just update this library...

16:31:11.038 -> Setup starting...
16:31:11.038 -> I2C pin ...
16:31:11.038 -> I2S pin ...
16:31:11.038 -> I2S begin ...
16:31:11.038 -> Debug: AudioBoard::pins::begin
16:31:11.038 -> Debug: DriverPins::begin
16:31:11.046 -> Debug: DriverPins::begin::setupPinMode
16:31:11.046 -> Debug: DriverPins::begin::SPI
16:31:11.046 -> Debug: DriverPins::begin::I2C
16:31:11.046 -> Debug: DriverPins::begin::I2C port:32
16:31:11.046 -> Debug: PinsI2C::begin for 7
16:31:11.046 -> Info: setting up I2C scl: 32, sda: 33
16:31:11.047 -> Info: Setting i2c clock: 100000
16:31:11.047 -> Debug: AudioBoard::pins::begin::returned:true
16:31:11.047 -> Debug: AudioBoard::driver::begin
16:31:11.047 -> Debug: AudioDriver::begin:pins
16:31:11.055 -> Debug: AudioDriver::begin:setSPI
16:31:11.055 -> Debug: AudioDriver::begin:setConfig
16:31:11.055 -> Debug: es8388_init
16:31:11.055 -> Debug: i2c_bus_check: addr=0x10
16:31:11.055 -> Info: Found ES8388
16:31:11.055 -> Debug: i2c_bus_write_bytes: addr=0x10 reglen=1 datalen=1 - reg=0x19 value=0x4
16:31:11.055 -> Debug: i2c_bus_write_bytes: addr=0x10 reglen=1 datalen=1 - reg=0x1 value=0x50

Answer selected by lufa07

lufa07 Feb 29, 2024
Author

Amazing solve Phil :) !

I do not understand the whole issue yet however, I hear now some tone on my earphones.

Excited to check this on my custom board now :)

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Custom Board Code on LyraT #13

{{title}}

Replies: 2 comments 21 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

Select a reply

Custom Board Code on LyraT #13

lufa07 Feb 28, 2024

Replies: 2 comments · 21 replies

pschatzmann Feb 28, 2024 Maintainer

lufa07 Feb 28, 2024 Author

pschatzmann Feb 28, 2024 Maintainer

lufa07 Feb 28, 2024 Author

pschatzmann Feb 28, 2024 Maintainer

pschatzmann Feb 28, 2024 Maintainer

lufa07 Feb 28, 2024 Author

lufa07 Feb 29, 2024 Author

pschatzmann Feb 29, 2024 Maintainer

lufa07 Feb 29, 2024 Author

pschatzmann Feb 29, 2024 Maintainer

lufa07 Feb 29, 2024 Author

lufa07
Feb 28, 2024

Replies: 2 comments 21 replies

pschatzmann
Feb 28, 2024
Maintainer

lufa07 Feb 28, 2024
Author

pschatzmann Feb 28, 2024
Maintainer

lufa07 Feb 28, 2024
Author

pschatzmann Feb 28, 2024
Maintainer

pschatzmann Feb 28, 2024
Maintainer

lufa07
Feb 28, 2024
Author

lufa07 Feb 29, 2024
Author

pschatzmann Feb 29, 2024
Maintainer

lufa07 Feb 29, 2024
Author

pschatzmann Feb 29, 2024
Maintainer

lufa07 Feb 29, 2024
Author