Doc

pu2clr · Jan 6, 2025 · 0a660bb · 0a660bb
1 parent b5a6c39
commit 0a660bb
Show file tree

Hide file tree

Showing 17 changed files with 785 additions and 494 deletions.
diff --git a/extras/apidoc/def/doxygen.def b/extras/apidoc/def/doxygen.def
diff --git a/extras/apidoc/html/_s_i4844_8h_source.html b/extras/apidoc/html/_s_i4844_8h_source.html
diff --git a/extras/apidoc/html/class_s_i4844-members.html b/extras/apidoc/html/class_s_i4844-members.html
diff --git a/extras/apidoc/html/class_s_i4844.html b/extras/apidoc/html/class_s_i4844.html
@@ -113,6 +113,9 @@
 <tr class="memitem:ga374db2d27ad97a0a59ebbc6255ea5707"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#ga374db2d27ad97a0a59ebbc6255ea5707">bassTrebleUp</a> ()</td></tr>
 <tr class="memdesc:ga374db2d27ad97a0a59ebbc6255ea5707"><td class="mdescLeft">&#160;</td><td class="mdescRight">More treble, less bass.  <br /></td></tr>
 <tr class="separator:ga374db2d27ad97a0a59ebbc6255ea5707"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:gab2ebde5bc3de157d223c077c7b016c88"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#gab2ebde5bc3de157d223c077c7b016c88">begin</a> (uint16_t resetPin, int interruptPin, uint32_t hightClockSpeed=50000)</td></tr>
+<tr class="memdesc:gab2ebde5bc3de157d223c077c7b016c88"><td class="mdescLeft">&#160;</td><td class="mdescRight">Initiates the <a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a> instance and connect the device (<a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a>) to Arduino.  <br /></td></tr>
+<tr class="separator:gab2ebde5bc3de157d223c077c7b016c88"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga184362ec07964aaf36d27304437fac08"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#ga184362ec07964aaf36d27304437fac08">changeVolume</a> (char)</td></tr>
 <tr class="memdesc:ga184362ec07964aaf36d27304437fac08"><td class="mdescLeft">&#160;</td><td class="mdescRight">Up or down the sound volume level.  <br /></td></tr>
 <tr class="separator:ga184362ec07964aaf36d27304437fac08"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -129,6 +132,8 @@
 <tr class="memitem:ga97b111334d8e6ac08db8c500945c15a8"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#ga97b111334d8e6ac08db8c500945c15a8">getBandMode</a> ()</td></tr>
 <tr class="memdesc:ga97b111334d8e6ac08db8c500945c15a8"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Band Mode.  <br /></td></tr>
 <tr class="separator:ga97b111334d8e6ac08db8c500945c15a8"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ae12799224df69da4204f6fc1d75649b7"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_i4844.html#ae12799224df69da4204f6fc1d75649b7">getBassTreble</a> ()</td></tr>
+<tr class="separator:ae12799224df69da4204f6fc1d75649b7"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaca88698cca086f09f23d29734132bfec"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___b_f.html#gaca88698cca086f09f23d29734132bfec">getCommandResponse</a> (int response_size, uint8_t *response)</td></tr>
 <tr class="memdesc:gaca88698cca086f09f23d29734132bfec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns with the command response. <br  />
   <br /></td></tr>
@@ -214,6 +219,9 @@
 <tr class="memitem:gae362404004bde2ed561a0c34604e0254"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#gae362404004bde2ed561a0c34604e0254">hasStatusChanged</a> (void)</td></tr>
 <tr class="memdesc:gae362404004bde2ed561a0c34604e0254"><td class="mdescLeft">&#160;</td><td class="mdescRight">Checks whether the <a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a> has its status changed.  <br /></td></tr>
 <tr class="separator:gae362404004bde2ed561a0c34604e0254"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga7264a6caa7626678daef61d8f908d612"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#ga7264a6caa7626678daef61d8f908d612">isHostDetectionBandConfig</a> ()</td></tr>
+<tr class="memdesc:ga7264a6caa7626678daef61d8f908d612"><td class="mdescLeft">&#160;</td><td class="mdescRight">Band CFG0 (Band Detection Configuration)  <br /></td></tr>
+<tr class="separator:ga7264a6caa7626678daef61d8f908d612"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gaff14988c6be8a5fb9d1a5e6934dcff47"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b1.html#gaff14988c6be8a5fb9d1a5e6934dcff47">powerDown</a> (void)</td></tr>
 <tr class="memdesc:gaff14988c6be8a5fb9d1a5e6934dcff47"><td class="mdescLeft">&#160;</td><td class="mdescRight">Power the device down.  <br /></td></tr>
 <tr class="separator:gaff14988c6be8a5fb9d1a5e6934dcff47"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -319,6 +327,31 @@
 <div class="textblock"><p><a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a> Class. </p>
 <p>This class implements all functions to help you to control the Si4844 devices. </p>
 </div><h2 class="groupheader">Member Function Documentation</h2>
