Author
|
Matrix TSL
|
Version
|
2.0
|
Category
|
Comms: Interface
|
I2S Master/Slave ESP32 component
Provides access to the onboard inter-IC sound (I2S) peripheras allowing for simple digital audio input and output.
Component Source Code
Please click here to download the component source project: FC_Comp_Source_I2S.fcfx
Please click here to view the component source code (Beta): FC_Comp_Source_I2S.fcfx
Detailed description
No detailed description exists yet for this component
Examples
No additional examples
Macro reference
|
Stop
|
Stops the I2S audio stream
|
- VOID
|
Return
|
|
Read
|
Wait timeout ticks to receive length number of samples, returns samples received. 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array to populate with incoming data
|
- UINT
|
Length
|
Max number of samples to try and receive
|
- UINT
|
Timeout
|
Max number of ticks to wait for incoming samples
|
- UINT
|
Return
|
|
CheckQueue
|
Checks the I2S Event queue for a DMA Buffer full or empty event. For an output returns true when there is an empty DMA buffer available. For an input return true when there is a full DMA buffer available.
|
- BOOL
|
Return
|
|
Write
|
Wait timeout ticks to send length number of samples, returns samples sent 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array containing outgoing data
|
- UINT
|
Length
|
Max number of samples to try and send
|
- UINT
|
Timeout
|
Max number of ticks to wait for space in the outgoing buffer
|
- UINT
|
Return
|
|
Start
|
Starts the I2S audio stream, auto started by the initialise function.
|
- VOID
|
Return
|
|
Initialise
|
Configures the I2C peripheral ready for data.
|
- VOID
|
Return
|
Property reference
|
Properties
|
|
Channel
|
DAC Channel number
|
|
Clock Pin
|
I2S Clock Pin
|
|
Serial Data Pin
|
I2S Serial Data (SD) Pin
|
|
Word Select Pin
|
I2S Word Select (WS) Pin
|
|
Mode
|
Configures if the I2S peripheral is a master or slave on the bus.
|
|
Data Direction
|
Controls if the I2S data is coming in or out of the microcontroller
|
|
Audio Channels
|
Number of distinct audio channels in the data stream
|
|
Sample Rate
|
Audio sample rate in Hz
|
|
Data Bits
|
Nmber of bits in each audio sample
|
|
DMA Buffer Count
|
I2S DMA Buffer Count
|
|
DMA Buffer Size
|
I2S DMA Buffer Size
|
|
Simulation
|
==Macro reference==
|
Stop
|
Stops the I2S audio stream
|
- VOID
|
Return
|
|
Read
|
Wait timeout ticks to receive length number of samples, returns samples received. 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array to populate with incoming data
|
- UINT
|
Length
|
Max number of samples to try and receive
|
- UINT
|
Timeout
|
Max number of ticks to wait for incoming samples
|
- UINT
|
Return
|
|
CheckQueue
|
Checks the I2S Event queue for a DMA Buffer full or empty event. For an output returns true when there is an empty DMA buffer available. For an input return true when there is a full DMA buffer available.
|
- BOOL
|
Return
|
|
Write
|
Wait timeout ticks to send length number of samples, returns samples sent 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array containing outgoing data
|
- UINT
|
Length
|
Max number of samples to try and send
|
- UINT
|
Timeout
|
Max number of ticks to wait for space in the outgoing buffer
|
- UINT
|
Return
|
|
Start
|
Starts the I2S audio stream, auto started by the initialise function.
|
- VOID
|
Return
|
|
Initialise
|
Configures the I2C peripheral ready for data.
|
- VOID
|
Return
|
Property reference
|
Properties
|
|
Channel
|
DAC Channel number
|
|
Clock Pin
|
I2S Clock Pin
|
|
Serial Data Pin
|
I2S Serial Data (SD) Pin
|
|
Word Select Pin
|
I2S Word Select (WS) Pin
|
|
Mode
|
Configures if the I2S peripheral is a master or slave on the bus.
|
|
Data Direction
|
Controls if the I2S data is coming in or out of the microcontroller
|
|
Audio Channels
|
Number of distinct audio channels in the data stream
|
|
Sample Rate
|
Audio sample rate in Hz
|
|
Data Bits
|
Nmber of bits in each audio sample
|
|
DMA Buffer Count
|
I2S DMA Buffer Count
|
|
DMA Buffer Size
|
I2S DMA Buffer Size
|
|
Simulation
|
==Macro reference==
|
Stop
|
Stops the I2S audio stream
|
- VOID
|
Return
|
|
Read
|
Wait timeout ticks to receive length number of samples, returns samples received. 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array to populate with incoming data
|
- UINT
|
Length
|
Max number of samples to try and receive
|
- UINT
|
Timeout
|
Max number of ticks to wait for incoming samples
|
- UINT
|
Return
|
|
CheckQueue
|
Checks the I2S Event queue for a DMA Buffer full or empty event. For an output returns true when there is an empty DMA buffer available. For an input return true when there is a full DMA buffer available.
|
- BOOL
|
Return
|
|
Write
|
Wait timeout ticks to send length number of samples, returns samples sent 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array containing outgoing data
|
- UINT
|
Length
|
Max number of samples to try and send
|
- UINT
|
Timeout
|
Max number of ticks to wait for space in the outgoing buffer
|
- UINT
|
Return
|
|
Start
|
Starts the I2S audio stream, auto started by the initialise function.
|
- VOID
|
Return
|
|
Initialise
|
Configures the I2C peripheral ready for data.
|
- VOID
|
Return
|
Property reference
|
Properties
|
|
Channel
|
DAC Channel number
|
|
Clock Pin
|
I2S Clock Pin
|
|
Serial Data Pin
|
I2S Serial Data (SD) Pin
|
|
Word Select Pin
|
I2S Word Select (WS) Pin
|
|
Mode
|
Configures if the I2S peripheral is a master or slave on the bus.
|
|
Data Direction
|
Controls if the I2S data is coming in or out of the microcontroller
|
|
Audio Channels
|
Number of distinct audio channels in the data stream
|
|
Sample Rate
|
Audio sample rate in Hz
|
|
Data Bits
|
Nmber of bits in each audio sample
|
|
DMA Buffer Count
|
I2S DMA Buffer Count
|
|
DMA Buffer Size
|
I2S DMA Buffer Size
|
|
Simulation
|
==Macro reference==
|
Stop
|
Stops the I2S audio stream
|
- VOID
|
Return
|
|
Read
|
Wait timeout ticks to receive length number of samples, returns samples received. 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array to populate with incoming data
|
- UINT
|
Length
|
Max number of samples to try and receive
|
- UINT
|
Timeout
|
Max number of ticks to wait for incoming samples
|
- UINT
|
Return
|
|
CheckQueue
|
Checks the I2S Event queue for a DMA Buffer full or empty event. For an output returns true when there is an empty DMA buffer available. For an input return true when there is a full DMA buffer available.
|
- BOOL
|
Return
|
|
Write
|
Wait timeout ticks to send length number of samples, returns samples sent 24 and 32-bit data must be split into two integer values per sample.
|
- INT
|
Data
|
Data array containing outgoing data
|
- UINT
|
Length
|
Max number of samples to try and send
|
- UINT
|
Timeout
|
Max number of ticks to wait for space in the outgoing buffer
|
- UINT
|
Return
|
|
Start
|
Starts the I2S audio stream, auto started by the initialise function.
|
- VOID
|
Return
|
|
Initialise
|
Configures the I2C peripheral ready for data.
|
- VOID
|
Return
|
Property reference
|
Properties
|
|
Channel
|
DAC Channel number
|
|
Clock Pin
|
I2S Clock Pin
|
|
Serial Data Pin
|
I2S Serial Data (SD) Pin
|
|
Word Select Pin
|
I2S Word Select (WS) Pin
|
|
Mode
|
Configures if the I2S peripheral is a master or slave on the bus.
|
|
Data Direction
|
Controls if the I2S data is coming in or out of the microcontroller
|
|
Audio Channels
|
Number of distinct audio channels in the data stream
|
|
Sample Rate
|
Audio sample rate in Hz
|
|
Data Bits
|
Nmber of bits in each audio sample
|
|
DMA Buffer Count
|
I2S DMA Buffer Count
|
|
DMA Buffer Size
|
I2S DMA Buffer Size
|
|
Simulation
|