SI4844 Arduino Library

kaledawit · Jul 9, 2020 · 89ce1d9 · 89ce1d9
1 parent 5dd7b5d
commit 89ce1d9
Show file tree

Hide file tree

Showing 51 changed files with 968 additions and 756 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.html b/extras/apidoc/html/class_s_i4844.html
@@ -98,6 +98,12 @@
 <table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
 Public Member Functions</h2></td></tr>
+<tr class="memitem:ga1a00037a2cedbe25d1d53716a1c20c00"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga1a00037a2cedbe25d1d53716a1c20c00">setStatusInterruptFromDevice</a> (bool value)</td></tr>
+<tr class="memdesc:ga1a00037a2cedbe25d1d53716a1c20c00"><td class="mdescLeft">&#160;</td><td class="mdescRight">Set the Data Status From Device. <a href="group___g_b.html#ga1a00037a2cedbe25d1d53716a1c20c00">More...</a><br /></td></tr>
+<tr class="separator:ga1a00037a2cedbe25d1d53716a1c20c00"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga28ec82cb2fd02a0422e8ef3858e5ddcb"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb">getDataStatusInterruptFromDevice</a> ()</td></tr>
+<tr class="memdesc:ga28ec82cb2fd02a0422e8ef3858e5ddcb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Data Status From Device. <a href="group___g_b.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb">More...</a><br /></td></tr>
+<tr class="separator:ga28ec82cb2fd02a0422e8ef3858e5ddcb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gac080ba62ed2de41f80c1fe08135362a3"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#gac080ba62ed2de41f80c1fe08135362a3">setProperty</a> (uint16_t propertyNumber, uint16_t parameter)</td></tr>
 <tr class="memdesc:gac080ba62ed2de41f80c1fe08135362a3"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sends (sets) property to the SI48XX. <a href="group___g_b.html#gac080ba62ed2de41f80c1fe08135362a3">More...</a><br /></td></tr>
 <tr class="separator:gac080ba62ed2de41f80c1fe08135362a3"><td class="memSeparator" colspan="2">&#160;</td></tr>
@@ -111,9 +117,9 @@
 <tr class="memdesc:gaca88698cca086f09f23d29734132bfec"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns with the command response. <br />
  <a href="group___g_b.html#gaca88698cca086f09f23d29734132bfec">More...</a><br /></td></tr>
 <tr class="separator:gaca88698cca086f09f23d29734132bfec"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:ga5953aaaf33a040259ab0fe9edb1f5c4b"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga5953aaaf33a040259ab0fe9edb1f5c4b">setup</a> (uint16_t, uint16_t, byte)</td></tr>
-<tr class="memdesc:ga5953aaaf33a040259ab0fe9edb1f5c4b"><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. <a href="group___g_b.html#ga5953aaaf33a040259ab0fe9edb1f5c4b">More...</a><br /></td></tr>
-<tr class="separator:ga5953aaaf33a040259ab0fe9edb1f5c4b"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga9f4d244f654ac20f2e26508f6a8269ce"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga9f4d244f654ac20f2e26508f6a8269ce">setup</a> (uint16_t resetPin, int interruptPin, byte defaultBand)</td></tr>
+<tr class="memdesc:ga9f4d244f654ac20f2e26508f6a8269ce"><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. <a href="group___g_b.html#ga9f4d244f654ac20f2e26508f6a8269ce">More...</a><br /></td></tr>
+<tr class="separator:ga9f4d244f654ac20f2e26508f6a8269ce"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:gacd42a278c3304a591d80ae7ab351b87a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#gacd42a278c3304a591d80ae7ab351b87a">debugDevice</a> (uint16_t resetPin, uint16_t interruptPin, uint8_t defaultBand, void(*showFunc)(char *msg))</td></tr>
 <tr class="memdesc:gacd42a278c3304a591d80ae7ab351b87a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Used to debug <br />
  <a href="group___g_b.html#gacd42a278c3304a591d80ae7ab351b87a">More...</a><br /></td></tr>
@@ -189,16 +195,18 @@
 <tr class="memdesc:ga2f14c89d348c5e3214615258b8f9c918"><td class="mdescLeft">&#160;</td><td class="mdescRight">set the interrupr status to false. It will turn true after next interrupr <br />
  <a href="group___g_b.html#ga2f14c89d348c5e3214615258b8f9c918">More...</a><br /></td></tr>
 <tr class="separator:ga2f14c89d348c5e3214615258b8f9c918"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a35aa33472f9d23986457ce7850b8175f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_i4844.html#a35aa33472f9d23986457ce7850b8175f">getVolume</a> ()</td></tr>
