Skip to content
This repository has been archived by the owner on Apr 1, 2024. It is now read-only.

Commit

Permalink
doxygen
Browse files Browse the repository at this point in the history
  • Loading branch information
@pschatzmann
pschatzmann committed Jan 24, 2022
1 parent f025c08 commit 3e2ebf7
Show file tree
Hide file tree
Showing 47 changed files with 864 additions and 1,370 deletions.
1,210 changes: 588 additions & 622 deletions docs/html/_audio_kit_h_a_l_8h_source.html
View file

Large diffs are not rendered by default.

29 changes: 19 additions & 10 deletions docs/html/_audio_kit_settings_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -72,40 +72,49 @@
</div><!--header-->
<div class="contents">

<p>AUDIOKIT_BOARD selects a specic board: 1) lyrat_v4_3 2) lyrat_v4_2 3) lyrat_mini_v1_1 4) esp32_s2_kaluga_1_v1_2 5) ai_thinker_v2_2 6) generci_es8388.
<p>AUDIOKIT_BOARD selects a specic board: 1) lyrat_v4_3 2) lyrat_v4_2 3) lyrat_mini_v1_1 4) esp32_s2_kaluga_1_v1_2 5) ai_thinker_v2_2 (ES8388) 6) ai_thinker_v2_2 (AC101) DRAFT UNTESTED ! 7) generci_es8388.
<a href="#details">More...</a></p>

