TinyGPU
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | List of all members
I2SPins Struct Reference

#include <LCDBoardsCommon.h>

Public Member Functions

bool isValid () const
 

Public Attributes

int8_t mclk = -1
 
int8_t bck = -1
 
int8_t ws = -1
 
int8_t dataOut = -1
 
int8_t dataIn = -1
 
int8_t paEnable = -1
 
bool paEnableActiveLow = false
 

Detailed Description

I2S pin assignment for a board's audio codec/amplifier. Not used by TinyGPU itself - hand these to the audio library of choice (e.g. audio_tools::I2SConfig's pin_mck/pin_bck/pin_ws/pin_data/pin_data_rx). -1 means "not present on this board".

paEnable/paEnableActiveLow describe a separate GPIO some boards use to gate the speaker amplifier (not part of the I2S bus itself, but bundled here since it's only ever needed alongside these pins).

Member Function Documentation

◆ isValid()

bool isValid ( ) const
inline

True if this board has a usable I2S bus (bck/ws plus at least one of dataOut/dataIn) wired up.

Member Data Documentation

◆ bck

int8_t bck = -1

◆ dataIn

int8_t dataIn = -1

◆ dataOut

int8_t dataOut = -1

◆ mclk

int8_t mclk = -1

◆ paEnable

int8_t paEnable = -1

◆ paEnableActiveLow

bool paEnableActiveLow = false

◆ ws

int8_t ws = -1

The documentation for this struct was generated from the following file: