Skip to content

Introduction

Phil Schatzmann edited this page Feb 7, 2024 · 6 revisions

The goal of this project is to provide an easy API to configure different audio codec chips. These chips need to be configured via an I2C connection before the audio data can be sent with the help of I2S.

A audio board definition consists of a codec chip specific driver and some optional board specific pin definitions. We provide predefined boards, drivers and pin definitions with the help of some global objects: e.g. LyratV43. The available objects can be found in the Variables section of the documentation.

You can easily define some new boards by assigning a existing driver object and optionally add your pin definitions.

The pin definitions are used as follows:

  • to initialize I2C (which is used to configure the codecs)
  • to initialize SPI (which is e.g. used for a SD drive)
  • to provide the I2S pin information e.g. to the AudioTools
  • to provide and setup additional pins for LEDs, buttons etc

The pin definitions are used as a kind of repository that is used by the driver, the audio-tools and that can be used by your application as well.

Clone this wiki locally