Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@pu2clr
pu2clr committed Aug 6, 2024
1 parent 731a900 commit 7f77561
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
8 changes: 4 additions & 4 deletions extras/apidoc/def/doxygen.def
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1958,7 +1958,7 @@ _EnD_oF_dEf_TeXt_;
_EnD_oF_dEf_TeXt_;
sec-mem-referenceto = {
sec-mem-ref-id = '_q_n8066_8cpp_1ga8a4a20dea21a4dd04cb4836b1514786f';
sec-mem-ref-line = '1349';
sec-mem-ref-line = '1347';
sec-mem-ref-name = 'rdsSetStationName';
};
}; /* sec-member */
Expand All @@ -1983,13 +1983,13 @@ _EnD_oF_dEf_TeXt_;
Sets the station name.
_EnD_oF_dEf_TeXt_;
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
\iline 1344
\iline 1342

@param stationName
_EnD_oF_dEf_TeXt_;
sec-mem-referencedby = {
sec-mem-ref-id = '_q_n8066_8cpp_1ga2beb7d1a42e9aa2ecf72427318b40d1b';
sec-mem-ref-line = '1362';
sec-mem-ref-line = '1360';
sec-mem-ref-name = 'rdsSendPS';
};
}; /* sec-member */
Expand All @@ -2015,7 +2015,7 @@ _EnD_oF_dEf_TeXt_;
Sends RDS Radio Text Message.
_EnD_oF_dEf_TeXt_;
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
\iline 1395
\iline 1398

