Skip to content

Commit 2b1dec1

Browse files
pschatzmannpschatzmann
committed
logging
1 parent 2e56aa2 commit 2b1dec1

File tree

89 files changed

+3775
-2501
lines changed

Some content is hidden

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

89 files changed

+3775
-2501
lines changed

‎README.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ Functional highlights:
2222
- Supports __PlatformIO__
2323
- Supports __cmake__
2424

25+
## Logger
26+
27+
The application has a built in logger that uses Serial as output. The default log level is Warning. You can initialize the Logger with
28+
```
29+
VS1053Logger.begin(Serial, VS1053Info); // use VS1053Debug, VS1053Info, VS1053Warning, VS1053Error
30+
```
31+
2532
## Documentation
2633

2734
Here is the [relevant class documentation](https://pschatzmann.github.io/arduino-vs1053/doc/html/annotated.html).

‎doc/html/_v_s1053_config_8h_source.html

Lines changed: 41 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.5"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Arduino VS1053: src/VS1053Config.h Source File</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,8 +19,8 @@
1919
<div id="titlearea">
2020
<table cellspacing="0" cellpadding="0">
2121
<tbody>
22-
<tr style="height: 56px;">
23-
<td id="projectalign" style="padding-left: 0.5em;">
22+
<tr id="projectrow">
23+
<td id="projectalign">
2424
<div id="projectname">Arduino VS1053
2525
</div>
2626
</td>
@@ -29,21 +29,22 @@
2929
</table>
3030
</div>
3131
<!-- end header part -->
32-
<!-- Generated by Doxygen 1.9.1 -->
32+
<!-- Generated by Doxygen 1.9.5 -->
3333
<script type="text/javascript">
34-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
34+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35+
var searchBox = new SearchBox("searchBox", "search/",'.html');
3636
/* @license-end */
3737
</script>
3838
<script type="text/javascript" src="menudata.js"></script>
3939
<script type="text/javascript" src="menu.js"></script>
4040
<script type="text/javascript">
41-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4242
$(function() {
4343
initMenu('',true,false,'search.php','Search');
4444
$(document).ready(function() { init_search(); });
4545
});
46-
/* @license-end */</script>
46+
/* @license-end */
47+
</script>
4748
<div id="main-nav"></div>
4849
<!-- window showing the filter options -->
4950
<div id="MSearchSelectWindow"
@@ -54,9 +55,16 @@
5455

5556
<!-- iframe showing the search results (closed by default) -->
5657
<div id="MSearchResultsWindow">
57-
<iframe src="javascript:void(0)" frameborder="0"
58-
name="MSearchResults" id="MSearchResults">
59-
</iframe>
58+
<div id="MSearchResults">
59+
<div class="SRPage">
60+
<div id="SRIndex">
61+
<div id="SRResults"></div>
62+
<div class="SRStatus" id="Loading">Loading...</div>
63+
<div class="SRStatus" id="Searching">Searching...</div>
64+
<div class="SRStatus" id="NoMatches">No Matches</div>
65+
</div>
66+
</div>
67+
</div>
6068
</div>
6169

6270
<div id="nav-path" class="navpath">
@@ -65,31 +73,31 @@
6573
</div>
6674
</div><!-- top -->
6775
<div class="header">
68-
<div class="headertitle">
69-
<div class="title">VS1053Config.h</div> </div>
76+
<div class="headertitle"><div class="title">VS1053Config.h</div></div>
7077
</div><!--header-->
7178
<div class="contents">
72-
<div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="preprocessor">#pragma once</span></div>
73-
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160; </div>
74-
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">// declare namespace</span></div>
75-
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="keyword">namespace </span>arduino_vs1053{}</div>
76-
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160; </div>
77-
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">// Activate/Deactivate Logging in Arduino: Uncomment out define to activate</span></div>
78-
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">// #define DEBUG_PORT Serial</span></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; </div>
81-
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">// I2S Configuration: Use custom SPI Class for ESP</span></div>
82-
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#define USE_ESP_SPI_CUSTOM 0</span></div>
83-
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
84-
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">// In Arduino we usually do not want to work with namespaces. So we bring in the relevant namespace automatically.</span></div>
85-
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;<span class="comment">// Comment out or define VS1053_NO_USING_NAMESPACE if you need to use namespace in sketch</span></div>
86-
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#ifndef VS1053_NO_USING_NAMESPACE</span></div>
87-
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="keyword">using namespace </span>arduino_vs1053;</div>
88-
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;<span class="preprocessor">#endif</span></div>
79+
<div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="preprocessor">#pragma once</span></div>
80+
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span> </div>
81+
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment">// declare namespace</span></div>
82+
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="keyword">namespace </span>arduino_vs1053{}</div>
83+
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span> </div>
84+
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment">// Define Logging Port</span></div>
85+
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef VS1053_LOG_PORT</span></div>
86+
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define VS1053_LOG_PORT Serial</span></div>
87+
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="preprocessor">#endif</span></div>
88+
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
89+
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment">// I2S Configuration: Use custom SPI Class for ESP</span></div>
90+
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#define USE_ESP_SPI_CUSTOM 0</span></div>
91+
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
92+
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment">// In Arduino we usually do not want to work with namespaces. So we bring in the relevant namespace automatically.</span></div>
93+
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment">// Comment out or define VS1053_NO_USING_NAMESPACE if you need to use namespace in sketch</span></div>
94+
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="preprocessor">#ifndef VS1053_NO_USING_NAMESPACE</span></div>
95+
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span><span class="keyword">using namespace </span>arduino_vs1053;</div>
96+
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#endif</span></div>
8997
</div><!-- fragment --></div><!-- contents -->
9098
<!-- start footer part -->
9199
<hr class="footer"/><address class="footer"><small>
92-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
100+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
93101
</small></address>
94102
</body>
95103
</html>

‎doc/html/_v_s1053_driver_8h.html

Lines changed: 28 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
5-
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
6-
<meta name="generator" content="Doxygen 1.9.1"/>
5+
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6+
<meta name="generator" content="Doxygen 1.9.5"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>Arduino VS1053: src/VS1053Driver.h File Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -19,8 +19,8 @@
1919
<div id="titlearea">
2020
<table cellspacing="0" cellpadding="0">
2121
<tbody>
22-
<tr style="height: 56px;">
23-
<td id="projectalign" style="padding-left: 0.5em;">
22+
<tr id="projectrow">
23+
<td id="projectalign">
2424
<div id="projectname">Arduino VS1053
2525
</div>
2626
</td>
@@ -29,21 +29,22 @@
2929
</table>
3030
</div>
3131
<!-- end header part -->
32-
<!-- Generated by Doxygen 1.9.1 -->
32+
<!-- Generated by Doxygen 1.9.5 -->
3333
<script type="text/javascript">
34-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
35-
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
34+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
35+
var searchBox = new SearchBox("searchBox", "search/",'.html');
3636
/* @license-end */
3737
</script>
3838
<script type="text/javascript" src="menudata.js"></script>
3939
<script type="text/javascript" src="menu.js"></script>
4040
<script type="text/javascript">
41-
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&amp;dn=gpl-2.0.txt GPL-v2 */
41+
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
4242
$(function() {
4343
initMenu('',true,false,'search.php','Search');
4444
$(document).ready(function() { init_search(); });
4545
});
46-
/* @license-end */</script>
46+
/* @license-end */
47+
</script>
4748
<div id="main-nav"></div>
4849
<!-- window showing the filter options -->
4950
<div id="MSearchSelectWindow"
@@ -54,9 +55,16 @@
5455

5556
<!-- iframe showing the search results (closed by default) -->
5657
<div id="MSearchResultsWindow">
57-
<iframe src="javascript:void(0)" frameborder="0"
58-
name="MSearchResults" id="MSearchResults">
59-
</iframe>
58+
<div id="MSearchResults">
59+
<div class="SRPage">
60+
<div id="SRIndex">
61+
<div id="SRResults"></div>
62+
<div class="SRStatus" id="Loading">Loading...</div>
63+
<div class="SRStatus" id="Searching">Searching...</div>
64+
<div class="SRStatus" id="NoMatches">No Matches</div>
65+
</div>
66+
</div>
67+
</div>
6068
</div>
6169

6270
<div id="nav-path" class="navpath">
@@ -68,35 +76,34 @@
6876
<div class="summary">
6977
<a href="#nested-classes">Classes</a> &#124;
7078
<a href="#enum-members">Enumerations</a> </div>
71-
<div class="headertitle">
72-
<div class="title">VS1053Driver.h File Reference</div> </div>
79+
<div class="headertitle"><div class="title">VS1053Driver.h File Reference</div></div>
7380
</div><!--header-->
7481
<div class="contents">
7582

7683
<p><a href="_v_s1053_driver_8h_source.html">Go to the source code of this file.</a></p>
7784
<table class="memberdecls">
78-
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
85+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="nested-classes" name="nested-classes"></a>
7986
Classes</h2></td></tr>
8087
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">class &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classarduino__vs1053_1_1_v_s1053.html">arduino_vs1053::VS1053</a></td></tr>
8188
<tr class="memdesc:"><td class="mdescLeft">&#160;</td><td class="mdescRight">Main class for controlling <a class="el" href="classarduino__vs1053_1_1_v_s1053.html" title="Main class for controlling VS1053 and VS1003 modules.">VS1053</a> and VS1003 modules. <a href="classarduino__vs1053_1_1_v_s1053.html#details">More...</a><br /></td></tr>
8289
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
8390
</table><table class="memberdecls">
84-
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
91+
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
8592
Enumerations</h2></td></tr>
86-
<tr class="memitem:a8d24d7d99e5d2c7a890c6f56e1d145c0"><td class="memItemLeft" align="right" valign="top"><a id="a8d24d7d99e5d2c7a890c6f56e1d145c0"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_v_s1053_driver_8h.html#a8d24d7d99e5d2c7a890c6f56e1d145c0">arduino_vs1053::VS1053_I2S_RATE</a> { <b>VS1053_I2S_RATE_192_KHZ</b>
93+
<tr class="memitem:a8d24d7d99e5d2c7a890c6f56e1d145c0"><td class="memItemLeft" align="right" valign="top"><a id="a8d24d7d99e5d2c7a890c6f56e1d145c0" name="a8d24d7d99e5d2c7a890c6f56e1d145c0"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_v_s1053_driver_8h.html#a8d24d7d99e5d2c7a890c6f56e1d145c0">arduino_vs1053::VS1053_I2S_RATE</a> { <b>VS1053_I2S_RATE_192_KHZ</b>
8794
, <b>VS1053_I2S_RATE_96_KHZ</b>
8895
, <b>VS1053_I2S_RATE_48_KHZ</b>
8996
}</td></tr>
9097
<tr class="memdesc:a8d24d7d99e5d2c7a890c6f56e1d145c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">I2S Rate. <br /></td></tr>
9198
<tr class="separator:a8d24d7d99e5d2c7a890c6f56e1d145c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
92-
<tr class="memitem:a83fa36627d8c33e05beacf9731739e48"><td class="memItemLeft" align="right" valign="top"><a id="a83fa36627d8c33e05beacf9731739e48"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_v_s1053_driver_8h.html#a83fa36627d8c33e05beacf9731739e48">arduino_vs1053::VS1053_MODE</a> { <b>VS1053_NA</b>
99+
<tr class="memitem:a83fa36627d8c33e05beacf9731739e48"><td class="memItemLeft" align="right" valign="top"><a id="a83fa36627d8c33e05beacf9731739e48" name="a83fa36627d8c33e05beacf9731739e48"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_v_s1053_driver_8h.html#a83fa36627d8c33e05beacf9731739e48">arduino_vs1053::VS1053_MODE</a> { <b>VS1053_NA</b>
93100
, <b>VS1053_OUT</b>
94101
, <b>VS1053_IN</b>
95102
, <b>VS1053_MIDI</b>
96103
}</td></tr>
97104
<tr class="memdesc:a83fa36627d8c33e05beacf9731739e48"><td class="mdescLeft">&#160;</td><td class="mdescRight">Actual Mode: Input, Output, Output Streaming Midi. <br /></td></tr>
98105
<tr class="separator:a83fa36627d8c33e05beacf9731739e48"><td class="memSeparator" colspan="2">&#160;</td></tr>
99-
<tr class="memitem:a014078781b37e68cdbd78b2ec4dfc25b"><td class="memItemLeft" align="right" valign="top"><a id="a014078781b37e68cdbd78b2ec4dfc25b"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_v_s1053_driver_8h.html#a014078781b37e68cdbd78b2ec4dfc25b">arduino_vs1053::VS1053_EARSPEAKER</a> { <b>VS1053_EARSPEAKER_OFF</b> = 0
106+
<tr class="memitem:a014078781b37e68cdbd78b2ec4dfc25b"><td class="memItemLeft" align="right" valign="top"><a id="a014078781b37e68cdbd78b2ec4dfc25b" name="a014078781b37e68cdbd78b2ec4dfc25b"></a>enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_v_s1053_driver_8h.html#a014078781b37e68cdbd78b2ec4dfc25b">arduino_vs1053::VS1053_EARSPEAKER</a> { <b>VS1053_EARSPEAKER_OFF</b> = 0
100107
, <b>VS1053_EARSPEAKER_MIN</b>
101108
, <b>VS1053_EARSPEAKER_ON</b>
102109
, <b>VS1053_EARSPEAKER_MAX</b>
@@ -107,7 +114,7 @@
107114
</div><!-- contents -->
108115
<!-- start footer part -->
109116
<hr class="footer"/><address class="footer"><small>
110-
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
117+
Generated by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.5
111118
</small></address>
112119
</body>
113120
</html>

0 commit comments

Comments
 (0)