-<tr class="memdesc:a35aa33472f9d23986457ce7850b8175f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current audio volume level. <a href="class_s_i4844.html#a35aa33472f9d23986457ce7850b8175f">More...</a><br /></td></tr>
-<tr class="separator:a35aa33472f9d23986457ce7850b8175f"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga35aa33472f9d23986457ce7850b8175f"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga35aa33472f9d23986457ce7850b8175f">getVolume</a> ()</td></tr>
+<tr class="memdesc:ga35aa33472f9d23986457ce7850b8175f"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current audio volume level. <a href="group___g_b.html#ga35aa33472f9d23986457ce7850b8175f">More...</a><br /></td></tr>
+<tr class="separator:ga35aa33472f9d23986457ce7850b8175f"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ga44f5b3d8746dc30922cc92e778e98f16"><td class="memItemLeft" align="right" valign="top">uint8_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga44f5b3d8746dc30922cc92e778e98f16">getVolumeProperty</a> ()</td></tr>
 <tr class="memdesc:ga44f5b3d8746dc30922cc92e778e98f16"><td class="mdescLeft">&#160;</td><td class="mdescRight">Gets the current volume value stored in <a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a> device. <a href="group___g_b.html#ga44f5b3d8746dc30922cc92e778e98f16">More...</a><br /></td></tr>
 <tr class="separator:ga44f5b3d8746dc30922cc92e778e98f16"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a179ed56010a980a09fce35da92576793"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_i4844.html#a179ed56010a980a09fce35da92576793">getBandMode</a> ()</td></tr>
-<tr class="separator:a179ed56010a980a09fce35da92576793"><td class="memSeparator" colspan="2">&#160;</td></tr>
-<tr class="memitem:a2429b3d5dffbf52b24792857063ed506"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_i4844.html#a2429b3d5dffbf52b24792857063ed506">getStereoIndicator</a> ()</td></tr>
-<tr class="separator:a2429b3d5dffbf52b24792857063ed506"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga179ed56010a980a09fce35da92576793"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga179ed56010a980a09fce35da92576793">getBandMode</a> ()</td></tr>
+<tr class="memdesc:ga179ed56010a980a09fce35da92576793"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Band Mode. <a href="group___g_b.html#ga179ed56010a980a09fce35da92576793">More...</a><br /></td></tr>
+<tr class="separator:ga179ed56010a980a09fce35da92576793"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:ga2429b3d5dffbf52b24792857063ed506"><td class="memItemLeft" align="right" valign="top">char *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga2429b3d5dffbf52b24792857063ed506">getStereoIndicator</a> ()</td></tr>
+<tr class="memdesc:ga2429b3d5dffbf52b24792857063ed506"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the Stereo Indicator. <a href="group___g_b.html#ga2429b3d5dffbf52b24792857063ed506">More...</a><br /></td></tr>
+<tr class="separator:ga2429b3d5dffbf52b24792857063ed506"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:a1107f15e0f83e4d4f1746086cfd94deb"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_i4844.html#a1107f15e0f83e4d4f1746086cfd94deb">getStatusBCFG0</a> ()</td></tr>
 <tr class="separator:a1107f15e0f83e4d4f1746086cfd94deb"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="memitem:ac64e61270ae4b824f5ebdd5deb7b9547"><td class="memItemLeft" align="right" valign="top">uint16_t&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_s_i4844.html#ac64e61270ae4b824f5ebdd5deb7b9547">getStatusBCFG1</a> ()</td></tr>
@@ -242,84 +250,6 @@
 <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="a35aa33472f9d23986457ce7850b8175f"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a35aa33472f9d23986457ce7850b8175f">&#9670;&nbsp;</a></span>getVolume()</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::getVolume </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">
-
-<p>Gets the current audio volume level. </p>
-<dl class="section return"><dt>Returns</dt><dd>uint8_t </dd></dl>
-
-</div>
-</div>
-<a id="a179ed56010a980a09fce35da92576793"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a179ed56010a980a09fce35da92576793">&#9670;&nbsp;</a></span>getBandMode()</h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">char* SI4844::getBandMode </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="a2429b3d5dffbf52b24792857063ed506"></a>
-<h2 class="memtitle"><span class="permalink"><a href="#a2429b3d5dffbf52b24792857063ed506">&#9670;&nbsp;</a></span>getStereoIndicator()</h2>
-
-<div class="memitem">
-<div class="memproto">
-<table class="mlabels">
- <tr>
- <td class="mlabels-left">
- <table class="memname">
- <tr>
- <td class="memname">char* SI4844::getStereoIndicator </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="a1107f15e0f83e4d4f1746086cfd94deb"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#a1107f15e0f83e4d4f1746086cfd94deb">&#9670;&nbsp;</a></span>getStatusBCFG0()</h2>
 

