I2SDriverNanoBLE Class Reference

Basic I2S API - for the Arduino Nano BLE Sense See https://content.arduino.cc/assets/Nano_BLE_MCU-nRF52840_PS_v1.1.pdf Douplex mode (RXTX_MODE) is currently not supported, but it should be quite easy to implement. More...

#include <I2SDriverNanoSenseBLE.h>

Inheritance diagram for I2SDriverNanoBLE:

Public Member Functions
	I2SDriverNanoBLE ()=default
int	available ()
int	availableForWrite ()
virtual bool	begin (I2SConfig cfg)=0
bool	begin (I2SConfigStd cfg)
	starts the I2S
bool	begin (RxTxMode mode=TX_MODE)
	starts the I2S with the default config in TX Mode
void	clearStream ()
	Deactivate alternative API: don't forget to call begin()
I2SConfigStd	config ()
	provides the actual configuration
I2SConfigStd	defaultConfig (RxTxMode mode)
	Provides the default configuration.
void	end ()
	stops the I2S
virtual void	flush ()
size_t	readBytes (void *dest, size_t size_bytes)
	reads the data from the I2S buffer
bool	setAudioInfo (AudioInfo)
	Potentially updates the sample rate (if supported)
void	setBufferSize (int size)
void	setStream (Stream &stream)
	alternative API which provides the data directly via a Stream
size_t	writeBytes (const void *src, size_t size_bytes)
	writes the data to the I2S buffer

Protected Member Functions
int	digitalPinToPinName (int pin)
unsigned long	getINTENSET ()
	Determine the INTENSET value.
int	getPinName (int pin)
	Provides the arduino or unconverted pin name.
void	releaseBuffers ()
	Release buffers.
void	setupBitWidth (I2SConfigStd cfg)
	setup SWIDTH
bool	setupBuffers ()
	dynamic buffer management
void	setupClock (I2SConfigStd cfg)
	setup MCKFREQ and RATIO
void	setupMode (I2SConfigStd cfg)
	setup format and align
void	setupPins (I2SConfigStd cfg)
	setup pins
bool	setupRxTx (I2SConfigStd cfg)
	setup TXEN or RXEN
void	startI2SActive ()
	Start IRQ and I2S.

Protected Attributes
I2SConfigStd	cfg
bool	is_active = false

Friends
class	I2SStream

Detailed Description

Basic I2S API - for the Arduino Nano BLE Sense See https://content.arduino.cc/assets/Nano_BLE_MCU-nRF52840_PS_v1.1.pdf Douplex mode (RXTX_MODE) is currently not supported, but it should be quite easy to implement.

Author

Phil Schatzmann

Copyright

GPLv3

Constructor & Destructor Documentation

I2SDriverNanoBLE()

I2SDriverNanoBLE ( )

default

Member Function Documentation

available()

int available ( )

inlinevirtual

Implements I2SDriverBase.

availableForWrite()

int availableForWrite ( )

inlinevirtual

Implements I2SDriverBase.

begin() [1/3]

virtual bool begin ( I2SConfig  cfg )

pure virtualinherited

Implemented in I2SDriverESP32.

begin() [2/3]

bool begin ( I2SConfigStd  cfg )

inline

starts the I2S

begin() [3/3]

bool begin ( RxTxMode  mode = TX_MODE )

inline

starts the I2S with the default config in TX Mode

clearStream()

void clearStream ( )

inline

Deactivate alternative API: don't forget to call begin()

config()

I2SConfigStd config ( )

inlinevirtual

provides the actual configuration

Implements I2SDriverBase.

defaultConfig()

I2SConfigStd defaultConfig ( RxTxMode  mode )

inlinevirtual

Provides the default configuration.

Implements I2SDriverBase.

digitalPinToPinName()

int digitalPinToPinName ( int  pin )

inlineprotected

end()

void end ( )

inlinevirtual

stops the I2S

Implements I2SDriverBase.

flush()

virtual void flush ( )

inlinevirtualinherited

Discards any audio already queued in the driver's own output buffer (e.g. the I2S DMA buffer) but not yet physically played - useful when switching to unrelated audio content (e.g. AudioPlayer moving to the next track) to stop stale samples from continuing to play out during the switch. Default no-op, since not every backend can support this; override where the underlying driver allows it.

Reimplemented in I2SDriverESP32, and I2SDriverESP32V1.

getINTENSET()

unsigned long getINTENSET ( )

inlineprotected

Determine the INTENSET value.

getPinName()

int getPinName ( int  pin )

inlineprotected

Provides the arduino or unconverted pin name.

readBytes()

size_t readBytes ( void *  dest, size_t  size_bytes  )

inlinevirtual

reads the data from the I2S buffer

Implements I2SDriverBase.

releaseBuffers()

void releaseBuffers ( )

inlineprotected

Release buffers.

setAudioInfo()

bool setAudioInfo ( AudioInfo  )

inlinevirtual

Potentially updates the sample rate (if supported)

Implements I2SDriverBase.

setBufferSize()

void setBufferSize ( int  size )

inline

setStream()

void setStream ( Stream &  stream )

inline

alternative API which provides the data directly via a Stream

setupBitWidth()

void setupBitWidth ( I2SConfigStd  cfg )

inlineprotected

setup SWIDTH

setupBuffers()

bool setupBuffers ( )

inlineprotected

dynamic buffer management

setupClock()

void setupClock ( I2SConfigStd  cfg )

inlineprotected

setup MCKFREQ and RATIO

setupMode()

void setupMode ( I2SConfigStd  cfg )

inlineprotected

setup format and align

setupPins()

void setupPins ( I2SConfigStd  cfg )

inlineprotected

setup pins

setupRxTx()

bool setupRxTx ( I2SConfigStd  cfg )

inlineprotected

setup TXEN or RXEN

startI2SActive()

void startI2SActive ( )

inlineprotected

Start IRQ and I2S.

writeBytes()

size_t writeBytes ( const void *  src, size_t  size_bytes  )

inlinevirtual

writes the data to the I2S buffer

Implements I2SDriverBase.

Friends And Related Symbol Documentation

I2SStream

friend class I2SStream

friend

Member Data Documentation

cfg

I2SConfigStd cfg

protected

is_active

bool is_active = false

protected

---

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

• src/AudioTools/CoreAudio/AudioI2S/I2SDriverNanoSenseBLE.h