Skip to content

Commit 63106b3

Browse files
pschatzmannpschatzmann
committed
Readme
1 parent 2ed3d0c commit 63106b3

File tree

257 files changed

+12070
-4593
lines changed

Some content is hidden

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

257 files changed

+12070
-4593
lines changed

‎README.md

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,38 @@ to enable others to understand and reproduce your issue.
5151

5252
Finally, __don't__ send me any e-mails or post questions on my personal website!
5353

54+
## Drivers and Boards
55+
56+
This library privides the following drivers:
57+
58+
- AudioDriverAC101
59+
- AudioDriverAD1938
60+
- AudioDriverCS42448
61+
- AudioDriverCS43l22
62+
- AudioDriverES7210
63+
- AudioDriverES7243
64+
- AudioDriverES7243e
65+
- AudioDriverES8156
66+
- AudioDriverES8311
67+
- AudioDriverES8374
68+
- AudioDriverES8388
69+
- AudioDriverLyratMini
70+
- AudioDriverPCM3168
71+
- AudioDriverWM8960
72+
- AudioDriverWM8978
73+
- AudioDriverWM8994
74+
75+
And it supports the following boards:
76+
77+
- AudioKitAC101 
78+
- AudioKitEs8388V1 
79+
- AudioKitEs8388V2 
80+
- GenericCS43l22 
81+
- GenericWM8960 
82+
- LyratMini
83+
- LyratV42 
84+
- LyratV43 
85+
- NoBoard 
5486

5587
## Installation in Arduino
5688

‎docs/html/_audio_board_8h_source.html

Lines changed: 168 additions & 128 deletions
Large diffs are not rendered by default.

‎docs/html/_audio_driver_config_8h.html

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,14 @@
8080
<tr class="separator:a97f42a9050aeb02705fa0bc7ad10aaef"><td class="memSeparator" colspan="2">&#160;</td></tr>
8181
<tr class="memitem:a2513e2bd0eb45a0ccefbbcd3f289ca47"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a2513e2bd0eb45a0ccefbbcd3f289ca47">DRIVER_DEFAULT_VOLUME</a>&#160;&#160;&#160;70</td></tr>
8282
<tr class="separator:a2513e2bd0eb45a0ccefbbcd3f289ca47"><td class="memSeparator" colspan="2">&#160;</td></tr>
83+
<tr class="memitem:a9d56c6ea19f3b09ed4850731fd1e6726"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a9d56c6ea19f3b09ed4850731fd1e6726">DRIVER_REPORT_DRIVER_VOLUME</a>&#160;&#160;&#160;false</td></tr>
84+
<tr class="separator:a9d56c6ea19f3b09ed4850731fd1e6726"><td class="memSeparator" colspan="2">&#160;</td></tr>
8385
<tr class="memitem:a14378984cebc3425ec1941bb1e0217ef"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a14378984cebc3425ec1941bb1e0217ef">ES8388_DEFAULT_INPUT_GAIN</a>&#160;&#160;&#160;25</td></tr>
8486
<tr class="separator:a14378984cebc3425ec1941bb1e0217ef"><td class="memSeparator" colspan="2">&#160;</td></tr>
8587
<tr class="memitem:a9407f00066bbd25c1bd46d20fa83ddb7"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a9407f00066bbd25c1bd46d20fa83ddb7">ES8388_PA_LINE</a>&#160;&#160;&#160;1</td></tr>
8688
<tr class="separator:a9407f00066bbd25c1bd46d20fa83ddb7"><td class="memSeparator" colspan="2">&#160;</td></tr>
89+
<tr class="memitem:a9ea061072f5a0efeb0ad929f13a29e2e"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_audio_driver_config_8h.html#a9ea061072f5a0efeb0ad929f13a29e2e">FORCE_WIRE_CLOSE</a>&#160;&#160;&#160;false</td></tr>
90+
<tr class="separator:a9ea061072f5a0efeb0ad929f13a29e2e"><td class="memSeparator" colspan="2">&#160;</td></tr>
8791
</table>
8892
<h2 class="groupheader">Macro Definition Documentation</h2>
8993
<a id="a97f42a9050aeb02705fa0bc7ad10aaef"></a>
@@ -112,6 +116,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#a2513e2bd0eb45a0ccefbbcd3
112116
</table>
113117
</div><div class="memdoc">
114118

