Skip to content

Commit

Permalink
docs/library/machine.I2S: Describe new PDM RX mode.
Browse files Browse the repository at this point in the history
Signed-off-by: maple "mavica" syrup <maple@maple.pet>
  • Loading branch information
Lana-chan committed Mar 25, 2024
1 parent 9720278 commit ad6e376
Showing 1 changed file with 7 additions and 2 deletions.
9 changes: 7 additions & 2 deletions docs/library/machine.I2S.rst
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ other things. For these drivers see:
Constructor
-----------

.. class:: I2S(id, *, sck, ws, sd, mck=None, mode, bits, format, rate, ibuf)
.. class:: I2S(id, *, sck, ws=None, sd, mck=None, mode, bits, format, rate, ibuf)

Construct an I2S object of the given id:

Expand All @@ -91,7 +91,8 @@ Constructor
Keyword-only parameters that are supported on all ports:

- ``sck`` is a pin object for the serial clock line
- ``ws`` is a pin object for the word select line
- ``ws`` is a pin object for the word select line;
can be left unset if using ``I2S.PDM_RX`` mode
- ``sd`` is a pin object for the serial data line
- ``mck`` is a pin object for the master clock line;
master clock frequency is sampling rate * 256
Expand Down Expand Up @@ -155,6 +156,10 @@ Constants

for initialising the I2S bus ``mode`` to transmit

.. data:: I2S.PDM_RX

for initialising the I2S bus ``mode`` to receive in PDM mode

.. data:: I2S.STEREO

for initialising the I2S bus ``format`` to stereo
Expand Down

0 comments on commit ad6e376

Please sign in to comment.