This repository was archived by the owner on Apr 1, 2024. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 45
Adding Support for a new Board
Phil Schatzmann edited this page Feb 25, 2023
·
14 revisions
Before creating the definition of a new board (with a new board number), you should consider to use one of the generic boards as a starting point and using your kit_custom_pins.h file to define your custom pins. Further details can be found here
To define a new board follow these steps:
- Get a new free board number for the AudioKitSettings.h and update the Readme.md
- Create a new directory in /src/audio_board. I suggest to use the same name like in https://github.com/espressif/esp-adf/tree/master/components/audio_board
- Add the missing files: board.c, board.h, board_def.h, board_pins_config.c to the new directory. You can take the original files from espressif as starting point
- Compare your copied files with one of the existing AudioKit implementations and apply the necessary changes
- Wrap the code of the board.c and board_pins_config.c in #if AUDIOKIT_BOARD== your number from step 1 #endif
- Add additional includes/Replace includes
- Add the new logic in src/audio_hal/audiokit_board.h