{"id":3881,"date":"2021-12-06T12:20:42","date_gmt":"2021-12-06T11:20:42","guid":{"rendered":"https:\/\/www.pschatzmann.ch\/home\/?p=3881"},"modified":"2023-02-19T16:13:40","modified_gmt":"2023-02-19T15:13:40","slug":"the-ai-thinker-audio-kit-experience-or-nothing-is-right","status":"publish","type":"post","link":"https:\/\/www.pschatzmann.ch\/home\/2021\/12\/06\/the-ai-thinker-audio-kit-experience-or-nothing-is-right\/","title":{"rendered":"The ‘AI Thinker Audio Kit’ Arduino Challenge"},"content":{"rendered":"

I found some cheap AI Thinker ESP32 Audio Kit V2.2<\/a> on AliExpress and because I was tired of all the wires I had to connect to implement my different scenarios that are possible with my Arduino Audio Tools Library<\/a>, I thought it to be a good idea to buy this board.<\/p>\n

\"Audio<\/p>\n

I am aware that this board, like the corresponding LyraT<\/a> alternatives from Espressif are mainly used with the IDF\/ADF<\/a> framework, but I wanted to use it with Arduino<\/strong>, and that’s where the problems started: First I was so naive to just deploy one of my Bluetooth A2DP Audio<\/a> sketches. It was running somehow – but there was no sound<\/strong>! Next I tried out the SD drive – and here again – the SD drive was not available<\/strong>.<\/p>\n

I am documenting here the solutions to make things work for my V2.2 3478 Board:<\/p>\n

The SD Card<\/h2>\n

The AI board like the LyraT boards are using some unusual pin assignments and you need to initialize SPI by indicating the correct pins<\/strong>.
\nIn addition you need to make sure that the DATA3 and CMD on-board switches are in the on position<\/strong>:<\/p>\n

#define PIN_AUDIO_KIT_SD_CARD_CS 13\n#define PIN_AUDIO_KIT_SD_CARD_MISO 2\n#define PIN_AUDIO_KIT_SD_CARD_MOSI 15\n#define PIN_AUDIO_KIT_SD_CARD_CLK  14\n\nSPI.begin(PIN_AUDIO_KIT_SD_CARD_CLK, PIN_AUDIO_KIT_SD_CARD_MISO, PIN_AUDIO_KIT_SD_CARD_MOSI, PIN_AUDIO_KIT_SD_CARD_CS);\n\n<\/code><\/pre>\n
Then when you set up the SD library you need to indicate the PIN_AUDIO_KIT_SD_CARD_CS as CS pin. That was the easy one – no let’s move to the major challenge:<\/p>\n
Output to the Speakers<\/h2>\n
The board uses a ES8388 audio chip<\/a> that is connected via I2S<\/strong>, so we need to use the correct  I2S pin assignments. Note that these are different from the LyraT ones!<\/p>\n
#define PIN_I2S_AUDIO_KIT_MCLK 0\n#define PIN_I2S_AUDIO_KIT_BCK 27\n#define PIN_I2S_AUDIO_KIT_WS 25\n#define PIN_I2S_AUDIO_KIT_DATA_OUT 26\n#define PIN_I2S_AUDIO_KIT_DATA_IN 35\n<\/code><\/pre>\n
The audio chip is responsible for routing the output or input to the correct final device and controlling the volume. The ES8388<\/strong> must be programmed via I2C<\/strong>! In order to do this I found this solution<\/a> from thaaraak which inspired me to try to convert the original ADF driver<\/a> from Espressif, so that it can be used in Arduino.
\nHere is the necessary information for the I2C connection:<\/p>\n
#define I2C_MASTER_NUM I2C_NUM_0 \/*!< I2C port number for master dev *\/\n#define I2C_MASTER_SCL_IO 32     \n#define I2C_MASTER_SDA_IO 33    \n#define ES8388_ADDR 0x10\n\n<\/code><\/pre>\n
Finally, here is a link to the ES8388 user guide<\/a>.<\/p>\n
Headphone Detection<\/h2>\n
I was testing the headphone detection with the following logic:<\/p>\n
#define HEADPHONE_DETECT 39 \n\nbool headphoneStatus() {\n  return !gpio_get_level((gpio_num_t)HEADPHONE_DETECT);\n}\n\n<\/code><\/pre>\n
If no headphone is connected the gpio_get_level() returns 1 – with a headphone the output changes to 0 – so I confirm that on this board we need to use GPIO 39.<\/p>\n
Please note that the pin must be set up to be pulled high<\/strong>.<\/p>\n
Enable Power Amplifier<\/h2>\n
The power activate pin for the speakers is identical to the LyraT boards:<\/p>\n
#define PA_ENABLE_GPIO 21\n<\/code><\/pre>\n
We can use this pin together with the headphone detection pin to activate\/deactivate the speaker<\/p>\n
  void processKeys() {\n    LOGI(LOG_METHOD);\n    static unsigned long keys_timeout = 0;\n    if (keys_timeout < millis()) {\n      if (cfg.is_headphone_detection) {\n        LOGI(\"process headphone detection\");\n        bool isConnected = headphoneStatus();\n        bool powerActive = !isConnected;\n        if (powerActive != actualPower) {\n          LOGW(\"Headphone jack has been %s\",\n                   isConnected ? \"inserted\" : \"removed\");\n          setPAPower(powerActive);\n        }\n      }\n      keys_timeout = millis() + KEY_RESPONSE_TIME_MS;\n    }\n  }\n<\/code><\/pre>\n
Conclusions<\/h2>\n
I have the solution working now and I can share my Audio Player Sketch that I used for my tests. It is based on my arduino-audio-tools project<\/a>:<\/p>\n
The Arduino Audio Player Sketch<\/h2>\n
#define USE_SDFAT\n#define USE_HELIX\n#include \"AudioTools.h\"\n#include \"AudioLibs\/AudioKit.h\"\n\nconst char *startFilePath=\"\/\";\nconst char* ext=\"mp3\";\nAudioSourceSdFat source(startFilePath, ext, PIN_AUDIO_KIT_SD_CARD_CS);\nAudioKitStream kit;\nMP3DecoderHelix decoder;\nAudioPlayer player(source, kit, decoder);\n\n\nvoid setup() {\n  Serial.begin(115200);\n  AudioLogger::instance().begin(Serial, AudioLogger::Info);\n\n  \/\/ setup output\n  auto cfg = kit.defaultConfig(TX_MODE);\n  kit.begin(cfg);\n\n  \/\/ setup player\n  player.begin();\n}\n\nvoid loop() {\n  player.copy();\n  kit.processActions();\n}\n\n<\/code><\/pre>\n
Yes – I just needed to replace the I2SStream<\/strong> with the AudioKitStream<\/strong> and that’s pretty cool!
\nIf you add the kit.processActions() in the loop you get the automatic headphone detection and volume control working.<\/p>\n
Unfortunately the output is quite distored mainly for the loud parts. We can take care of this by reducing the signal strength (volume) that we send to the kit by adjusting the volume of the player with player.setVolume(0.7);<\/code><\/p>\n
The full example can be found on Github<\/a><\/p>\n
Dependencies<\/h2>\n