119+
</div>
120+
</div>
121+
<a id="a9d56c6ea19f3b09ed4850731fd1e6726"></a>
122+
<h2 class="memtitle"><span class="permalink"><a href="#a9d56c6ea19f3b09ed4850731fd1e6726">&#9670;&nbsp;</a></span>DRIVER_REPORT_DRIVER_VOLUME</h2>
123+
124+
<div class="memitem">
125+
<div class="memproto">
126+
<table class="memname">
127+
<tr>
128+
<td class="memname">#define DRIVER_REPORT_DRIVER_VOLUME&#160;&#160;&#160;false</td>
129+
</tr>
130+
</table>
131+
</div><div class="memdoc">
132+
115133
</div>
116134
</div>
117135
<a id="a14378984cebc3425ec1941bb1e0217ef"></a>
@@ -140,6 +158,20 @@ <h2 class="memtitle"><span class="permalink"><a href="#a9407f00066bbd25c1bd46d20
140158
</table>
141159
</div><div class="memdoc">
142160

161+
</div>
162+
</div>
163+
<a id="a9ea061072f5a0efeb0ad929f13a29e2e"></a>
164+
<h2 class="memtitle"><span class="permalink"><a href="#a9ea061072f5a0efeb0ad929f13a29e2e">&#9670;&nbsp;</a></span>FORCE_WIRE_CLOSE</h2>
165+
166+
<div class="memitem">
167+
<div class="memproto">
168+
<table class="memname">
169+
<tr>
170+
<td class="memname">#define FORCE_WIRE_CLOSE&#160;&#160;&#160;false</td>
171+
</tr>
172+
</table>
173+
</div><div class="memdoc">
174+
143175
</div>
144176
</div>
145177
</div><!-- contents -->

‎docs/html/_audio_driver_config_8h_source.html

