Skip to content

Commit 22d753e

Browse files
committed
doxygen
1 parent 3086d04 commit 22d753e

File tree

112 files changed

+982
-949
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

112 files changed

+982
-949
lines changed

docs/html/_audio_board_8h_source.html

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -157,24 +157,24 @@
157157
<div class="ttc" id="aclassaudio__driver_1_1_audio_driver_html_aaf041a73009a07b13117c75c1d09f00c"><div class="ttname"><a href="classaudio__driver_1_1_audio_driver.html#aaf041a73009a07b13117c75c1d09f00c">audio_driver::AudioDriver::getVolume</a></div><div class="ttdeci">virtual int getVolume()=0</div></div>
158158
<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html">audio_driver::CodecConfig</a></div><div class="ttdoc">I2S configuration and defition of input and output with default values.</div><div class="ttdef"><b>Definition:</b> Driver.h:19</div></div>
159159
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html">audio_driver::DriverPins</a></div><div class="ttdoc">All pins for i2s, spi, i2c and other pins.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:190</div></div>
160-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a50f45551c10ca30a0bc7f447e70188b1"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a50f45551c10ca30a0bc7f447e70188b1">audio_driver::DriverPins::begin</a></div><div class="ttdeci">virtual bool begin()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:276</div></div>
161-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#aaf81d3fdaf258088d7692fa70cece087">audio_driver::DriverPins::end</a></div><div class="ttdeci">void end()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:316</div></div>
162-
<div class="ttc" id="agroup__audio__driver_html_ga0f4a0dbd3aeea6d499d87a62293e012e"><div class="ttname"><a href="group__audio__driver.html#ga0f4a0dbd3aeea6d499d87a62293e012e">audio_driver::PinsLyratMini</a></div><div class="ttdeci">static PinsLyratMiniClass PinsLyratMini</div><div class="ttdef"><b>Definition:</b> DriverPins.h:550</div></div>
160+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a50f45551c10ca30a0bc7f447e70188b1"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a50f45551c10ca30a0bc7f447e70188b1">audio_driver::DriverPins::begin</a></div><div class="ttdeci">virtual bool begin()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:278</div></div>
161+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_aaf81d3fdaf258088d7692fa70cece087"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#aaf81d3fdaf258088d7692fa70cece087">audio_driver::DriverPins::end</a></div><div class="ttdeci">void end()</div><div class="ttdef"><b>Definition:</b> DriverPins.h:318</div></div>
162+
<div class="ttc" id="agroup__audio__driver_html_ga0f4a0dbd3aeea6d499d87a62293e012e"><div class="ttname"><a href="group__audio__driver.html#ga0f4a0dbd3aeea6d499d87a62293e012e">audio_driver::PinsLyratMini</a></div><div class="ttdeci">static PinsLyratMiniClass PinsLyratMini</div><div class="ttdef"><b>Definition:</b> DriverPins.h:552</div></div>
163163
<div class="ttc" id="agroup__audio__driver_html_ga0ffdf5c889c7a240e72df4ce7e323478"><div class="ttname"><a href="group__audio__driver.html#ga0ffdf5c889c7a240e72df4ce7e323478">audio_driver::LyratV43</a></div><div class="ttdeci">static AudioBoard LyratV43</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:65</div></div>
164164
<div class="ttc" id="agroup__audio__driver_html_ga3c281a9dabe9c42b609f386a515d7082"><div class="ttname"><a href="group__audio__driver.html#ga3c281a9dabe9c42b609f386a515d7082">audio_driver::AudioDriverLyratMini</a></div><div class="ttdeci">static AudioDriverLyratMiniClass AudioDriverLyratMini</div><div class="ttdef"><b>Definition:</b> Driver.h:421</div></div>
165165
<div class="ttc" id="agroup__audio__driver_html_ga3ecb4bf2db338ccd232cad96a2e2341e"><div class="ttname"><a href="group__audio__driver.html#ga3ecb4bf2db338ccd232cad96a2e2341e">audio_driver::AudioKitEs8388V2</a></div><div class="ttdeci">static AudioBoard AudioKitEs8388V2</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:61</div></div>
166-
<div class="ttc" id="agroup__audio__driver_html_ga4c69c022bab026eb5d85877b0800771d"><div class="ttname"><a href="group__audio__driver.html#ga4c69c022bab026eb5d85877b0800771d">audio_driver::PinsLyrat42</a></div><div class="ttdeci">static PinsLyrat42Class PinsLyrat42</div><div class="ttdef"><b>Definition:</b> DriverPins.h:548</div></div>
167-
<div class="ttc" id="agroup__audio__driver_html_ga4de967e315821b064d50a78d01877d67"><div class="ttname"><a href="group__audio__driver.html#ga4de967e315821b064d50a78d01877d67">audio_driver::PinsAudioKitAC101</a></div><div class="ttdeci">static PinsAudioKitAC101Class PinsAudioKitAC101</div><div class="ttdef"><b>Definition:</b> DriverPins.h:556</div></div>
168-
<div class="ttc" id="agroup__audio__driver_html_ga61f7164942e4687d3136447ecc1fb78e"><div class="ttname"><a href="group__audio__driver.html#ga61f7164942e4687d3136447ecc1fb78e">audio_driver::PinsLyrat43</a></div><div class="ttdeci">static PinsLyrat43Class PinsLyrat43</div><div class="ttdef"><b>Definition:</b> DriverPins.h:546</div></div>
166+
<div class="ttc" id="agroup__audio__driver_html_ga4c69c022bab026eb5d85877b0800771d"><div class="ttname"><a href="group__audio__driver.html#ga4c69c022bab026eb5d85877b0800771d">audio_driver::PinsLyrat42</a></div><div class="ttdeci">static PinsLyrat42Class PinsLyrat42</div><div class="ttdef"><b>Definition:</b> DriverPins.h:550</div></div>
167+
<div class="ttc" id="agroup__audio__driver_html_ga4de967e315821b064d50a78d01877d67"><div class="ttname"><a href="group__audio__driver.html#ga4de967e315821b064d50a78d01877d67">audio_driver::PinsAudioKitAC101</a></div><div class="ttdeci">static PinsAudioKitAC101Class PinsAudioKitAC101</div><div class="ttdef"><b>Definition:</b> DriverPins.h:558</div></div>
168+
<div class="ttc" id="agroup__audio__driver_html_ga61f7164942e4687d3136447ecc1fb78e"><div class="ttname"><a href="group__audio__driver.html#ga61f7164942e4687d3136447ecc1fb78e">audio_driver::PinsLyrat43</a></div><div class="ttdeci">static PinsLyrat43Class PinsLyrat43</div><div class="ttdef"><b>Definition:</b> DriverPins.h:548</div></div>
169169
<div class="ttc" id="agroup__audio__driver_html_ga6e512f44cc6db0994d6b1617abcc93b0"><div class="ttname"><a href="group__audio__driver.html#ga6e512f44cc6db0994d6b1617abcc93b0">audio_driver::AudioDriverAC101</a></div><div class="ttdeci">static AudioDriverAC101Class AudioDriverAC101</div><div class="ttdef"><b>Definition:</b> Driver.h:413</div></div>
170170
<div class="ttc" id="agroup__audio__driver_html_ga9282e4e123ca2db202b817e95b4c4d6b"><div class="ttname"><a href="group__audio__driver.html#ga9282e4e123ca2db202b817e95b4c4d6b">audio_driver::AudioKitEs8388V1</a></div><div class="ttdeci">static AudioBoard AudioKitEs8388V1</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:59</div></div>
171171
<div class="ttc" id="agroup__audio__driver_html_ga98fa8fe4385c4198150679fddade5eef"><div class="ttname"><a href="group__audio__driver.html#ga98fa8fe4385c4198150679fddade5eef">audio_driver::LyratV42</a></div><div class="ttdeci">static AudioBoard LyratV42</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:67</div></div>
172-
<div class="ttc" id="agroup__audio__driver_html_gaac2b21f064b1a332b2ae9b35fa46484e"><div class="ttname"><a href="group__audio__driver.html#gaac2b21f064b1a332b2ae9b35fa46484e">audio_driver::PinsAudioKitEs8388v1</a></div><div class="ttdeci">static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1</div><div class="ttdef"><b>Definition:</b> DriverPins.h:552</div></div>
172+
<div class="ttc" id="agroup__audio__driver_html_gaac2b21f064b1a332b2ae9b35fa46484e"><div class="ttname"><a href="group__audio__driver.html#gaac2b21f064b1a332b2ae9b35fa46484e">audio_driver::PinsAudioKitEs8388v1</a></div><div class="ttdeci">static PinsAudioKitEs8388v1Class PinsAudioKitEs8388v1</div><div class="ttdef"><b>Definition:</b> DriverPins.h:554</div></div>
173173
<div class="ttc" id="agroup__audio__driver_html_gad1d9b3159991732b6af524c6c8e592f2"><div class="ttname"><a href="group__audio__driver.html#gad1d9b3159991732b6af524c6c8e592f2">audio_driver::LyratMini</a></div><div class="ttdeci">static AudioBoard LyratMini</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:69</div></div>
174174
<div class="ttc" id="agroup__audio__driver_html_gad404af509b8a5ae73c689d6faa3d54df"><div class="ttname"><a href="group__audio__driver.html#gad404af509b8a5ae73c689d6faa3d54df">audio_driver::AudioDriverES8388</a></div><div class="ttdeci">static AudioDriverES8388Class AudioDriverES8388</div><div class="ttdef"><b>Definition:</b> Driver.h:411</div></div>
175-
<div class="ttc" id="agroup__audio__driver_html_gae6031df2ec66c645dd42ae315b79e156"><div class="ttname"><a href="group__audio__driver.html#gae6031df2ec66c645dd42ae315b79e156">audio_driver::NoPins</a></div><div class="ttdeci">static DriverPins NoPins</div><div class="ttdoc">Pins need to be set up in the sketch.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:544</div></div>
175+
<div class="ttc" id="agroup__audio__driver_html_gae6031df2ec66c645dd42ae315b79e156"><div class="ttname"><a href="group__audio__driver.html#gae6031df2ec66c645dd42ae315b79e156">audio_driver::NoPins</a></div><div class="ttdeci">static DriverPins NoPins</div><div class="ttdoc">Pins need to be set up in the sketch.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:546</div></div>
176176
<div class="ttc" id="agroup__audio__driver_html_gaebae1c0395623b4715a91f2f8c64ad6c"><div class="ttname"><a href="group__audio__driver.html#gaebae1c0395623b4715a91f2f8c64ad6c">audio_driver::AudioKitAC101</a></div><div class="ttdeci">static AudioBoard AudioKitAC101</div><div class="ttdef"><b>Definition:</b> AudioBoard.h:63</div></div>
177-
<div class="ttc" id="agroup__audio__driver_html_gaec73d289b40131bb320b17356793430e"><div class="ttname"><a href="group__audio__driver.html#gaec73d289b40131bb320b17356793430e">audio_driver::PinsAudioKitEs8388v2</a></div><div class="ttdeci">static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2</div><div class="ttdef"><b>Definition:</b> DriverPins.h:554</div></div>
177+
<div class="ttc" id="agroup__audio__driver_html_gaec73d289b40131bb320b17356793430e"><div class="ttname"><a href="group__audio__driver.html#gaec73d289b40131bb320b17356793430e">audio_driver::PinsAudioKitEs8388v2</a></div><div class="ttdeci">static PinsAudioKitEs8388v2Class PinsAudioKitEs8388v2</div><div class="ttdef"><b>Definition:</b> DriverPins.h:556</div></div>
178178
<div class="ttc" id="anamespaceaudio__driver_html"><div class="ttname"><a href="namespaceaudio__driver.html">audio_driver</a></div><div class="ttdef"><b>Definition:</b> AudioBoard.h:5</div></div>
179179
</div><!-- fragment --></div><!-- contents -->
180180
<!-- start footer part -->

