Skip to content

Commit e1cbd43

Browse files
pu2clrpu2clr
committed
RDA5807 Arduino Library
1 parent cc90d2a commit e1cbd43

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

48 files changed

+1941
-1727
lines changed

‎extras/apidoc/def/doxygen.def

+46-6
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,8 @@ _EnD_oF_dEf_TeXt_;
2525
Set the Delay After Crystal On (default 500ms)
2626
_EnD_oF_dEf_TeXt_;
2727
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
28+
\iline 615
29+
2830
@param ms_value Value in milliseconds
2931
_EnD_oF_dEf_TeXt_;
3032
}; /* sec-member */
@@ -188,6 +190,8 @@ _EnD_oF_dEf_TeXt_;
188190
Sets a given value to a specific device register.
189191
_EnD_oF_dEf_TeXt_;
190192
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
193+
\iline 107
194+
191195
@see RDA5807M - SINGLE-CHIP BROADCAST FMRADIO TUNER; pages 5, 9, 10 and 11.
192196
@see rda_reg02, rda_reg03, rda_reg04, rda_reg05, rda_reg06, rda_reg07
193197

@@ -398,6 +402,8 @@ _EnD_oF_dEf_TeXt_;
398402
Sets new demodulate method. It can improve the receiver sensitivity about 1dB.
399403
_EnD_oF_dEf_TeXt_;
400404
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
405+
\iline 184
406+
401407
@param value true or false
402408
_EnD_oF_dEf_TeXt_;
403409
}; /* sec-member */
@@ -523,6 +529,8 @@ _EnD_oF_dEf_TeXt_;
523529
Gets the current channel stored in 0x0A status register.
524530
_EnD_oF_dEf_TeXt_;
525531
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
532+
\iline 298
533+
526534
@see setChannel, setFrequency, setBand, setSpace
527535
@see RDA5807M - SINGLE-CHIP BROADCAST FM RADIO TUNER - Rev.1.1–Aug.2015; pages 9 and 12.
528536

@@ -592,6 +600,8 @@ _EnD_oF_dEf_TeXt_;
592600
Seek function.
593601
_EnD_oF_dEf_TeXt_;
594602
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
603+
\iline 333
604+
595605
@param seek_mode if 0, wrap at the upper or lower band limit and continue seeking; 1 = stop seeking at the upper or lower band limit <br>
596606
@param direction if 0, seek down; if 1, seek up.
597607
_EnD_oF_dEf_TeXt_;
@@ -712,6 +722,8 @@ _EnD_oF_dEf_TeXt_;
712722
Sets the FM band. See table below.
713723
_EnD_oF_dEf_TeXt_;
714724
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
725+
\iline 414
726+
715727
FM band table
716728

717729
<table class="markdownTable">
@@ -748,6 +760,8 @@ _EnD_oF_dEf_TeXt_;
748760
Sets the FM channel space.
749761
_EnD_oF_dEf_TeXt_;
750762
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
763+
\iline 436
764+
751765
Channel space table
752766