<p><a href="_audio_kit_settings_8h_source.html">Go to the source code of this file.</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:a66363d30d5b05c1859ed60e835152311"><td class="memItemLeft" align="right" valign="top"><a id="a66363d30d5b05c1859ed60e835152311"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_BOARD</b>&#160;&#160;&#160;6</td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_BOARD</b>&#160;&#160;&#160;5</td></tr>
<tr class="separator:a66363d30d5b05c1859ed60e835152311"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a10053509f78c1b67735395cadf127ee4"><td class="memItemLeft" align="right" valign="top"><a id="a10053509f78c1b67735395cadf127ee4"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_INPUT</b>&#160;&#160;&#160;<a class="el" href="audio__hal_8h.html#a646b0eb34cb010bc893c9df838263803a684352f80f3627d3c2169f147bb4f981">AUDIO_HAL_ADC_INPUT_LINE1</a></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_INPUT</b>&#160;&#160;&#160;AUDIO_HAL_ADC_INPUT_LINE1</td></tr>
<tr class="separator:a10053509f78c1b67735395cadf127ee4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a894911cf0322701bcae9c3450f7c0a5b"><td class="memItemLeft" align="right" valign="top"><a id="a894911cf0322701bcae9c3450f7c0a5b"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_OUTPUT</b>&#160;&#160;&#160;<a class="el" href="audio__hal_8h.html#a317f8679b6dd58c7718254d307ab7ee3a75f5a0748e8098b3e7f57b7512124dc0">AUDIO_HAL_DAC_OUTPUT_ALL</a></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_OUTPUT</b>&#160;&#160;&#160;AUDIO_HAL_DAC_OUTPUT_ALL</td></tr>
<tr class="separator:a894911cf0322701bcae9c3450f7c0a5b"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a1200fa0cc6be9707df750614b5894575"><td class="memItemLeft" align="right" valign="top"><a id="a1200fa0cc6be9707df750614b5894575"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_MASTER_SLAVE</b>&#160;&#160;&#160;<a class="el" href="audio__hal_8h.html#a2cb0f5e3b3b526df661edb765ce4e3c1aae313fc5c8c2b855e94b531f40de3a6a">AUDIO_HAL_MODE_SLAVE</a></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_MASTER_SLAVE</b>&#160;&#160;&#160;AUDIO_HAL_MODE_SLAVE</td></tr>
<tr class="separator:a1200fa0cc6be9707df750614b5894575"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a687f6abd9b924961ac35f8f570cb64da"><td class="memItemLeft" align="right" valign="top"><a id="a687f6abd9b924961ac35f8f570cb64da"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_RATE</b>&#160;&#160;&#160;<a class="el" href="audio__hal_8h.html#a8f3fc5b0a48e5469ac62f4b1ffa0dc8aaf8e5bab026b69818030d88485a9624d1">AUDIO_HAL_44K_SAMPLES</a></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_RATE</b>&#160;&#160;&#160;AUDIO_HAL_44K_SAMPLES</td></tr>
<tr class="separator:a687f6abd9b924961ac35f8f570cb64da"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a875b0ba9b843a17cc56d7c5cd897cda1"><td class="memItemLeft" align="right" valign="top"><a id="a875b0ba9b843a17cc56d7c5cd897cda1"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_BITSIZE</b>&#160;&#160;&#160;<a class="el" href="audio__hal_8h.html#a24dda9ff64235c14cd479049893e675ba2cf1749f48761214db79fa53b002ab60">AUDIO_HAL_BIT_LENGTH_16BITS</a></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_BITSIZE</b>&#160;&#160;&#160;AUDIO_HAL_BIT_LENGTH_16BITS</td></tr>
<tr class="separator:a875b0ba9b843a17cc56d7c5cd897cda1"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:af5e73e9057fbbbe7534505021cd2a7a7"><td class="memItemLeft" align="right" valign="top"><a id="af5e73e9057fbbbe7534505021cd2a7a7"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_I2S_FMT</b>&#160;&#160;&#160;<a class="el" href="audio__hal_8h.html#aa5528ef3dfd90c5216c732b69c936a8dae838beeebda2c1f39d4e83e00823e1e7">AUDIO_HAL_I2S_NORMAL</a></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_DEFAULT_I2S_FMT</b>&#160;&#160;&#160;AUDIO_HAL_I2S_NORMAL</td></tr>
<tr class="separator:af5e73e9057fbbbe7534505021cd2a7a7"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9bd5f676e2c75d7595e37f502ed74779"><td class="memItemLeft" align="right" valign="top"><a id="a9bd5f676e2c75d7595e37f502ed74779"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_USE_WIRE</b></td></tr>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_USE_WIRE</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a9bd5f676e2c75d7595e37f502ed74779"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a4f9d4467b0914fc8c828aacfb883bfbd"><td class="memItemLeft" align="right" valign="top"><a id="a4f9d4467b0914fc8c828aacfb883bfbd"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_FREE_RTOS</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a4f9d4467b0914fc8c828aacfb883bfbd"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:adbb933b0fcc77fc74812fd048739ac63"><td class="memItemLeft" align="right" valign="top"><a id="adbb933b0fcc77fc74812fd048739ac63"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_MUTEX_SUPPORT</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:adbb933b0fcc77fc74812fd048739ac63"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a0cc1439a7a70e79968b608bdeaee507e"><td class="memItemLeft" align="right" valign="top"><a id="a0cc1439a7a70e79968b608bdeaee507e"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>AUDIOKIT_SETUP_SD</b>&#160;&#160;&#160;1</td></tr>
<tr class="separator:a0cc1439a7a70e79968b608bdeaee507e"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>AUDIOKIT_BOARD selects a specic board: 1) lyrat_v4_3 2) lyrat_v4_2 3) lyrat_mini_v1_1 4) esp32_s2_kaluga_1_v1_2 5) ai_thinker_v2_2 6) generci_es8388. </p>
<div class="textblock"><p>AUDIOKIT_BOARD selects a specic board: 1) lyrat_v4_3 2) lyrat_v4_2 3) lyrat_mini_v1_1 4) esp32_s2_kaluga_1_v1_2 5) ai_thinker_v2_2 (ES8388) 6) ai_thinker_v2_2 (AC101) DRAFT UNTESTED ! 7) generci_es8388. </p>
<dl class="section author"><dt>Author</dt><dd>Phil Schatzmann </dd></dl>
<dl class="section version"><dt>Version</dt><dd>0.1 </dd></dl>
<dl class="section date"><dt>Date</dt><dd>2021-12-12</dd></dl>
Expand Down
74 changes: 38 additions & 36 deletions docs/html/_audio_kit_settings_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,43 +77,45 @@
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment"> * 2) lyrat_v4_2</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment"> * 3) lyrat_mini_v1_1</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment"> * 4) esp32_s2_kaluga_1_v1_2</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * 5) ai_thinker_v2_2</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * 6) generci_es8388</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * @version 0.1</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * @date 2021-12-12</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * @copyright Copyright (c) 2021</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160; </div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160; </div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef AUDIOKIT_BOARD</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#define AUDIOKIT_BOARD 6</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// Default settings</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_INPUT AUDIO_HAL_ADC_INPUT_LINE1</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_OUTPUT AUDIO_HAL_DAC_OUTPUT_ALL</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_MASTER_SLAVE AUDIO_HAL_MODE_SLAVE</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_RATE AUDIO_HAL_44K_SAMPLES</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_BITSIZE AUDIO_HAL_BIT_LENGTH_16BITS</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_I2S_FMT AUDIO_HAL_I2S_NORMAL</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// Activate or deactivate the following</span></div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#define AUDIOKIT_USE_WIRE</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160; </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160; </div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#ifdef ESP32</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="preprocessor">#define AUDIOKIT_FREE_RTOS</span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#define AUDIOKIT_MUTEX_SUPPORT</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define AUDIOKIT_SETUP_SD</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#define PIN_AUDIO_KIT_SD_CARD_CS 13</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#define PIN_AUDIO_KIT_SD_CARD_MISO 2</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#define PIN_AUDIO_KIT_SD_CARD_MOSI 15</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define PIN_AUDIO_KIT_SD_CARD_CLK 14</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#else</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment"> * 5) ai_thinker_v2_2 (ES8388)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment"> * 6) ai_thinker_v2_2 (AC101) DRAFT UNTESTED !</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment"> * 7) generci_es8388</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment"> * @version 0.1</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment"> * @date 2021-12-12</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment"> * </span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="comment"> * @copyright Copyright (c) 2021</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment"> */</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160; </div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="preprocessor">#pragma once</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160; </div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160;<span class="preprocessor">#ifndef AUDIOKIT_BOARD</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#define AUDIOKIT_BOARD 5</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// Default settings</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_INPUT AUDIO_HAL_ADC_INPUT_LINE1</span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_OUTPUT AUDIO_HAL_DAC_OUTPUT_ALL</span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_MASTER_SLAVE AUDIO_HAL_MODE_SLAVE</span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_RATE AUDIO_HAL_44K_SAMPLES</span></div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_BITSIZE AUDIO_HAL_BIT_LENGTH_16BITS</span></div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="preprocessor">#define AUDIOKIT_DEFAULT_I2S_FMT AUDIO_HAL_I2S_NORMAL</span></div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160; </div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="comment">// 1 = Using Arduino Wire Library; 0 = Use ESP32 I2C API</span></div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span>&#160;<span class="preprocessor">#ifndef AUDIOKIT_USE_WIRE</span></div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#define AUDIOKIT_USE_WIRE 1</span></div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160; </div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="preprocessor">#ifndef AUDIOKIT_FREE_RTOS</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#define AUDIOKIT_FREE_RTOS 1</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; </div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;<span class="preprocessor">#ifndef AUDIOKIT_MUTEX_SUPPORT</span></div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;<span class="preprocessor">#define AUDIOKIT_MUTEX_SUPPORT 1</span></div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160; </div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#endif</span></div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160;<span class="preprocessor">#ifndef AUDIOKIT_SETUP_SD</span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;<span class="preprocessor">#define AUDIOKIT_SETUP_SD 1</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;<span class="preprocessor">#endif</span></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Expand Down
Loading

0 comments on commit 3e2ebf7

Please sign in to comment.