Skip to content

Commit

Permalink
Merge branch 'floitsch/adc.i2s' of github.com:toitlang/toit into floi…
Browse files Browse the repository at this point in the history
…tsch/adc.i2s
  • Loading branch information
floitsch committed Feb 5, 2025
2 parents 8116f42 + 803d6ec commit 7cb3785
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions lib/i2s.toit
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ import serial
I2S Serial communication Bus.
An I2S bus can be either in master or slave mode. In master mode, the bus
generates the clock and word select signals. In slave mode, the bus uses
generates the clock and word-select signals. In slave mode, the bus uses
these signals as input.
Optionally, the peripheral can also generate the master clock (independently
Expand Down Expand Up @@ -310,14 +310,14 @@ class Bus:
/**
Constructs an I2S channel as input.
For typical I2S setups, the $rx pin, a clock ($sck), and a word select ($ws)
For typical I2S setups, the $rx pin, a clock ($sck), and a word-select ($ws)
pins are required. The master clock ($mclk) is optional.
If $master is true, then I2S peripheral runs as master. As master, the
$sck, $ws, and $mclk pins are outputs. As slave, they are inputs.
The $sample-rate is the rate at which samples are written.
The $bits-per-sample is the width of each sample. It can be either 8, 16, 24 or 32.
The $bits-per-sample is the width of each sample. It can be either 8, 16, 24, or 32.
For 8 and 24 bits see the note on the ESP32 below.
If a $mclk pin is provide, then the master clock is emitted/read from that pin.
Expand Down Expand Up @@ -599,7 +599,7 @@ class Bus:
When a bus was constructed but not started yet, then the master clock is
running, but the other signals are not. Specifically, in master mode,
there is no clock, word select or data being transmitted.
there is no clock, word-select or data being transmitted.
The bus must not already be started.
Expand Down

0 comments on commit 7cb3785

Please sign in to comment.