+<a id="ae12799224df69da4204f6fc1d75649b7" name="ae12799224df69da4204f6fc1d75649b7"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#ae12799224df69da4204f6fc1d75649b7">&#9670;&#160;</a></span>getBassTreble()</h2>
+
+<div class="memitem">
+<div class="memproto">
+<table class="mlabels">
+  <tr>
+  <td class="mlabels-left">
+      <table class="memname">
+        <tr>
+          <td class="memname">uint8_t SI4844::getBassTreble </td>
+          <td>(</td>
+          <td class="paramname"></td><td>)</td>
+          <td></td>
+        </tr>
+      </table>
+  </td>
+  <td class="mlabels-right">
+<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
+  </tr>
+</table>
+</div><div class="memdoc">
+
+</div>
+</div>
 <a id="a4a1426b64c33c34bbdab5f994fba7b5f" name="a4a1426b64c33c34bbdab5f994fba7b5f"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a4a1426b64c33c34bbdab5f994fba7b5f">&#9670;&#160;</a></span>getFirmwareChipRevision()</h2>
 

diff --git a/extras/apidoc/html/class_s_i4844.js b/extras/apidoc/html/class_s_i4844.js
@@ -3,11 +3,13 @@ var class_s_i4844 =
     [ "audioMute", "group___g_b1.html#gacd7984bdca51c53082ab0a67b00244aa", null ],
     [ "bassTrebleDown", "group___g_b1.html#gad45a8797518a831c0320edb9fe9ec1d1", null ],
     [ "bassTrebleUp", "group___g_b1.html#ga374db2d27ad97a0a59ebbc6255ea5707", null ],
+    [ "begin", "group___g_b1.html#gab2ebde5bc3de157d223c077c7b016c88", null ],
     [ "changeVolume", "group___g_b1.html#ga184362ec07964aaf36d27304437fac08", null ],
     [ "convertToChar", "group___t_o_o_l_s.html#ga1abfca870fe9a1feae6e8d56f7af37be", null ],
     [ "debugDevice", "group___g_b1.html#gacd42a278c3304a591d80ae7ab351b87a", null ],
     [ "detectDevice", "group___t_o_o_l_s.html#ga66d670fc742b379c642316daf7df9bca", null ],
     [ "getBandMode", "group___g_b1.html#ga97b111334d8e6ac08db8c500945c15a8", null ],
+    [ "getBassTreble", "class_s_i4844.html#ae12799224df69da4204f6fc1d75649b7", null ],
     [ "getCommandResponse", "group___b_f.html#gaca88698cca086f09f23d29734132bfec", null ],
     [ "getDataStatusInterruptFromDevice", "group___b_f.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb", null ],
     [ "getFirmware", "group___g_b1.html#ga1d119d683bed417b108ef1ccf3a2d20c", null ],
@@ -40,6 +42,7 @@ var class_s_i4844 =
     [ "getVolume", "group___g_b1.html#ga35aa33472f9d23986457ce7850b8175f", null ],
     [ "getVolumeProperty", "group___g_b1.html#ga44f5b3d8746dc30922cc92e778e98f16", null ],
     [ "hasStatusChanged", "group___g_b1.html#gae362404004bde2ed561a0c34604e0254", null ],
+    [ "isHostDetectionBandConfig", "group___g_b1.html#ga7264a6caa7626678daef61d8f908d612", null ],
     [ "powerDown", "group___g_b1.html#gaff14988c6be8a5fb9d1a5e6934dcff47", null ],
     [ "powerUp", "group___g_b1.html#gab19b2ce04e07e23275fea5889b87a201", null ],
     [ "reset", "group___g_b1.html#ga683a81897fe79e6909817aab36622684", null ],

diff --git a/extras/apidoc/html/functions.html b/extras/apidoc/html/functions.html
@@ -105,6 +105,7 @@ <h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
 <li>bassTrebleUp()&#160;:&#160;<a class="el" href="group___g_b1.html#ga374db2d27ad97a0a59ebbc6255ea5707">SI4844</a></li>
 <li>BCFG0&#160;:&#160;<a class="el" href="group___g_a1.html#aff584d438d22709c99c17537cd4d19c2">si4844_get_status</a></li>
 <li>BCFG1&#160;:&#160;<a class="el" href="group___g_a1.html#a24ef7906bfcaa071dfd99c2e198920f1">si4844_get_status</a></li>