753767
<table class="markdownTable">
@@ -892,6 +906,8 @@ _EnD_oF_dEf_TeXt_;
892906
Sets audio Mono or stereo.
893907
_EnD_oF_dEf_TeXt_;
894908
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
909+
\iline 528
910+
895911
@param value TRUE = Mono; FALSE force stereo
896912
_EnD_oF_dEf_TeXt_;
897913
}; /* sec-member */
@@ -916,6 +932,8 @@ _EnD_oF_dEf_TeXt_;
916932
Sets Bass Boost.
917933
_EnD_oF_dEf_TeXt_;
918934
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
935+
\iline 541
936+
919937
@param value FALSE = Disable; TRUE = Enable
920938
_EnD_oF_dEf_TeXt_;
921939
}; /* sec-member */
@@ -934,6 +952,8 @@ _EnD_oF_dEf_TeXt_;
934952
Gets the current Stereo status.
935953
_EnD_oF_dEf_TeXt_;
936954
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
955+
\iline 554
956+
937957
@return TRUE if stereo;
938958
_EnD_oF_dEf_TeXt_;
939959
}; /* sec-member */
@@ -1026,6 +1046,8 @@ _EnD_oF_dEf_TeXt_;
10261046
Sets the audio volume level.
10271047
_EnD_oF_dEf_TeXt_;
10281048
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1049+
\iline 580
1050+
10291051
@param value
10301052
_EnD_oF_dEf_TeXt_;
10311053
}; /* sec-member */
@@ -1044,6 +1066,8 @@ _EnD_oF_dEf_TeXt_;
10441066
Gets the current audio volume level.
10451067
_EnD_oF_dEf_TeXt_;
10461068
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1069+
\iline 594
1070+
10471071
@return uint8_t 0 to 15
10481072
_EnD_oF_dEf_TeXt_;
10491073
}; /* sec-member */
@@ -1062,7 +1086,7 @@ _EnD_oF_dEf_TeXt_;
10621086
Increments the audio volume.
10631087
_EnD_oF_dEf_TeXt_;
10641088
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1065-
1089+
\iline 605
10661090
_EnD_oF_dEf_TeXt_;
10671091
}; /* sec-member */
10681092
sec-member = {
@@ -1080,7 +1104,7 @@ _EnD_oF_dEf_TeXt_;
10801104
Decrements the audio volume.
10811105
_EnD_oF_dEf_TeXt_;
10821106
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1083-
1107+
\iline 619
10841108
_EnD_oF_dEf_TeXt_;
10851109
}; /* sec-member */
10861110
sec-member = {
@@ -1182,6 +1206,8 @@ _EnD_oF_dEf_TeXt_;
11821206
Sets RDS fifo mode enable.
11831207
_EnD_oF_dEf_TeXt_;
11841208
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1209+
\iline 1068
1210+
11851211
@param value If true, it makes the the fifo mode enable.
11861212
@return true or false
11871213
_EnD_oF_dEf_TeXt_;
@@ -1201,6 +1227,8 @@ _EnD_oF_dEf_TeXt_;
12011227
Clear RDS fifo.
12021228
_EnD_oF_dEf_TeXt_;
12031229
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1230+
\iline 1080
1231+
12041232
@param value If true, it makes the the fifo mode enable.
12051233
@return true or false
12061234
_EnD_oF_dEf_TeXt_;
@@ -1297,6 +1325,8 @@ _EnD_oF_dEf_TeXt_;
12971325
Return the group type.
12981326
_EnD_oF_dEf_TeXt_;
12991327
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1328+
\iline 723
1329+
13001330
@return uint16_t
13011331
_EnD_oF_dEf_TeXt_;
13021332
sec-mem-referenceto = {
@@ -1390,6 +1420,8 @@ _EnD_oF_dEf_TeXt_;
13901420
Process data received from group 2A.
13911421
_EnD_oF_dEf_TeXt_;
13921422
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1423+
\iline 803
1424+
13931425
@param c char array reference to the "group 2A" text
13941426
_EnD_oF_dEf_TeXt_;
13951427
sec-mem-referencedby = {
@@ -1456,7 +1488,7 @@ _EnD_oF_dEf_TeXt_;
14561488
Gets the station name and other messages.
14571489
_EnD_oF_dEf_TeXt_;
14581490
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1459-
\xrefitem todo 5.
1491+
\xrefitem todo 5.\iline 867
14601492

14611493
@return char* should return a string with the station name.
14621494
However, some stations send other kind of messages
@@ -1494,7 +1526,7 @@ _EnD_oF_dEf_TeXt_;
14941526
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
14951527
@
14961528

1497-
1529+
\iline 897
14981530

14991531
@return char* string with the Text of the group A2 <br>
15001532
_EnD_oF_dEf_TeXt_;
@@ -1619,6 +1651,8 @@ _EnD_oF_dEf_TeXt_;
16191651
Get the current Status of block B.
16201652
_EnD_oF_dEf_TeXt_;
16211653
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1654+
\iline 1035
1655+
16221656
Block Errors Level of RDS_DATA_1, and is always read as Errors Level of RDS BLOCK B (in RDS mode ) or E (in RBDS mode when ABCD_E flag is 1).
16231657
<table class="markdownTable">
16241658
<tr class="markdownTableHead"> <th class="markdownTableHeadNone"> value \ilinebr </th> <th class="markdownTableHeadNone"> description \ilinebr </th> </tr>
@@ -1851,6 +1885,8 @@ _EnD_oF_dEf_TeXt_;
18511885
If 0, I2S output unsigned 16-bit audio data. If 1, I2S output signed 16-bit audio data.
18521886
_EnD_oF_dEf_TeXt_;
18531887
sec-mem-documentation = <<_EnD_oF_dEf_TeXt_
1888+
\iline 1230
1889+
18541890
@param value true (1) or false (0)
18551891
_EnD_oF_dEf_TeXt_;
18561892
}; /* sec-member */
@@ -2748,7 +2784,7 @@ _EnD_oF_dEf_TeXt_;
27482784
Register 0x00.
27492785
_EnD_oF_dEf_TeXt_;
27502786
cp-documentation = <<_EnD_oF_dEf_TeXt_
2751-
2787+
\iline 103
27522788
_EnD_oF_dEf_TeXt_;
27532789
}; /* union */
27542790
struct = {
@@ -3967,6 +4003,8 @@ _EnD_oF_dEf_TeXt_;
39674003
Register 0x06.
39684004
_EnD_oF_dEf_TeXt_;
39694005
cp-documentation = <<_EnD_oF_dEf_TeXt_
4006+
\iline 267
4007+
39704008
I2S_SW_CNT values table
39714009

39724010
<table class="markdownTable">
@@ -5405,7 +5443,9 @@ _EnD_oF_dEf_TeXt_;
54055443
RDS Block B data type.
54065444
_EnD_oF_dEf_TeXt_;
54075445
cp-documentation = <<_EnD_oF_dEf_TeXt_
5408-
For GCC on System-V ABI on 386-compatible (32-bit processors), the following stands:
5446+
\iline 464
5447+
5448+
\ilinebr\ilinebr For GCC on System-V ABI on 386-compatible (32-bit processors), the following stands:
54095449

54105450
1) Bit-fields are allocated from right to left (least to most significant).
54115451
2) A bit-field must entirely reside in a storage unit appropriate for its declared type.