@param rt
_EnD_oF_dEf_TeXt_;
Expand Down
12 changes: 6 additions & 6 deletions extras/apidoc/html/_q_n8066_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1305,16 +1305,16 @@
<div class="ttc" id="agroup__group04_html_gaf68d40e6fdc7a17cb64d883d93af3886"><div class="ttname"><a href="group__group04.html#gaf68d40e6fdc7a17cb64d883d93af3886">QN8066::setToggleTxPdClear</a></div><div class="ttdeci">void setToggleTxPdClear()</div><div class="ttdoc">TX Audio peak clear signal.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:944</div></div>
<div class="ttc" id="agroup__group05_html_ga0783a3be6aacd1bbff0e5abdfc78d04c"><div class="ttname"><a href="group__group05.html#ga0783a3be6aacd1bbff0e5abdfc78d04c">QN8066::rdsSetInterrupt</a></div><div class="ttdeci">void rdsSetInterrupt(uint8_t value)</div><div class="ttdoc">Sets RDS interrupt.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1053</div></div>
<div class="ttc" id="agroup__group05_html_ga0811c7b248ce2d5b74f584f35907a455"><div class="ttname"><a href="group__group05.html#ga0811c7b248ce2d5b74f584f35907a455">QN8066::rdsInitTx</a></div><div class="ttdeci">void rdsInitTx(uint8_t countryId=0, uint8_t programId=0, uint8_t reference=0)</div><div class="ttdoc">Sets some RDS parameters.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1080</div></div>
<div class="ttc" id="agroup__group05_html_ga085fa9c2b4753a7f7135bd0e7c9b7852"><div class="ttname"><a href="group__group05.html#ga085fa9c2b4753a7f7135bd0e7c9b7852">QN8066::rdsSendRTMessage</a></div><div class="ttdeci">void rdsSendRTMessage(char *rtText)</div><div class="ttdoc">Sends RDS Radio Text Message.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1399</div></div>
<div class="ttc" id="agroup__group05_html_ga085fa9c2b4753a7f7135bd0e7c9b7852"><div class="ttname"><a href="group__group05.html#ga085fa9c2b4753a7f7135bd0e7c9b7852">QN8066::rdsSendRTMessage</a></div><div class="ttdeci">void rdsSendRTMessage(char *rtText)</div><div class="ttdoc">Sends RDS Radio Text Message.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1402</div></div>
<div class="ttc" id="agroup__group05_html_ga0ae8735b4150105b54fc9ace31788e9a"><div class="ttname"><a href="group__group05.html#ga0ae8735b4150105b54fc9ace31788e9a">QN8066::rdsSetMode</a></div><div class="ttdeci">void rdsSetMode(uint8_t mode)</div><div class="ttdoc">Sets RDS Mode Selection.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1002</div></div>
<div class="ttc" id="agroup__group05_html_ga27d182aa90e915b86139d0ae63350fc8"><div class="ttname"><a href="group__group05.html#ga27d182aa90e915b86139d0ae63350fc8">QN8066::rdsSetTxLineIn</a></div><div class="ttdeci">void rdsSetTxLineIn(bool value=0)</div><div class="ttdoc">Audio Line-in enable control.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1256</div></div>
<div class="ttc" id="agroup__group05_html_ga2beb7d1a42e9aa2ecf72427318b40d1b"><div class="ttname"><a href="group__group05.html#ga2beb7d1a42e9aa2ecf72427318b40d1b">QN8066::rdsSendPS</a></div><div class="ttdeci">void rdsSendPS(char *ps=NULL)</div><div class="ttdoc">Sends the Program Service Message.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1362</div></div>
<div class="ttc" id="agroup__group05_html_ga2beb7d1a42e9aa2ecf72427318b40d1b"><div class="ttname"><a href="group__group05.html#ga2beb7d1a42e9aa2ecf72427318b40d1b">QN8066::rdsSendPS</a></div><div class="ttdeci">void rdsSendPS(char *ps=NULL)</div><div class="ttdoc">Sends the Program Service Message.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1360</div></div>
<div class="ttc" id="agroup__group05_html_ga2d13af3ea121fee09799cc0277da0dc1"><div class="ttname"><a href="group__group05.html#ga2d13af3ea121fee09799cc0277da0dc1">QN8066::rdsTxEnable</a></div><div class="ttdeci">void rdsTxEnable(bool value)</div><div class="ttdoc">Transmitter RDS enable.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1120</div></div>
<div class="ttc" id="agroup__group05_html_ga301effc2ac8ceb3359da26fc6e4f8d24"><div class="ttname"><a href="group__group05.html#ga301effc2ac8ceb3359da26fc6e4f8d24">QN8066::rdsGetPTY</a></div><div class="ttdeci">uint8_t rdsGetPTY()</div><div class="ttdoc">Gets the Program Type (PTY)</div><div class="ttdef"><b>Definition:</b> QN8066.h:1010</div></div>
<div class="ttc" id="agroup__group05_html_ga39b9317f050108e7cd4d8695953acd95"><div class="ttname"><a href="group__group05.html#ga39b9317f050108e7cd4d8695953acd95">QN8066::rdsSendGroup</a></div><div class="ttdeci">void rdsSendGroup(uint16_t blockA, uint16_t blockB, uint16_t blockC, uint16_t blockD)</div><div class="ttdoc">Sends a RDS group (four blocks) to the QN8066.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1303</div></div>
<div class="ttc" id="agroup__group05_html_ga39fca640c878f92ed9c15f000620161e"><div class="ttname"><a href="group__group05.html#ga39fca640c878f92ed9c15f000620161e">QN8066::rdsGetError</a></div><div class="ttdeci">uint8_t rdsGetError()</div><div class="ttdoc">Gets TX RDS error setup.</div><div class="ttdef"><b>Definition:</b> QN8066.h:1039</div></div>
<div class="ttc" id="agroup__group05_html_ga662a1d34329657b1d2fbb93f44901bab"><div class="ttname"><a href="group__group05.html#ga662a1d34329657b1d2fbb93f44901bab">QN8066::rdsSetFrequencyDerivation</a></div><div class="ttdeci">void rdsSetFrequencyDerivation(uint8_t freq=6)</div><div class="ttdoc">Sets RDS frequency deviation.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1230</div></div>
<div class="ttc" id="agroup__group05_html_ga8a4a20dea21a4dd04cb4836b1514786f"><div class="ttname"><a href="group__group05.html#ga8a4a20dea21a4dd04cb4836b1514786f">QN8066::rdsSetStationName</a></div><div class="ttdeci">void rdsSetStationName(char *stationName)</div><div class="ttdoc">Sets the station name.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1349</div></div>
<div class="ttc" id="agroup__group05_html_ga8a4a20dea21a4dd04cb4836b1514786f"><div class="ttname"><a href="group__group05.html#ga8a4a20dea21a4dd04cb4836b1514786f">QN8066::rdsSetStationName</a></div><div class="ttdeci">void rdsSetStationName(char *stationName)</div><div class="ttdoc">Sets the station name.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1347</div></div>
<div class="ttc" id="agroup__group05_html_ga8a972dd27044d708e0fcd01e45d3fba0"><div class="ttname"><a href="group__group05.html#ga8a972dd27044d708e0fcd01e45d3fba0">QN8066::rdsGetPS</a></div><div class="ttdeci">char * rdsGetPS()</div><div class="ttdoc">Gets the Program Station (Station Name).</div><div class="ttdef"><b>Definition:</b> QN8066.h:1032</div></div>
<div class="ttc" id="agroup__group05_html_ga8c9d2b0e96785ff740ec0046a7bfe1d7"><div class="ttname"><a href="group__group05.html#ga8c9d2b0e96785ff740ec0046a7bfe1d7">QN8066::rdsSetTxToggle</a></div><div class="ttdeci">uint8_t rdsSetTxToggle()</div><div class="ttdoc">RDS transmitting ready.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1148</div></div>
<div class="ttc" id="agroup__group05_html_gaa49bb620515b40371af65135ad35a759"><div class="ttname"><a href="group__group05.html#gaa49bb620515b40371af65135ad35a759">QN8066::rdsSetTP</a></div><div class="ttdeci">void rdsSetTP(uint16_t tp)</div><div class="ttdoc">Sets the Traffic Program.</div><div class="ttdef"><b>Definition:</b> QN8066.h:1018</div></div>
Expand All @@ -1327,11 +1327,11 @@
<div class="ttc" id="agroup__group05_html_gadae22b8660f72a32479c9fc6c891aff6"><div class="ttname"><a href="group__group05.html#gadae22b8660f72a32479c9fc6c891aff6">QN8066::rdsClearBuffer</a></div><div class="ttdeci">void rdsClearBuffer()</div><div class="ttdoc">Clear RDS register (Buffer)</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1275</div></div>
<div class="ttc" id="agroup__group05_html_gae61a8f8f5af9015db21c0e283deaadb7"><div class="ttname"><a href="group__group05.html#gae61a8f8f5af9015db21c0e283deaadb7">QN8066::rdsSetPI</a></div><div class="ttdeci">void rdsSetPI(uint8_t countryId, uint8_t programId, uint8_t reference=0)</div><div class="ttdoc">Sets the Program Identification (PI)</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1093</div></div>
<div class="ttc" id="agroup__group05_html_gae77d8522db113f8fa9d44ec14f2c3534"><div class="ttname"><a href="group__group05.html#gae77d8522db113f8fa9d44ec14f2c3534">QN8066::rdsSet4KMode</a></div><div class="ttdeci">void rdsSet4KMode(uint8_t value)</div><div class="ttdoc">Sets RDS 4K Mode .</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1027</div></div>
<div class="ttc" id="agroup__group10_html_ga1cbeccfe43f36b25bf01692b25bd12c7"><div class="ttname"><a href="group__group10.html#ga1cbeccfe43f36b25bf01692b25bd12c7">QN8066::resetFsm</a></div><div class="ttdeci">void resetFsm()</div><div class="ttdoc">Resets the state to initial states and recalibrate all blocks.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1479</div></div>
<div class="ttc" id="agroup__group10_html_ga679e38373a2db0083d3f4bde4b6f2f9a"><div class="ttname"><a href="group__group10.html#ga679e38373a2db0083d3f4bde4b6f2f9a">QN8066::getFsmStateCode</a></div><div class="ttdeci">uint8_t getFsmStateCode()</div><div class="ttdoc">Get the FSM State Code.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1468</div></div>
<div class="ttc" id="agroup__group10_html_ga1cbeccfe43f36b25bf01692b25bd12c7"><div class="ttname"><a href="group__group10.html#ga1cbeccfe43f36b25bf01692b25bd12c7">QN8066::resetFsm</a></div><div class="ttdeci">void resetFsm()</div><div class="ttdoc">Resets the state to initial states and recalibrate all blocks.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1483</div></div>
<div class="ttc" id="agroup__group10_html_ga679e38373a2db0083d3f4bde4b6f2f9a"><div class="ttname"><a href="group__group10.html#ga679e38373a2db0083d3f4bde4b6f2f9a">QN8066::getFsmStateCode</a></div><div class="ttdeci">uint8_t getFsmStateCode()</div><div class="ttdoc">Get the FSM State Code.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1472</div></div>
<div class="ttc" id="agroup__group99_html_ga104da6a0d233f020bb63d62e37a7bf92"><div class="ttname"><a href="group__group99.html#ga104da6a0d233f020bb63d62e37a7bf92">QN8066::setI2CLowSpeedMode</a></div><div class="ttdeci">void setI2CLowSpeedMode(void)</div><div class="ttdoc">Sets I2C bus to 10kHz.</div><div class="ttdef"><b>Definition:</b> QN8066.h:1062</div></div>
<div class="ttc" id="agroup__group99_html_ga123240957823800eb7cd05f1e216b30c"><div class="ttname"><a href="group__group99.html#ga123240957823800eb7cd05f1e216b30c">QN8066::setI2CStandardMode</a></div><div class="ttdeci">void setI2CStandardMode(void)</div><div class="ttdoc">Sets I2C bus to 100kHz.</div><div class="ttdef"><b>Definition:</b> QN8066.h:1072</div></div>
<div class="ttc" id="agroup__group99_html_ga2a96d812724a3f6394f6419e2712d6d8"><div class="ttname"><a href="group__group99.html#ga2a96d812724a3f6394f6419e2712d6d8">QN8066::convertToChar</a></div><div class="ttdeci">void convertToChar(uint16_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator='.', bool remove_leading_zeros=true)</div><div class="ttdoc">Converts a number to a char array.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1518</div></div>
<div class="ttc" id="agroup__group99_html_ga2a96d812724a3f6394f6419e2712d6d8"><div class="ttname"><a href="group__group99.html#ga2a96d812724a3f6394f6419e2712d6d8">QN8066::convertToChar</a></div><div class="ttdeci">void convertToChar(uint16_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator='.', bool remove_leading_zeros=true)</div><div class="ttdoc">Converts a number to a char array.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1522</div></div>
<div class="ttc" id="agroup__group99_html_gab3c28cf6010a9cf24243ca9980c841f2"><div class="ttname"><a href="group__group99.html#gab3c28cf6010a9cf24243ca9980c841f2">QN8066::setI2CFastMode</a></div><div class="ttdeci">void setI2CFastMode(void)</div><div class="ttdoc">Sets I2C bus to 400kHz.</div><div class="ttdef"><b>Definition:</b> QN8066.h:1079</div></div>
<div class="ttc" id="agroup__group99_html_gab7dfd8ab098f5cac471e0e25016e63da"><div class="ttname"><a href="group__group99.html#gab7dfd8ab098f5cac471e0e25016e63da">QN8066::setI2CFastModeCustom</a></div><div class="ttdeci">void setI2CFastModeCustom(long value=500000)</div><div class="ttdoc">Sets the I2C bus to a given value. ATTENTION: use this function with caution.</div><div class="ttdef"><b>Definition:</b> QN8066.h:1092</div></div>
</div><!-- fragment --></div><!-- contents -->
Expand Down
2 changes: 1 addition & 1 deletion extras/apidoc/html/group__group10.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -172,7 +172,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga679e38373a2db0083d3f4bd
<div class="ttc" id="agroup__group02_html_gacc2e79aa0134a657191485184b2b603b"><div class="ttname"><a href="group__group02.html#gacc2e79aa0134a657191485184b2b603b">QN8066::setup</a></div><div class="ttdeci">void setup(uint16_t xtalDiv=1000, bool mono=false, bool rds=false, uint8_t PreEmphasis=0, uint8_t xtalInj=0, uint8_t imageRejection=1, uint8_t txSoftClipThreshold=0, uint8_t oneMinutOff=3, uint8_t gainTxPLT=9, uint8_t txFreqDev=125, uint8_t rdsLineIn=0, uint8_t rdsFreqDev=60, uint8_t inInpedance=1, uint8_t txAgcDig=0, uint8_t txAgcBuffer=1, uint8_t txSoftClip=0)</div><div class="ttdoc">QN8066 initial configuration.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:194</div></div>
<div class="ttc" id="agroup__group04_html_ga8ba44d4f2df4cd694886cbe73f73cfaa"><div class="ttname"><a href="group__group04.html#ga8ba44d4f2df4cd694886cbe73f73cfaa">QN8066::setTX</a></div><div class="ttdeci">void setTX(uint16_t frequency)</div><div class="ttdoc">Sets the TX mode.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:274</div></div>
<div class="ttc" id="agroup__group05_html_ga2d13af3ea121fee09799cc0277da0dc1"><div class="ttname"><a href="group__group05.html#ga2d13af3ea121fee09799cc0277da0dc1">QN8066::rdsTxEnable</a></div><div class="ttdeci">void rdsTxEnable(bool value)</div><div class="ttdoc">Transmitter RDS enable.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1120</div></div>
<div class="ttc" id="agroup__group10_html_ga679e38373a2db0083d3f4bde4b6f2f9a"><div class="ttname"><a href="group__group10.html#ga679e38373a2db0083d3f4bde4b6f2f9a">QN8066::getFsmStateCode</a></div><div class="ttdeci">uint8_t getFsmStateCode()</div><div class="ttdoc">Get the FSM State Code.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1468</div></div>
<div class="ttc" id="agroup__group10_html_ga679e38373a2db0083d3f4bde4b6f2f9a"><div class="ttname"><a href="group__group10.html#ga679e38373a2db0083d3f4bde4b6f2f9a">QN8066::getFsmStateCode</a></div><div class="ttdeci">uint8_t getFsmStateCode()</div><div class="ttdoc">Get the FSM State Code.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1472</div></div>
</div><!-- fragment -->
</div>
</div>
Expand Down
2 changes: 1 addition & 1 deletion extras/apidoc/html/group__group99.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -312,7 +312,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ga2a96d812724a3f6394f6419
<div class="ttc" id="aclass_q_n8066_html"><div class="ttname"><a href="class_q_n8066.html">QN8066</a></div><div class="ttdoc">QN8066 Class.</div><div class="ttdef"><b>Definition:</b> QN8066.h:824</div></div>
<div class="ttc" id="agroup__group02_html_gacc2e79aa0134a657191485184b2b603b"><div class="ttname"><a href="group__group02.html#gacc2e79aa0134a657191485184b2b603b">QN8066::setup</a></div><div class="ttdeci">void setup(uint16_t xtalDiv=1000, bool mono=false, bool rds=false, uint8_t PreEmphasis=0, uint8_t xtalInj=0, uint8_t imageRejection=1, uint8_t txSoftClipThreshold=0, uint8_t oneMinutOff=3, uint8_t gainTxPLT=9, uint8_t txFreqDev=125, uint8_t rdsLineIn=0, uint8_t rdsFreqDev=60, uint8_t inInpedance=1, uint8_t txAgcDig=0, uint8_t txAgcBuffer=1, uint8_t txSoftClip=0)</div><div class="ttdoc">QN8066 initial configuration.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:194</div></div>
<div class="ttc" id="agroup__group04_html_ga8ba44d4f2df4cd694886cbe73f73cfaa"><div class="ttname"><a href="group__group04.html#ga8ba44d4f2df4cd694886cbe73f73cfaa">QN8066::setTX</a></div><div class="ttdeci">void setTX(uint16_t frequency)</div><div class="ttdoc">Sets the TX mode.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:274</div></div>
<div class="ttc" id="agroup__group99_html_ga2a96d812724a3f6394f6419e2712d6d8"><div class="ttname"><a href="group__group99.html#ga2a96d812724a3f6394f6419e2712d6d8">QN8066::convertToChar</a></div><div class="ttdeci">void convertToChar(uint16_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator='.', bool remove_leading_zeros=true)</div><div class="ttdoc">Converts a number to a char array.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1518</div></div>
<div class="ttc" id="agroup__group99_html_ga2a96d812724a3f6394f6419e2712d6d8"><div class="ttname"><a href="group__group99.html#ga2a96d812724a3f6394f6419e2712d6d8">QN8066::convertToChar</a></div><div class="ttdeci">void convertToChar(uint16_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator='.', bool remove_leading_zeros=true)</div><div class="ttdoc">Converts a number to a char array.</div><div class="ttdef"><b>Definition:</b> QN8066.cpp:1522</div></div>
</div><!-- fragment --> </td></tr>
</table>
</dd>
Expand Down
2 changes: 1 addition & 1 deletion library.properties
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name=QN8066
version=1.2.4
version=1.2.5
author=Ricardo Lima Caratti, pu2clr@gmail.com
maintainer=Ricardo Lima Caratti
sentence=Control your TX/RX QN8066 device
Expand Down

0 comments on commit 7f77561

Please sign in to comment.