Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
pu2clr committed Nov 13, 2024
1 parent 7605eaa commit 799b01a
Show file tree
Hide file tree
Showing 19 changed files with 1,108 additions and 699 deletions.
501 changes: 321 additions & 180 deletions extras/apidoc/def/doxygen.def

Large diffs are not rendered by default.

48 changes: 48 additions & 0 deletions extras/apidoc/html/_s_i4844_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -201,6 +201,12 @@
<tr class="separator:adb330b20b383f5f664a9b107edef0036"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a6b615b86f7870b616243b25cb5091933"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_i4844_8h.html#a6b615b86f7870b616243b25cb5091933">REFCLK_PRESCALE</a>&#160;&#160;&#160;0x0202</td></tr>
<tr class="separator:a6b615b86f7870b616243b25cb5091933"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab99cdb1908b382e8398decd8fb455fa8"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_i4844_8h.html#ab99cdb1908b382e8398decd8fb455fa8">AM_SOFT_MUTE_RATE</a>&#160;&#160;&#160;0x3300</td></tr>
<tr class="separator:ab99cdb1908b382e8398decd8fb455fa8"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a2d531456d92913b07a7c60b9080a691a"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_i4844_8h.html#a2d531456d92913b07a7c60b9080a691a">AM_SOFT_MUTE_SLOPE</a>&#160;&#160;&#160;0x3301</td></tr>
<tr class="separator:a2d531456d92913b07a7c60b9080a691a"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ab089c66d524223acdad68bfd970603cc"><td class="memItemLeft" align="right" valign="top">#define&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="_s_i4844_8h.html#ab089c66d524223acdad68bfd970603cc">AM_SOFT_MUTE_SNR_THRESHOLD</a>&#160;&#160;&#160;0x3303</td></tr>
<tr class="separator:ab089c66d524223acdad68bfd970603cc"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<hr/><h2 class="groupheader">Data Structure Documentation</h2>
<a name="unionsi4844__firmware__response" id="unionsi4844__firmware__response"></a>
Expand Down Expand Up @@ -641,6 +647,48 @@ <h2 class="memtitle"><span class="permalink"><a href="#a6b615b86f7870b616243b25c
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab99cdb1908b382e8398decd8fb455fa8" name="ab99cdb1908b382e8398decd8fb455fa8"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab99cdb1908b382e8398decd8fb455fa8">&#9670;&#160;</a></span>AM_SOFT_MUTE_RATE</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AM_SOFT_MUTE_RATE&#160;&#160;&#160;0x3300</td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="a2d531456d92913b07a7c60b9080a691a" name="a2d531456d92913b07a7c60b9080a691a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a2d531456d92913b07a7c60b9080a691a">&#9670;&#160;</a></span>AM_SOFT_MUTE_SLOPE</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AM_SOFT_MUTE_SLOPE&#160;&#160;&#160;0x3301</td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
<a id="ab089c66d524223acdad68bfd970603cc" name="ab089c66d524223acdad68bfd970603cc"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ab089c66d524223acdad68bfd970603cc">&#9670;&#160;</a></span>AM_SOFT_MUTE_SNR_THRESHOLD</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define AM_SOFT_MUTE_SNR_THRESHOLD&#160;&#160;&#160;0x3303</td>
</tr>
</table>
</div><div class="memdoc">