Lines changed: 29 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -76,28 +76,40 @@
7676
<div class="line"><a name="l00005"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a2513e2bd0eb45a0ccefbbcd3f289ca47"> 5</a></span>&#160;<span class="preprocessor"># define DRIVER_DEFAULT_VOLUME 70</span></div>
7777
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="preprocessor">#endif</span></div>
7878
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160; </div>
79-
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160; </div>
80-
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// To increase the max volume e.g. for ai_thinker (ES8388) 2957 or A202 -&gt; set</span></div>
81-
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// to 1 or 2 0 AUX volume is LINE level 1 you can control the AUX volume with</span></div>
82-
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">// setVolume()</span></div>
83-
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="preprocessor">#ifndef AI_THINKER_ES8388_VOLUME_HACK</span></div>
84-
<div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a97f42a9050aeb02705fa0bc7ad10aaef"> 13</a></span>&#160;<span class="preprocessor"># define AI_THINKER_ES8388_VOLUME_HACK 1</span></div>
85-
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="preprocessor">#endif</span></div>
79+
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">// AudioBoard getVolume() can report the volume reported by the driver or the volume that was last</span></div>
80+
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">// set. When using the driver volume, there might be small rounding errors compared to</span></div>
81+
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// the last defined value.</span></div>
82+
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#ifndef DRIVER_REPORT_DRIVER_VOLUME</span></div>
83+
<div class="line"><a name="l00012"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a9d56c6ea19f3b09ed4850731fd1e6726"> 12</a></span>&#160;<span class="preprocessor"># define DRIVER_REPORT_DRIVER_VOLUME false</span></div>
84+
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif</span></div>
85+
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160; </div>
8686
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160; </div>
87-
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// Define the default gain for the microphone amp (see values from</span></div>
88-
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// es_mic_gain_t) Alternativly you can call es8388_set_mic_gain(es_mic_gain_t</span></div>
89-
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// gain) if you prefer to use value from an comprehensive enum</span></div>
90-
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef ES8388_DEFAULT_INPUT_GAIN</span></div>
91-
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a14378984cebc3425ec1941bb1e0217ef"> 20</a></span>&#160;<span class="preprocessor"># define ES8388_DEFAULT_INPUT_GAIN 25</span></div>
87+
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="comment">// To increase the max volume e.g. for ai_thinker (ES8388) 2957 or A202 -&gt; set</span></div>
88+
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="comment">// to 1 or 2 0 AUX volume is LINE level 1 you can control the AUX volume with</span></div>
89+
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span>&#160;<span class="comment">// setVolume()</span></div>
90+
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;<span class="preprocessor">#ifndef AI_THINKER_ES8388_VOLUME_HACK</span></div>
91+
<div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a97f42a9050aeb02705fa0bc7ad10aaef"> 20</a></span>&#160;<span class="preprocessor"># define AI_THINKER_ES8388_VOLUME_HACK 1</span></div>
9292
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;<span class="preprocessor">#endif</span></div>
9393
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160; </div>
94-
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160; </div>
95-
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// For AI Thinker Audiokit we mute the power amplifier if the line is defined;</span></div>
96-
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// set to -1 to deactivate this functionality</span></div>
97-
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#ifndef ES8388_PA_LINE </span></div>
98-
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a9407f00066bbd25c1bd46d20fa83ddb7"> 27</a></span>&#160;<span class="preprocessor"># define ES8388_PA_LINE 1</span></div>
94+
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span>&#160;<span class="comment">// Define the default gain for the microphone amp (see values from</span></div>
95+
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;<span class="comment">// es_mic_gain_t) Alternativly you can call es8388_set_mic_gain(es_mic_gain_t</span></div>
96+
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160;<span class="comment">// gain) if you prefer to use value from an comprehensive enum</span></div>
97+
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;<span class="preprocessor">#ifndef ES8388_DEFAULT_INPUT_GAIN</span></div>
98+
<div class="line"><a name="l00027"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a14378984cebc3425ec1941bb1e0217ef"> 27</a></span>&#160;<span class="preprocessor"># define ES8388_DEFAULT_INPUT_GAIN 25</span></div>
9999
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span>&#160;<span class="preprocessor">#endif</span></div>
100100
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160; </div>
101+
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160;<span class="comment">// For AI Thinker Audiokit we mute the power amplifier if the line is defined;</span></div>
102+
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;<span class="comment">// set to -1 to deactivate this functionality</span></div>
103+
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;<span class="preprocessor">#ifndef ES8388_PA_LINE</span></div>
104+
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a9407f00066bbd25c1bd46d20fa83ddb7"> 33</a></span>&#160;<span class="preprocessor"># define ES8388_PA_LINE 1</span></div>
105+
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;<span class="preprocessor">#endif</span></div>
106+
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; </div>
107+
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;<span class="comment">// If set to true, call Wire.close() on end: this might cause that the</span></div>
108+
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;<span class="comment">// functionality can not be restarted</span></div>
109+
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span>&#160;<span class="preprocessor">#ifndef FORCE_WIRE_CLOSE</span></div>
110+
<div class="line"><a name="l00039"></a><span class="lineno"><a class="line" href="_audio_driver_config_8h.html#a9ea061072f5a0efeb0ad929f13a29e2e"> 39</a></span>&#160;<span class="preprocessor"># define FORCE_WIRE_CLOSE false</span></div>
111+
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160;<span class="preprocessor">#endif</span></div>
112+
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160; </div>
101113
</div><!-- fragment --></div><!-- contents -->
102114
<!-- start footer part -->
103115
<hr class="footer"/><address class="footer"><small>

0 commit comments

Comments
 (0)