Procházet zdrojové kódy

Update WM8731 documentation

dds
PaulStoffregen před 7 roky
rodič
revize
e4fcedd834
2 změnil soubory, kde provedl 20 přidání a 10 odebrání
  1. +7
    -1
      examples/HardwareTesting/WM8731MikroSine/WM8731MikroSine.ino
  2. +13
    -9
      gui/index.html

+ 7
- 1
examples/HardwareTesting/WM8731MikroSine/WM8731MikroSine.ino Zobrazit soubor

// Requires the MikroElektronika Audio Codec board or similar hardware // Requires the MikroElektronika Audio Codec board or similar hardware
// http://www.mikroe.com/add-on-boards/audio-voice/audio-codec-proto/ // http://www.mikroe.com/add-on-boards/audio-voice/audio-codec-proto/
// //
// When using AudioInputI2Sslave & AudioOutputI2Sslave with MikroE-506,
// the sample rate will be the crystal frequency divided by 256. The
// MikroE-506 comes with a 12.288 MHz crystal, for 48 kHz sample rate.
// To get 44.1 kHz (as expected by the Teensy Audio Library) the crystal
// should be replaced with 11.2896 MHz.
//
// Recommended connections: // Recommended connections:
// //
// Mikroe Teensy 3.1 // Mikroe Teensy 3.1


wm8731m1.volume(0.50); wm8731m1.volume(0.50);
wm8731m1.inputSelect(AUDIO_INPUT_MIC); wm8731m1.inputSelect(AUDIO_INPUT_MIC);
// wm8731m1.inputSelect(AUDIO_INPUT_LINEIN); // not connected on MikroE-516
// wm8731m1.inputSelect(AUDIO_INPUT_LINEIN); // not connected on MikroE-506
} }


elapsedMillis msec; elapsedMillis msec;

+ 13
- 9
gui/index.html Zobrazit soubor

</p> </p>
<h3>Functions</h3> <h3>Functions</h3>
<p class=func><span class=keyword>enable</span>();</p> <p class=func><span class=keyword>enable</span>();</p>
<p class=desc>blah blah blah blah
<p class=desc>Turn on the WS8731.
</p> </p>
<p class=func><span class=keyword>disable</span>();</p> <p class=func><span class=keyword>disable</span>();</p>
<p class=desc>not implemented <p class=desc>not implemented
</p> </p>
<p class=func><span class=keyword>volume</span>(level);</p> <p class=func><span class=keyword>volume</span>(level);</p>
<p class=desc>blah blah blah blah
<p class=desc>Set the headphone volume level. Range is 0 to 1.0.
</p> </p>
<p class=func><span class=keyword>inputLevel</span>(level);</p> <p class=func><span class=keyword>inputLevel</span>(level);</p>
<p class=desc>not implemented
<p class=desc>Adjust the line level input gain. Range is 0 to 1.0.
</p> </p>
<p class=func><span class=keyword>inputSelect</span>(input);</p> <p class=func><span class=keyword>inputSelect</span>(input);</p>
<p class=desc>not implemented
<p class=desc>Select which input to use: AUDIO_INPUT_LINEIN or AUDIO_INPUT_MIC.
</p> </p>
<!-- <!--
<h3>Examples</h3> <h3>Examples</h3>
</p> </p>
<h3>Functions</h3> <h3>Functions</h3>
<p class=func><span class=keyword>enable</span>();</p> <p class=func><span class=keyword>enable</span>();</p>
<p class=desc>blah blah blah blah
<p class=desc>Turn on the WS8731, in I2S Master mode. I2S slave mode
communication must be used by Teensy.
</p> </p>
<p class=func><span class=keyword>disable</span>();</p> <p class=func><span class=keyword>disable</span>();</p>
<p class=desc>not implemented <p class=desc>not implemented
</p> </p>
<p class=func><span class=keyword>volume</span>(level);</p> <p class=func><span class=keyword>volume</span>(level);</p>
<p class=desc>blah blah blah blah
<p class=desc>Set the headphone volume level. Range is 0 to 1.0.
</p> </p>
<p class=func><span class=keyword>inputLevel</span>(level);</p> <p class=func><span class=keyword>inputLevel</span>(level);</p>
<p class=desc>not implemented
<p class=desc>Adjust the line level input gain. Range is 0 to 1.0.
</p> </p>
<p class=func><span class=keyword>inputSelect</span>(input);</p> <p class=func><span class=keyword>inputSelect</span>(input);</p>
<p class=desc>not implemented
<p class=desc>Select which input to use: AUDIO_INPUT_LINEIN or AUDIO_INPUT_MIC.
</p> </p>
<h3>Examples</h3> <h3>Examples</h3>
<p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WM8731MikroSine <p class=exam>File &gt; Examples &gt; Audio &gt; HardwareTesting &gt; WM8731MikroSine
</p> </p>
<h3>Notes</h3> <h3>Notes</h3>
<p></p>
<p>The WM8731 will implement a sample rate of its crystal frequency divided by 256.
To get the 44.1 kHz sample rate the Teensy Audio Library expects, an
11.2896 MHz crystal should be used.
</p>
</script> </script>
<script type="text/x-red" data-template-name="AudioControlWM8731master"> <script type="text/x-red" data-template-name="AudioControlWM8731master">
<div class="form-row"> <div class="form-row">

Načítá se…
Zrušit
Uložit