</div>
</div>
</div><!-- contents -->
Expand Down
5 changes: 4 additions & 1 deletion extras/apidoc/html/_s_i4844_8h.js
Original file line number Diff line number Diff line change
Expand Up @@ -36,5 +36,8 @@ var _s_i4844_8h =
[ "FM_BLEND_RSSI_STEREO_THRESHOLD", "_s_i4844_8h.html#abf0ee031cf6bb27b0211709117cfcaf0", null ],
[ "FM_BLEND_RSSI_MONO_THRESHOLD", "_s_i4844_8h.html#a8f62bfa609e4deb9febe3a25aae3c6bc", null ],
[ "REFCLK_FREQ", "_s_i4844_8h.html#adb330b20b383f5f664a9b107edef0036", null ],
[ "REFCLK_PRESCALE", "_s_i4844_8h.html#a6b615b86f7870b616243b25cb5091933", null ]
[ "REFCLK_PRESCALE", "_s_i4844_8h.html#a6b615b86f7870b616243b25cb5091933", null ],
[ "AM_SOFT_MUTE_RATE", "_s_i4844_8h.html#ab99cdb1908b382e8398decd8fb455fa8", null ],
[ "AM_SOFT_MUTE_SLOPE", "_s_i4844_8h.html#a2d531456d92913b07a7c60b9080a691a", null ],
[ "AM_SOFT_MUTE_SNR_THRESHOLD", "_s_i4844_8h.html#ab089c66d524223acdad68bfd970603cc", null ]
];
842 changes: 430 additions & 412 deletions extras/apidoc/html/_s_i4844_8h_source.html

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions extras/apidoc/html/class_s_i4844.html
Original file line number Diff line number Diff line change
Expand Up @@ -178,6 +178,15 @@
<tr class="memitem:ga26ac2207be432e5c4587793b3f8b4904"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga26ac2207be432e5c4587793b3f8b4904">setFmSoftMuteSlope</a> (uint8_t value)</td></tr>
<tr class="memdesc:ga26ac2207be432e5c4587793b3f8b4904"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR threshold. <br /></td></tr>
<tr class="separator:ga26ac2207be432e5c4587793b3f8b4904"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf37ee2371cb5c22fca70002c6a70aaee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#gaf37ee2371cb5c22fca70002c6a70aaee">setAmSoftMuteRate</a> (uint8_t value)</td></tr>
<tr class="memdesc:gaf37ee2371cb5c22fca70002c6a70aaee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the attack and decay rates when entering or leaving soft mute. <br /></td></tr>
<tr class="separator:gaf37ee2371cb5c22fca70002c6a70aaee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f2b539247499f7b5b2e9292b89eab09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga7f2b539247499f7b5b2e9292b89eab09">setAmSoftMuteSlope</a> (uint8_t value)</td></tr>
<tr class="memdesc:ga7f2b539247499f7b5b2e9292b89eab09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR threshold. <br /></td></tr>
<tr class="separator:ga7f2b539247499f7b5b2e9292b89eab09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24e79008d80f6344d849dc8011e36b87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga24e79008d80f6344d849dc8011e36b87">setAmSoftMuteSnrThreshold</a> (uint8_t value)</td></tr>
<tr class="memdesc:ga24e79008d80f6344d849dc8011e36b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the SNR threshold to engage soft mute. <br /></td></tr>
<tr class="separator:ga24e79008d80f6344d849dc8011e36b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga536d522d459a7ac501182708f9ecab9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga536d522d459a7ac501182708f9ecab9d">setBlendThresholdStereoIndicator</a> (uint16_t value)</td></tr>
<tr class="memdesc:ga536d522d459a7ac501182708f9ecab9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the blend threshold for stereo indicator. <br /></td></tr>
<tr class="separator:ga536d522d459a7ac501182708f9ecab9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down
3 changes: 3 additions & 0 deletions extras/apidoc/html/class_s_i4844.js
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,9 @@ var class_s_i4844 =
[ "setFmDeemphasis", "group___g_b.html#ga184028717d17cde7ef9993ab967afef5", null ],
[ "setFmSoftMuteRate", "group___g_b.html#ga1e96b962e2e344b1eadeba33cd4bc813", null ],
[ "setFmSoftMuteSlope", "group___g_b.html#ga26ac2207be432e5c4587793b3f8b4904", null ],
[ "setAmSoftMuteRate", "group___g_b.html#gaf37ee2371cb5c22fca70002c6a70aaee", null ],
[ "setAmSoftMuteSlope", "group___g_b.html#ga7f2b539247499f7b5b2e9292b89eab09", null ],
[ "setAmSoftMuteSnrThreshold", "group___g_b.html#ga24e79008d80f6344d849dc8011e36b87", null ],
[ "setBlendThresholdStereoIndicator", "group___g_b.html#ga536d522d459a7ac501182708f9ecab9d", null ],
[ "setCrystalOscillatorEnable", "group___g_b.html#gab97f73b03943a4c0f4dbb3f0741d7263", null ],
[ "setCrystalOscillatorStabilizationWaitTime", "group___g_b.html#gab4e3126da78b0c95cd889dcd20144382", null ],
Expand Down
3 changes: 3 additions & 0 deletions extras/apidoc/html/functions.html
Original file line number Diff line number Diff line change
Expand Up @@ -203,6 +203,9 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>scanI2CBus()&#160;:&#160;<a class="el" href="group___t_o_o_l_s.html#gab400fccf4b3c381c8ee8c060b56eef1b">SI4844</a></li>
<li>sendCommand()&#160;:&#160;<a class="el" href="group___g_b.html#ga8b2c96a6126110589a403751ec12631c">SI4844</a></li>
<li>setAmSoftMuteMaxAttenuation()&#160;:&#160;<a class="el" href="group___g_b.html#ga013c13629b964df2f0023dd0cfee5dfc">SI4844</a></li>
<li>setAmSoftMuteRate()&#160;:&#160;<a class="el" href="group___g_b.html#gaf37ee2371cb5c22fca70002c6a70aaee">SI4844</a></li>
<li>setAmSoftMuteSlope()&#160;:&#160;<a class="el" href="group___g_b.html#ga7f2b539247499f7b5b2e9292b89eab09">SI4844</a></li>
<li>setAmSoftMuteSnrThreshold()&#160;:&#160;<a class="el" href="group___g_b.html#ga24e79008d80f6344d849dc8011e36b87">SI4844</a></li>
<li>setAudioMode()&#160;:&#160;<a class="el" href="group___g_b.html#gadb6affba868c9c99f44918e5a48a423d">SI4844</a></li>
<li>setAudioMute()&#160;:&#160;<a class="el" href="group___g_b.html#gaede56f3b80857296a85ba4613bc87459">SI4844</a></li>
<li>setBand()&#160;:&#160;<a class="el" href="group___g_b.html#ga3de561a939b708030dae788781adf7e0">SI4844</a></li>
Expand Down
3 changes: 3 additions & 0 deletions extras/apidoc/html/functions_func.html
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,9 @@ <h3><a id="index_s" name="index_s"></a>- s -</h3><ul>
<li>scanI2CBus()&#160;:&#160;<a class="el" href="group___t_o_o_l_s.html#gab400fccf4b3c381c8ee8c060b56eef1b">SI4844</a></li>
<li>sendCommand()&#160;:&#160;<a class="el" href="group___g_b.html#ga8b2c96a6126110589a403751ec12631c">SI4844</a></li>
<li>setAmSoftMuteMaxAttenuation()&#160;:&#160;<a class="el" href="group___g_b.html#ga013c13629b964df2f0023dd0cfee5dfc">SI4844</a></li>
<li>setAmSoftMuteRate()&#160;:&#160;<a class="el" href="group___g_b.html#gaf37ee2371cb5c22fca70002c6a70aaee">SI4844</a></li>
<li>setAmSoftMuteSlope()&#160;:&#160;<a class="el" href="group___g_b.html#ga7f2b539247499f7b5b2e9292b89eab09">SI4844</a></li>
<li>setAmSoftMuteSnrThreshold()&#160;:&#160;<a class="el" href="group___g_b.html#ga24e79008d80f6344d849dc8011e36b87">SI4844</a></li>
<li>setAudioMode()&#160;:&#160;<a class="el" href="group___g_b.html#gadb6affba868c9c99f44918e5a48a423d">SI4844</a></li>
<li>setAudioMute()&#160;:&#160;<a class="el" href="group___g_b.html#gaede56f3b80857296a85ba4613bc87459">SI4844</a></li>
<li>setBand()&#160;:&#160;<a class="el" href="group___g_b.html#ga3de561a939b708030dae788781adf7e0">SI4844</a></li>
Expand Down
3 changes: 3 additions & 0 deletions extras/apidoc/html/globals.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@
<div class="contents">
<div class="textblock">Here is a list of all functions, variables, defines, enums, and typedefs with links to the files they belong to:</div><ul>
<li>AM_SOFT_MUTE_MAX_ATTENUATION&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a57030e143a5efa06b9b9cc21b63d0b70">SI4844.h</a></li>
<li>AM_SOFT_MUTE_RATE&#160;:&#160;<a class="el" href="_s_i4844_8h.html#ab99cdb1908b382e8398decd8fb455fa8">SI4844.h</a></li>
<li>AM_SOFT_MUTE_SLOPE&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a2d531456d92913b07a7c60b9080a691a">SI4844.h</a></li>
<li>AM_SOFT_MUTE_SNR_THRESHOLD&#160;:&#160;<a class="el" href="_s_i4844_8h.html#ab089c66d524223acdad68bfd970603cc">SI4844.h</a></li>
<li>ATDD_AUDIO_MODE&#160;:&#160;<a class="el" href="_s_i4844_8h.html#aff9a7b619bbeff035b8f6e25ae58ab24">SI4844.h</a></li>
<li>ATDD_GET_STATUS&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a70824a2c88feb88faf6f55f8a83c10cf">SI4844.h</a></li>
<li>ATDD_POWER_DOWN&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a7aac914d9a51da255a2e19fb1f889d99">SI4844.h</a></li>
Expand Down
3 changes: 3 additions & 0 deletions extras/apidoc/html/globals_defs.html
Original file line number Diff line number Diff line change
Expand Up @@ -92,6 +92,9 @@
<div class="contents">
&#160;<ul>
<li>AM_SOFT_MUTE_MAX_ATTENUATION&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a57030e143a5efa06b9b9cc21b63d0b70">SI4844.h</a></li>
<li>AM_SOFT_MUTE_RATE&#160;:&#160;<a class="el" href="_s_i4844_8h.html#ab99cdb1908b382e8398decd8fb455fa8">SI4844.h</a></li>
<li>AM_SOFT_MUTE_SLOPE&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a2d531456d92913b07a7c60b9080a691a">SI4844.h</a></li>
<li>AM_SOFT_MUTE_SNR_THRESHOLD&#160;:&#160;<a class="el" href="_s_i4844_8h.html#ab089c66d524223acdad68bfd970603cc">SI4844.h</a></li>
<li>ATDD_AUDIO_MODE&#160;:&#160;<a class="el" href="_s_i4844_8h.html#aff9a7b619bbeff035b8f6e25ae58ab24">SI4844.h</a></li>
<li>ATDD_GET_STATUS&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a70824a2c88feb88faf6f55f8a83c10cf">SI4844.h</a></li>
<li>ATDD_POWER_DOWN&#160;:&#160;<a class="el" href="_s_i4844_8h.html#a7aac914d9a51da255a2e19fb1f889d99">SI4844.h</a></li>
Expand Down
99 changes: 99 additions & 0 deletions extras/apidoc/html/group___g_b.html
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,15 @@
<tr class="memitem:ga536d522d459a7ac501182708f9ecab9d"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga536d522d459a7ac501182708f9ecab9d">SI4844::setBlendThresholdStereoIndicator</a> (uint16_t value)</td></tr>
<tr class="memdesc:ga536d522d459a7ac501182708f9ecab9d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the blend threshold for stereo indicator. <br /></td></tr>
<tr class="separator:ga536d522d459a7ac501182708f9ecab9d"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaf37ee2371cb5c22fca70002c6a70aaee"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#gaf37ee2371cb5c22fca70002c6a70aaee">SI4844::setAmSoftMuteRate</a> (uint8_t value)</td></tr>
<tr class="memdesc:gaf37ee2371cb5c22fca70002c6a70aaee"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the attack and decay rates when entering or leaving soft mute. <br /></td></tr>
<tr class="separator:gaf37ee2371cb5c22fca70002c6a70aaee"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga7f2b539247499f7b5b2e9292b89eab09"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga7f2b539247499f7b5b2e9292b89eab09">SI4844::setAmSoftMuteSlope</a> (uint8_t value)</td></tr>
<tr class="memdesc:ga7f2b539247499f7b5b2e9292b89eab09"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR threshold. <br /></td></tr>
<tr class="separator:ga7f2b539247499f7b5b2e9292b89eab09"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga24e79008d80f6344d849dc8011e36b87"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga24e79008d80f6344d849dc8011e36b87">SI4844::setAmSoftMuteSnrThreshold</a> (uint8_t value)</td></tr>
<tr class="memdesc:ga24e79008d80f6344d849dc8011e36b87"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the SNR threshold to engage soft mute. <br /></td></tr>
<tr class="separator:ga24e79008d80f6344d849dc8011e36b87"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga43fab184f53c1f8191f769167934bfd1"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group___g_b.html#ga43fab184f53c1f8191f769167934bfd1">SI4844::setReferenceClockFrequency</a> (uint16_t value)</td></tr>
<tr class="memdesc:ga43fab184f53c1f8191f769167934bfd1"><td class="mdescLeft">&#160;</td><td class="mdescRight">Sets the frequency of the REFCLK from the output of the prescaler. <br /></td></tr>
<tr class="separator:ga43fab184f53c1f8191f769167934bfd1"><td class="memSeparator" colspan="2">&#160;</td></tr>
Expand Down Expand Up @@ -1534,6 +1543,96 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga536d522d459a7ac50118270
</dd>
</dl>