docs/html/_driver_8h_source.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -550,8 +550,8 @@
550550
<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html_a0eced3855f21d967d42b4c399338d3bf"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html#a0eced3855f21d967d42b4c399338d3bf">audio_driver::CodecConfig::CodecConfig</a></div><div class="ttdeci">CodecConfig()</div><div class="ttdoc">setup default values</div><div class="ttdef"><b>Definition:</b> Driver.h:22</div></div>
551551
<div class="ttc" id="aclassaudio__driver_1_1_codec_config_html_a8fa9926c8f49782f025aa24180d4ca33"><div class="ttname"><a href="classaudio__driver_1_1_codec_config.html#a8fa9926c8f49782f025aa24180d4ca33">audio_driver::CodecConfig::get_mode</a></div><div class="ttdeci">codec_mode_t get_mode()</div><div class="ttdef"><b>Definition:</b> Driver.h:31</div></div>
552552
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html">audio_driver::DriverPins</a></div><div class="ttdoc">All pins for i2s, spi, i2c and other pins.</div><div class="ttdef"><b>Definition:</b> DriverPins.h:190</div></div>
553-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a7154a01dbe248170ce0334042c94cf61"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a7154a01dbe248170ce0334042c94cf61">audio_driver::DriverPins::getPinID</a></div><div class="ttdeci">Pin getPinID(PinFunctionEnum function, int pos=0)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:228</div></div>
554-
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_aea4301085a18ae090ccba2311b93c723"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#aea4301085a18ae090ccba2311b93c723">audio_driver::DriverPins::getI2CPins</a></div><div class="ttdeci">Optional&lt; PinsI2C &gt; getI2CPins(PinFunctionEnum function)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:242</div></div>
553+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_a7154a01dbe248170ce0334042c94cf61"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#a7154a01dbe248170ce0334042c94cf61">audio_driver::DriverPins::getPinID</a></div><div class="ttdeci">Pin getPinID(PinFunctionEnum function, int pos=0)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:237</div></div>
554+
<div class="ttc" id="aclassaudio__driver_1_1_driver_pins_html_aea4301085a18ae090ccba2311b93c723"><div class="ttname"><a href="classaudio__driver_1_1_driver_pins.html#aea4301085a18ae090ccba2311b93c723">audio_driver::DriverPins::getI2CPins</a></div><div class="ttdeci">Optional&lt; PinsI2C &gt; getI2CPins(PinFunctionEnum function)</div><div class="ttdef"><b>Definition:</b> DriverPins.h:244</div></div>
555555
<div class="ttc" id="aetc_8h_html_a08112b4c215e22f499adf9a2b2cd9721"><div class="ttname"><a href="etc_8h.html#a08112b4c215e22f499adf9a2b2cd9721">delay</a></div><div class="ttdeci">void delay(uint32_t)</div></div>
556556
<div class="ttc" id="aetc_8h_html_a5bb885982ff66a2e0a0a45a8ee9c35e2"><div class="ttname"><a href="etc_8h.html#a5bb885982ff66a2e0a0a45a8ee9c35e2">HIGH</a></div><div class="ttdeci">#define HIGH</div><div class="ttdef"><b>Definition:</b> etc.h:7</div></div>
557557
<div class="ttc" id="aetc_8h_html_ab811d8c6ff3a505312d3276590444289"><div class="ttname"><a href="etc_8h.html#ab811d8c6ff3a505312d3276590444289">LOW</a></div><div class="ttdeci">#define LOW</div><div class="ttdef"><b>Definition:</b> etc.h:10</div></div>

0 commit comments

Comments
 (0)