Skip to content

Commit

Permalink
Extras
Browse files Browse the repository at this point in the history
  • Loading branch information
@pu2clr
pu2clr committed Jul 8, 2023
1 parent e3af397 commit a3d64b1
Show file tree
Hide file tree
Showing 5 changed files with 8 additions and 8 deletions.
4 changes: 2 additions & 2 deletions extras/apidoc/def/doxygen.def
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4297,7 +4297,7 @@ void loop() {

@see seekStation, seekStationUp, seekStationDown, getStatus, setMaxSeekTime
@param showFunc function that you have to implement to show the frequency during the seeking process. Set NULL if you do not want to show the progress.
@param stopSeeking functionthat you have to implement if you want to control the stop seeking action.
@param stopSeeking functionthat you have to implement if you want to control the stop seeking action. Useful if you want abort the seek process.
@param up_down set up_down = 1 for seeking station up; set up_down = 0 for seeking station down
_EnD_oF_dEf_TeXt_;
}; /* sec-member */
Expand Down Expand Up @@ -4926,7 +4926,7 @@ _EnD_oF_dEf_TeXt_;
sec-mem-desc-file = '/Users/rcaratti/Desenvolvimento/eu/Arduino/DSP/si4735/SI4735/src/SI4735.h';
sec-mem-desc-line = '2407';
sec-mem-briefdesc = <<_EnD_oF_dEf_TeXt_
Starts the control member variables for RDS. It is an alias to RdsInit.
Starts the control member variables for RDS. It is an alias to RdsInit (a better name to RdsInit)
_EnD_oF_dEf_TeXt_;
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
This method is called by setRdsConfig()
Expand Down
4 changes: 2 additions & 2 deletions extras/apidoc/html/_s_i4735_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2496,7 +2496,7 @@
<div class="line"><a id="l02400" name="l02400"></a><span class="lineno"> 2400</span> <span class="keywordtype">void</span> <a class="code hl_function" href="group__group16.html#gaffdba9ca9fb9bf5bb671ac3d448a7e89">RdsInit</a>();</div>
<div class="line"><a id="l02401" name="l02401"></a><span class="lineno"> 2401</span> <span class="comment">/**</span></div>
<div class="line"><span class="lineno"> 2402</span><span class="comment"> * @ingroup group16 RDS setup </span></div>
<div class="line"><span class="lineno"> 2403</span><span class="comment"> * @brief Starts the control member variables for RDS. It is an alias to RdsInit </span></div>
<div class="line"><span class="lineno"> 2403</span><span class="comment"> * @brief Starts the control member variables for RDS. It is an alias to RdsInit (a better name to RdsInit)</span></div>
<div class="line"><span class="lineno"> 2404</span><span class="comment"> * @details This method is called by setRdsConfig()</span></div>
<div class="line"><span class="lineno"> 2405</span><span class="comment"> * @see setRdsConfig()</span></div>
<div class="line"><span class="lineno"> 2406</span><span class="comment"> */</span></div>
Expand Down Expand Up @@ -3291,7 +3291,7 @@
<div class="ttc" id="agroup__group16_html_ga1ab4a1ae27bb27f9bffefa51fab4cfba"><div class="ttname"><a href="group__group16.html#ga1ab4a1ae27bb27f9bffefa51fab4cfba">SI4735::clearRdsStationInformation</a></div><div class="ttdeci">void clearRdsStationInformation()</div><div class="ttdoc">Clear RDS buffer 2B (text / Station INformation 32 bytes)</div><div class="ttdef"><b>Definition:</b> SI4735.h:1161</div></div>
<div class="ttc" id="agroup__group16_html_ga1c0ebbb5eef2b5384c7d1caa9ebe22c0"><div class="ttname"><a href="group__group16.html#ga1c0ebbb5eef2b5384c7d1caa9ebe22c0">SI4735::clearRdsStationName</a></div><div class="ttdeci">void clearRdsStationName()</div><div class="ttdoc">Clear RDS buffer 0A (text / Station Name)</div><div class="ttdef"><b>Definition:</b> SI4735.h:1174</div></div>
<div class="ttc" id="agroup__group16_html_ga1cd6e6388fbb853cc24d3e0dc0df1eb6"><div class="ttname"><a href="group__group16.html#ga1cd6e6388fbb853cc24d3e0dc0df1eb6">SI4735::getEndIndicatorGroupB</a></div><div class="ttdeci">bool getEndIndicatorGroupB()</div><div class="ttdoc">Check if 0xD or 0xA special characters were received for group B.</div><div class="ttdef"><b>Definition:</b> SI4735.h:2548</div></div>
<div class="ttc" id="agroup__group16_html_ga255346df9690b34c305187065466acdb"><div class="ttname"><a href="group__group16.html#ga255346df9690b34c305187065466acdb">SI4735::clearRdsBuffer</a></div><div class="ttdeci">void clearRdsBuffer()</div><div class="ttdoc">Starts the control member variables for RDS. It is an alias to RdsInit.</div><div class="ttdef"><b>Definition:</b> SI4735.h:2407</div></div>
<div class="ttc" id="agroup__group16_html_ga255346df9690b34c305187065466acdb"><div class="ttname"><a href="group__group16.html#ga255346df9690b34c305187065466acdb">SI4735::clearRdsBuffer</a></div><div class="ttdeci">void clearRdsBuffer()</div><div class="ttdoc">Starts the control member variables for RDS. It is an alias to RdsInit (a better name to RdsInit)</div><div class="ttdef"><b>Definition:</b> SI4735.h:2407</div></div>
<div class="ttc" id="agroup__group16_html_ga339af59bbaefd8d60ba9b26e742bc01e"><div class="ttname"><a href="group__group16.html#ga339af59bbaefd8d60ba9b26e742bc01e">SI4735::resetEndIndicatorGroupA</a></div><div class="ttdeci">void resetEndIndicatorGroupA()</div><div class="ttdoc">Resets 0xD or 0xA special characters condition (makes it false)</div><div class="ttdef"><b>Definition:</b> SI4735.h:2537</div></div>
<div class="ttc" id="agroup__group16_html_ga350a2033671a7620d4b9290a2347e185"><div class="ttname"><a href="group__group16.html#ga350a2033671a7620d4b9290a2347e185">SI4735::getRdsStatus</a></div><div class="ttdeci">void getRdsStatus(uint8_t INTACK, uint8_t MTFIFO, uint8_t STATUSONLY)</div><div class="ttdoc">Gets the RDS status. Store the status in currentRdsStatus member. RDS COMMAND FM_RDS_STATUS.</div><div class="ttdef"><b>Definition:</b> SI4735.cpp:2048</div></div>
<div class="ttc" id="agroup__group16_html_ga358ae7318679b5a47b04d1f672bf3257"><div class="ttname"><a href="group__group16.html#ga358ae7318679b5a47b04d1f672bf3257">SI4735::rdsClearInterrupt</a></div><div class="ttdeci">void rdsClearInterrupt()</div><div class="ttdoc">Clears RDSINT.</div><div class="ttdef"><b>Definition:</b> SI4735.h:2596</div></div>
Expand Down
2 changes: 1 addition & 1 deletion extras/apidoc/html/class_s_i4735.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -571,7 +571,7 @@
<tr class="memdesc:gaffdba9ca9fb9bf5bb671ac3d448a7e89"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the control member variables for RDS. <br /></td></tr>
<tr class="separator:gaffdba9ca9fb9bf5bb671ac3d448a7e89"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga255346df9690b34c305187065466acdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group16.html#ga255346df9690b34c305187065466acdb">clearRdsBuffer</a> ()</td></tr>
<tr class="memdesc:ga255346df9690b34c305187065466acdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the control member variables for RDS. It is an alias to RdsInit. <br /></td></tr>
<tr class="memdesc:ga255346df9690b34c305187065466acdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the control member variables for RDS. It is an alias to RdsInit (a better name to RdsInit) <br /></td></tr>
<tr class="separator:ga255346df9690b34c305187065466acdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gaddfe8c89101b4859eca31ad68ad9de2e"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group16.html#gaddfe8c89101b4859eca31ad68ad9de2e">setRdsIntSource</a> (uint8_t RDSRECV, uint8_t RDSSYNCLOST, uint8_t RDSSYNCFOUND, uint8_t RDSNEWBLOCKA, uint8_t RDSNEWBLOCKB)</td></tr>
<tr class="memdesc:gaddfe8c89101b4859eca31ad68ad9de2e"><td class="mdescLeft">&#160;</td><td class="mdescRight">Configures interrupt related to RDS. <br /></td></tr>
Expand Down
2 changes: 1 addition & 1 deletion extras/apidoc/html/group__group08.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3035,7 +3035,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga38f7c7610e05fc67bef6fbb
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">showFunc</td><td>function that you have to implement to show the frequency during the seeking process. Set NULL if you do not want to show the progress. </td></tr>
<tr><td class="paramname">stopSeeking</td><td>functionthat you have to implement if you want to control the stop seeking action. </td></tr>
<tr><td class="paramname">stopSeeking</td><td>functionthat you have to implement if you want to control the stop seeking action. Useful if you want abort the seek process. </td></tr>
<tr><td class="paramname">up_down</td><td>set up_down = 1 for seeking station up; set up_down = 0 for seeking station down </td></tr>
</table>
</dd>
Expand Down
4 changes: 2 additions & 2 deletions extras/apidoc/html/group__group16.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
<tr class="memdesc:ga1c0ebbb5eef2b5384c7d1caa9ebe22c0"><td class="mdescLeft">&#160;</td><td class="mdescRight">Clear RDS buffer 0A (text / Station Name) <br /></td></tr>
<tr class="separator:ga1c0ebbb5eef2b5384c7d1caa9ebe22c0"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga255346df9690b34c305187065466acdb"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group16.html#ga255346df9690b34c305187065466acdb">SI4735::clearRdsBuffer</a> ()</td></tr>
<tr class="memdesc:ga255346df9690b34c305187065466acdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the control member variables for RDS. It is an alias to RdsInit. <br /></td></tr>
<tr class="memdesc:ga255346df9690b34c305187065466acdb"><td class="mdescLeft">&#160;</td><td class="mdescRight">Starts the control member variables for RDS. It is an alias to RdsInit (a better name to RdsInit) <br /></td></tr>
<tr class="separator:ga255346df9690b34c305187065466acdb"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga59122f18fd887bbcb888ecf785871635"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__group16.html#ga59122f18fd887bbcb888ecf785871635">SI4735::rdsBeginQuery</a> ()</td></tr>
<tr class="memdesc:ga59122f18fd887bbcb888ecf785871635"><td class="mdescLeft">&#160;</td><td class="mdescRight">Retrieves the current RDS data to be utilized by other RDS functions. <br /></td></tr>
Expand Down Expand Up @@ -458,7 +458,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga255346df9690b34c3051870
</table>
</div><div class="memdoc">

<p>Starts the control member variables for RDS. It is an alias to RdsInit. </p>
<p>Starts the control member variables for RDS. It is an alias to RdsInit (a better name to RdsInit) </p>
<p>This method is called by <a class="el" href="group__group16.html#gad9718a85c79a311c26997bbda20f2351" title="Sets RDS property.">setRdsConfig()</a> </p><dl class="section see"><dt>See also</dt><dd><a class="el" href="group__group16.html#gad9718a85c79a311c26997bbda20f2351" title="Sets RDS property.">setRdsConfig()</a> </dd></dl>

<p class="reference">References <a class="el" href="group__group16.html#gaffdba9ca9fb9bf5bb671ac3d448a7e89">SI4735::RdsInit()</a>.</p>
Expand Down

0 comments on commit a3d64b1

Please sign in to comment.