+<li>begin()&#160;:&#160;<a class="el" href="group___g_b1.html#gab2ebde5bc3de157d223c077c7b016c88">SI4844</a></li>
 </ul>
 
 
@@ -143,6 +144,7 @@ <h3><a id="index_f" name="index_f"></a>- f -</h3><ul>
 
 <h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
 <li>getBandMode()&#160;:&#160;<a class="el" href="group___g_b1.html#ga97b111334d8e6ac08db8c500945c15a8">SI4844</a></li>
+<li>getBassTreble()&#160;:&#160;<a class="el" href="class_s_i4844.html#ae12799224df69da4204f6fc1d75649b7">SI4844</a></li>
 <li>getCommandResponse()&#160;:&#160;<a class="el" href="group___b_f.html#gaca88698cca086f09f23d29734132bfec">SI4844</a></li>
 <li>getDataStatusInterruptFromDevice()&#160;:&#160;<a class="el" href="group___b_f.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb">SI4844</a></li>
 <li>getFirmware()&#160;:&#160;<a class="el" href="group___g_b1.html#ga1d119d683bed417b108ef1ccf3a2d20c">SI4844</a></li>
@@ -186,6 +188,7 @@ <h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
 
 <h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
 <li>INFORDY&#160;:&#160;<a class="el" href="group___g_a1.html#ae1ae8b6bb0181cbfef784799bcffdf8f">si4844_get_status</a></li>
+<li>isHostDetectionBandConfig()&#160;:&#160;<a class="el" href="group___g_b1.html#ga7264a6caa7626678daef61d8f908d612">SI4844</a></li>
 </ul>
 
 

diff --git a/extras/apidoc/html/functions_func.html b/extras/apidoc/html/functions_func.html
@@ -100,6 +100,7 @@ <h3><a id="index_a" name="index_a"></a>- a -</h3><ul>
 <h3><a id="index_b" name="index_b"></a>- b -</h3><ul>
 <li>bassTrebleDown()&#160;:&#160;<a class="el" href="group___g_b1.html#gad45a8797518a831c0320edb9fe9ec1d1">SI4844</a></li>
 <li>bassTrebleUp()&#160;:&#160;<a class="el" href="group___g_b1.html#ga374db2d27ad97a0a59ebbc6255ea5707">SI4844</a></li>
+<li>begin()&#160;:&#160;<a class="el" href="group___g_b1.html#gab2ebde5bc3de157d223c077c7b016c88">SI4844</a></li>
 </ul>
 
 
@@ -117,6 +118,7 @@ <h3><a id="index_d" name="index_d"></a>- d -</h3><ul>
 
 <h3><a id="index_g" name="index_g"></a>- g -</h3><ul>
 <li>getBandMode()&#160;:&#160;<a class="el" href="group___g_b1.html#ga97b111334d8e6ac08db8c500945c15a8">SI4844</a></li>
+<li>getBassTreble()&#160;:&#160;<a class="el" href="class_s_i4844.html#ae12799224df69da4204f6fc1d75649b7">SI4844</a></li>
 <li>getCommandResponse()&#160;:&#160;<a class="el" href="group___b_f.html#gaca88698cca086f09f23d29734132bfec">SI4844</a></li>
 <li>getDataStatusInterruptFromDevice()&#160;:&#160;<a class="el" href="group___b_f.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb">SI4844</a></li>
 <li>getFirmware()&#160;:&#160;<a class="el" href="group___g_b1.html#ga1d119d683bed417b108ef1ccf3a2d20c">SI4844</a></li>
@@ -156,6 +158,11 @@ <h3><a id="index_h" name="index_h"></a>- h -</h3><ul>
 </ul>
 
 
+<h3><a id="index_i" name="index_i"></a>- i -</h3><ul>
+<li>isHostDetectionBandConfig()&#160;:&#160;<a class="el" href="group___g_b1.html#ga7264a6caa7626678daef61d8f908d612">SI4844</a></li>
+</ul>
+
+
 <h3><a id="index_p" name="index_p"></a>- p -</h3><ul>
 <li>powerDown()&#160;:&#160;<a class="el" href="group___g_b1.html#gaff14988c6be8a5fb9d1a5e6934dcff47">SI4844</a></li>
 <li>powerUp()&#160;:&#160;<a class="el" href="group___g_b1.html#gab19b2ce04e07e23275fea5889b87a201">SI4844</a></li>