‎extras/apidoc/html/_r_d_a5807_8cpp.html

+16-11
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
2-
<html xmlns="http://www.w3.org/1999/xhtml">
2+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en-US">
33
<head>
44
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
55
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
6-
<meta name="generator" content="Doxygen 1.9.4"/>
6+
<meta name="generator" content="Doxygen 1.9.6"/>
77
<meta name="viewport" content="width=device-width, initial-scale=1"/>
88
<title>PU2CLR RDA5807 Arduino Library: RDA5807/src/RDA5807.cpp File Reference</title>
99
<link href="tabs.css" rel="stylesheet" type="text/css"/>
@@ -35,10 +35,10 @@
3535
</table>
3636
</div>
3737
<!-- end header part -->
38-
<!-- Generated by Doxygen 1.9.4 -->
38+
<!-- Generated by Doxygen 1.9.6 -->
3939
<script type="text/javascript">
4040
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
41-
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
41+
var searchBox = new SearchBox("searchBox", "search/",'.html');
4242
/* @license-end */
4343
</script>
4444
<script type="text/javascript" src="menudata.js"></script>
@@ -78,25 +78,30 @@
7878

7979
<!-- iframe showing the search results (closed by default) -->
8080
<div id="MSearchResultsWindow">
81-
<iframe src="javascript:void(0)" frameborder="0"
82-
name="MSearchResults" id="MSearchResults">
83-
</iframe>
81+
<div id="MSearchResults">
82+
<div class="SRPage">
83+
<div id="SRIndex">
84+
<div id="SRResults"></div>
85+
<div class="SRStatus" id="Loading">Loading...</div>
86+
<div class="SRStatus" id="Searching">Searching...</div>
87+
<div class="SRStatus" id="NoMatches">No Matches</div>
88+
</div>
89+
</div>
90+
</div>
8491
</div>
8592

8693
<div class="header">
8794
<div class="headertitle"><div class="title">RDA5807.cpp File Reference</div></div>
8895
</div><!--header-->
8996
<div class="contents">
9097
<div class="textblock"><code>#include &lt;<a class="el" href="_r_d_a5807_8h_source.html">RDA5807.h</a>&gt;</code><br />
91-
</div>
92-
<p><a href="_r_d_a5807_8cpp_source.html">Go to the source code of this file.</a></p>
93-
</div><!-- contents -->
98+
</div></div><!-- contents -->
9499
</div><!-- doc-content -->
95100
<!-- start footer part -->
96101
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
97102
<ul>
98103
<li class="navelem"><a class="el" href="dir_0ed30cf5299dd8c40b2402f14fb7e6ee.html">RDA5807</a></li><li class="navelem"><a class="el" href="dir_42636baf320234a3d533ded6f955c5be.html">src</a></li><li class="navelem"><a class="el" href="_r_d_a5807_8cpp.html">RDA5807.cpp</a></li>
99-
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
104+
<li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.6 </li>
100105
</ul>
101106
</div>
102107
</body>

0 commit comments

Comments
 (0)