</div>
</div>
<a id="gaf37ee2371cb5c22fca70002c6a70aaee" name="gaf37ee2371cb5c22fca70002c6a70aaee"></a>
<h2 class="memtitle"><span class="permalink"><a href="#gaf37ee2371cb5c22fca70002c6a70aaee">&#9670;&#160;</a></span>setAmSoftMuteRate()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SI4844::setAmSoftMuteRate </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Sets the attack and decay rates when entering or leaving soft mute. </p>
<p>The value specified is multiplied by 4.35 dB/s to come up with the actual attack rate. The CTS bit is set when it is safe to send the next command.</p>
<p>This property may only be set or read when in power up mode. The default rate is 278 dB/s.</p>
<p>Determines how quickly the AM goes into soft mute when soft mute is enabled. The actual rate is calculated by taking the value written to the field</p>
<p>and multiplying it with 4.35 dB/s. The default rate is 278 dB/s (SMRATE[15:0] = 0x0040).</p>
<p>Default: 0x0040; Actual Rate: SMRATE x 4.35; Units: dB/s</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>1–255 </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ga7f2b539247499f7b5b2e9292b89eab09" name="ga7f2b539247499f7b5b2e9292b89eab09"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga7f2b539247499f7b5b2e9292b89eab09">&#9670;&#160;</a></span>setAmSoftMuteSlope()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SI4844::setAmSoftMuteSlope </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR threshold. </p>
<p>Soft mute attenuation is the minimum of SMSLOPE x (SMTHR – SNR) and SMATTN. The recommended SMSLOPE value is CEILING(SMATTN/SMTHR).</p>
<p>SMATTN and SMTHR are set via the AM_SOFT_MUTE_MAX_ATTENUATION and AM_SOFT_MUTE_SNR_THRESHOLD properties. The CTS bit is</p>
<p>set when it is safe to send the next command. This property may only be set or read when in power up mode. The</p>
<p>default slope is 2 dB/dB. Default: 0x0001 Units: dB/dB</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>1–5 </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ga24e79008d80f6344d849dc8011e36b87" name="ga24e79008d80f6344d849dc8011e36b87"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ga24e79008d80f6344d849dc8011e36b87">&#9670;&#160;</a></span>setAmSoftMuteSnrThreshold()</h2>

<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void SI4844::setAmSoftMuteSnrThreshold </td>
<td>(</td>
<td class="paramtype">uint8_t&#160;</td>
<td class="paramname"><em>value</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">

<p>Sets the SNR threshold to engage soft mute. </p>
<p>Whenever the SNR for a tuned frequency drops below this threshold the AM reception will go in soft mute, provided soft mute max attenuation property is non-zero. The CTS bit is set when it is safe to send the next command.</p>
<p>This property may only be set or read when in power up mode. The default SNR threshold is 8.</p>
<p>Default: 0x0008; Units: dB;</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">value</td><td>0–63 </td></tr>
</table>
</dd>
</dl>

</div>
</div>
<a id="ga43fab184f53c1f8191f769167934bfd1" name="ga43fab184f53c1f8191f769167934bfd1"></a>
Expand Down
Loading

0 comments on commit 799b01a

Please sign in to comment.