diff --git a/extras/apidoc/html/class_s_i4844.js b/extras/apidoc/html/class_s_i4844.js
@@ -1,10 +1,12 @@
 var class_s_i4844 =
 [
+ [ "setStatusInterruptFromDevice", "group___g_b.html#ga1a00037a2cedbe25d1d53716a1c20c00", null ],
+ [ "getDataStatusInterruptFromDevice", "group___g_b.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb", null ],
  [ "setProperty", "group___g_b.html#gac080ba62ed2de41f80c1fe08135362a3", null ],
  [ "getProperty", "group___g_b.html#gaf4b90cf2e7a654718e2c65de5def0928", null ],
  [ "sendCommand", "group___g_b.html#ga8b2c96a6126110589a403751ec12631c", null ],
  [ "getCommandResponse", "group___g_b.html#gaca88698cca086f09f23d29734132bfec", null ],
- [ "setup", "group___g_b.html#ga5953aaaf33a040259ab0fe9edb1f5c4b", null ],
+ [ "setup", "group___g_b.html#ga9f4d244f654ac20f2e26508f6a8269ce", null ],
  [ "debugDevice", "group___g_b.html#gacd42a278c3304a591d80ae7ab351b87a", null ],
  [ "reset", "group___g_b.html#ga683a81897fe79e6909817aab36622684", null ],
  [ "setBand", "group___g_b.html#ga3de561a939b708030dae788781adf7e0", null ],
@@ -29,10 +31,10 @@ var class_s_i4844 =
  [ "getFrequency", "group___g_b.html#ga0404927e7414a32125e32ff508bd450e", null ],
  [ "hasStatusChanged", "group___g_b.html#gae362404004bde2ed561a0c34604e0254", null ],
  [ "resetStatus", "group___g_b.html#ga2f14c89d348c5e3214615258b8f9c918", null ],
- [ "getVolume", "class_s_i4844.html#a35aa33472f9d23986457ce7850b8175f", null ],
+ [ "getVolume", "group___g_b.html#ga35aa33472f9d23986457ce7850b8175f", null ],
  [ "getVolumeProperty", "group___g_b.html#ga44f5b3d8746dc30922cc92e778e98f16", null ],
- [ "getBandMode", "class_s_i4844.html#a179ed56010a980a09fce35da92576793", null ],
- [ "getStereoIndicator", "class_s_i4844.html#a2429b3d5dffbf52b24792857063ed506", null ],
+ [ "getBandMode", "group___g_b.html#ga179ed56010a980a09fce35da92576793", null ],
+ [ "getStereoIndicator", "group___g_b.html#ga2429b3d5dffbf52b24792857063ed506", null ],
  [ "getStatusBCFG0", "class_s_i4844.html#a1107f15e0f83e4d4f1746086cfd94deb", null ],
  [ "getStatusBCFG1", "class_s_i4844.html#ac64e61270ae4b824f5ebdd5deb7b9547", null ],
  [ "getStatusStereo", "class_s_i4844.html#a83569342288b86972da112ea14f45095", null ],

diff --git a/extras/apidoc/html/functions.html b/extras/apidoc/html/functions.html
@@ -176,11 +176,14 @@ <h3><a id="index_f"></a>- f -</h3><ul>
 
 <h3><a id="index_g"></a>- g -</h3><ul>
 <li>getBandMode()
-: <a class="el" href="class_s_i4844.html#a179ed56010a980a09fce35da92576793">SI4844</a>
+: <a class="el" href="group___g_b.html#ga179ed56010a980a09fce35da92576793">SI4844</a>
 </li>
 <li>getCommandResponse()
 : <a class="el" href="group___g_b.html#gaca88698cca086f09f23d29734132bfec">SI4844</a>
 </li>
+<li>getDataStatusInterruptFromDevice()
+: <a class="el" href="group___g_b.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb">SI4844</a>
+</li>
 <li>getFirmware()
 : <a class="el" href="group___g_b.html#ga1d119d683bed417b108ef1ccf3a2d20c">SI4844</a>
 </li>
@@ -251,10 +254,10 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 : <a class="el" href="class_s_i4844.html#a83569342288b86972da112ea14f45095">SI4844</a>
 </li>
 <li>getStereoIndicator()
-: <a class="el" href="class_s_i4844.html#a2429b3d5dffbf52b24792857063ed506">SI4844</a>
+: <a class="el" href="group___g_b.html#ga2429b3d5dffbf52b24792857063ed506">SI4844</a>
 </li>
 <li>getVolume()
-: <a class="el" href="class_s_i4844.html#a35aa33472f9d23986457ce7850b8175f">SI4844</a>
+: <a class="el" href="group___g_b.html#ga35aa33472f9d23986457ce7850b8175f">SI4844</a>
 </li>
 <li>getVolumeProperty()
 : <a class="el" href="group___g_b.html#ga44f5b3d8746dc30922cc92e778e98f16">SI4844</a>
@@ -352,8 +355,11 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 <li>setProperty()
 : <a class="el" href="group___g_b.html#gac080ba62ed2de41f80c1fe08135362a3">SI4844</a>
 </li>
+<li>setStatusInterruptFromDevice()
+: <a class="el" href="group___g_b.html#ga1a00037a2cedbe25d1d53716a1c20c00">SI4844</a>
+</li>
 <li>setup()
-: <a class="el" href="group___g_b.html#ga5953aaaf33a040259ab0fe9edb1f5c4b">SI4844</a>
+: <a class="el" href="group___g_b.html#ga9f4d244f654ac20f2e26508f6a8269ce">SI4844</a>
 </li>
 <li>setVolume()
 : <a class="el" href="group___g_b.html#ga65eab6c860e3e11c5d3726144dd3b73d">SI4844</a>

diff --git a/extras/apidoc/html/functions_func.html b/extras/apidoc/html/functions_func.html
@@ -119,11 +119,14 @@ <h3><a id="index_d"></a>- d -</h3><ul>
 
 <h3><a id="index_g"></a>- g -</h3><ul>
 <li>getBandMode()
-: <a class="el" href="class_s_i4844.html#a179ed56010a980a09fce35da92576793">SI4844</a>
+: <a class="el" href="group___g_b.html#ga179ed56010a980a09fce35da92576793">SI4844</a>
 </li>
 <li>getCommandResponse()
 : <a class="el" href="group___g_b.html#gaca88698cca086f09f23d29734132bfec">SI4844</a>
 </li>
+<li>getDataStatusInterruptFromDevice()
+: <a class="el" href="group___g_b.html#ga28ec82cb2fd02a0422e8ef3858e5ddcb">SI4844</a>
+</li>
 <li>getFirmware()
 : <a class="el" href="group___g_b.html#ga1d119d683bed417b108ef1ccf3a2d20c">SI4844</a>
 </li>
@@ -194,10 +197,10 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 : <a class="el" href="class_s_i4844.html#a83569342288b86972da112ea14f45095">SI4844</a>
 </li>
 <li>getStereoIndicator()
-: <a class="el" href="class_s_i4844.html#a2429b3d5dffbf52b24792857063ed506">SI4844</a>
+: <a class="el" href="group___g_b.html#ga2429b3d5dffbf52b24792857063ed506">SI4844</a>
 </li>
 <li>getVolume()
-: <a class="el" href="class_s_i4844.html#a35aa33472f9d23986457ce7850b8175f">SI4844</a>
+: <a class="el" href="group___g_b.html#ga35aa33472f9d23986457ce7850b8175f">SI4844</a>
 </li>
 <li>getVolumeProperty()
 : <a class="el" href="group___g_b.html#ga44f5b3d8746dc30922cc92e778e98f16">SI4844</a>
@@ -263,8 +266,11 @@ <h3><a id="index_s"></a>- s -</h3><ul>
 <li>setProperty()
 : <a class="el" href="group___g_b.html#gac080ba62ed2de41f80c1fe08135362a3">SI4844</a>
 </li>
+<li>setStatusInterruptFromDevice()
+: <a class="el" href="group___g_b.html#ga1a00037a2cedbe25d1d53716a1c20c00">SI4844</a>
+</li>
 <li>setup()
-: <a class="el" href="group___g_b.html#ga5953aaaf33a040259ab0fe9edb1f5c4b">SI4844</a>
+: <a class="el" href="group___g_b.html#ga9f4d244f654ac20f2e26508f6a8269ce">SI4844</a>
 </li>
 <li>setVolume()
 : <a class="el" href="group___g_b.html#ga65eab6c860e3e11c5d3726144dd3b73d">SI4844</a>