Skip to content

Commit

Permalink
Doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@pu2clr
pu2clr committed Nov 13, 2024
1 parent 86a2c14 commit 7605eaa
Show file tree
Hide file tree
Showing 5 changed files with 13 additions and 13 deletions.
2 changes: 1 addition & 1 deletion extras/apidoc/def/doxygen.def
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3842,7 +3842,7 @@ _EnD_oF_dEf_TeXt_;
define-mem-documentation = <<_EnD_oF_dEf_TeXt_
\iline 2

\ilinebr\ilinebr This is an Arduino library for the SI4844, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs.
\ilinebr\ilinebr This is an Arduino library for the SI4822, SI4826, SI4827, SI4840, 4844A, and 4844B, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs.
\ilinebr\ilinebr This library is intended to provide an easier interface for controlling the SI47XX by using Arduino platform.
\ilinebr\ilinebr The communication used by this library is I2C.
\ilinebr\ilinebr This file contains: const (#define), Defined Data type and Methods declarations
Expand Down
2 changes: 1 addition & 1 deletion extras/apidoc/html/_s_i4844_8h.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#acc6be0457e695b1458f3d016

<p><a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a> ARDUINO LIBRARY <br />
</p>
<p>This is an Arduino library for the <a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a>, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs.</p>
<p>This is an Arduino library for the SI4822, SI4826, SI4827, SI4840, 4844A, and 4844B, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs.</p>
<p>This library is intended to provide an easier interface for controlling the SI47XX by using Arduino platform.</p>
<p>The communication used by this library is I2C.</p>
<p>This file contains: const (#define), Defined Data type and Methods declarations</p>
Expand Down
18 changes: 9 additions & 9 deletions extras/apidoc/html/_s_i4844_8h_source.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
<a href="_s_i4844_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span><span class="comment">/**</span></div>
<div class="line"><span class="lineno"> 2</span><span class="comment"> * @brief SI4844 ARDUINO LIBRARY </span></div>
<div class="line"><span class="lineno"> 3</span><span class="comment"> * </span></div>
<div class="line"><span class="lineno"> 4</span><span class="comment"> * @details This is an Arduino library for the SI4844, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs. </span></div>
<div class="line"><span class="lineno"> 4</span><span class="comment"> * @details This is an Arduino library for the SI4822, SI4826, SI4827, SI4840, 4844A, and 4844B, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs. </span></div>
<div class="line"><span class="lineno"> 5</span><span class="comment"> * @details This library is intended to provide an easier interface for controlling the SI47XX by using Arduino platform. </span></div>
<div class="line"><span class="lineno"> 6</span><span class="comment"> * @details The communication used by this library is I2C.</span></div>
<div class="line"><span class="lineno"> 7</span><span class="comment"> * @details This file contains: const (#define), Defined Data type and Methods declarations</span></div>
Expand Down Expand Up @@ -134,15 +134,15 @@
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a8befb9228ad41e2baa0e69411e0f5108"> 40</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_SOFT_MUTE_MAX_ATTENUATION</span> 0x1302</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a57030e143a5efa06b9b9cc21b63d0b70"> 41</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">AM_SOFT_MUTE_MAX_ATTENUATION</span> 0x3302</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a9fe700fb45d6e08e177da6fdc208fa05"> 42</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_DEEMPHASIS</span> 0x1100</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a071a5bbf23d933861cb73987c74e9fed"> 43</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_SOFT_MUTE_RATE</span> 0x1300</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#ad90847770bc9057d28c2db4975a37ab5"> 44</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_SOFT_MUTE_SLOPE</span> 0x1301</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a5c434290c4783a19e1255ef3aae55d15"> 45</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_STEREO_IND_BLEND_THRESHOLD</span> 0x1207</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#abf0ee031cf6bb27b0211709117cfcaf0"> 46</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_BLEND_RSSI_STEREO_THRESHOLD</span> 0x1800</div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a8f62bfa609e4deb9febe3a25aae3c6bc"> 47</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_BLEND_RSSI_MONO_THRESHOLD</span> 0x1801</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a9fe700fb45d6e08e177da6fdc208fa05"> 42</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_DEEMPHASIS</span> 0x1100 <span class="comment">// You can use setProperty(FM_DEEMPHASIS, value);</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a071a5bbf23d933861cb73987c74e9fed"> 43</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_SOFT_MUTE_RATE</span> 0x1300 <span class="comment">// You can use setProperty(FM_SOFT_MUTE_RATE, value);</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#ad90847770bc9057d28c2db4975a37ab5"> 44</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_SOFT_MUTE_SLOPE</span> 0x1301 <span class="comment">// You can use setProperty(FM_SOFT_MUTE_SLOPE, value);</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a5c434290c4783a19e1255ef3aae55d15"> 45</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_STEREO_IND_BLEND_THRESHOLD</span> 0x1207 <span class="comment">// You can use setProperty(FM_STEREO_IND_BLEND_THRESHOLD, value);</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#abf0ee031cf6bb27b0211709117cfcaf0"> 46</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_BLEND_RSSI_STEREO_THRESHOLD</span> 0x1800 <span class="comment">// You can use setProperty(FM_BLEND_RSSI_STEREO_THRESHOLD, value);</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a8f62bfa609e4deb9febe3a25aae3c6bc"> 47</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">FM_BLEND_RSSI_MONO_THRESHOLD</span> 0x1801 <span class="comment">// You can use setProperty(FM_BLEND_RSSI_MONO_THRESHOLD, value); </span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"> 48</span> </div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#adb330b20b383f5f664a9b107edef0036"> 49</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">REFCLK_FREQ</span> 0x0201</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a6b615b86f7870b616243b25cb5091933"> 50</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">REFCLK_PRESCALE</span> 0x0202</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#adb330b20b383f5f664a9b107edef0036"> 49</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">REFCLK_FREQ</span> 0x0201 <span class="comment">// You can use setProperty(REFCLK_FREQ, value);</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"><a class="line" href="_s_i4844_8h.html#a6b615b86f7870b616243b25cb5091933"> 50</a></span><span class="preprocessor">#</span><span class="preprocessor">define</span> <span class="preprocessor">REFCLK_PRESCALE</span> 0x0202 <span class="comment">// You can use setProperty(REFCLK_PRESCALE, value);</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> </div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> </div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span><span class="comment">/** @defgroup GA1 Union and Structures </span></div>
Expand Down
2 changes: 1 addition & 1 deletion extras/apidoc/html/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@
<div class="headertitle"><div class="title">SI48XX Arduino Library implementation </div></div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>This is a library for the <a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a>, BROADCAST ANALOG TUNING DIGITAL DISPLAY AM/FM/SW RADIO RECEIVER, ICs from Silicon Labs. <br />
<div class="textblock"><p>This is a library for the SI4822, SI4826, SI4827, SI4840, 4844A, and 4844B, BROADCAST ANALOG TUNING DIGITAL DISPLAY AM/FM/SW RADIO RECEIVER, ICs from Silicon Labs. <br />
This library is intended to provide an easier interface to control the <a class="el" href="class_s_i4844.html" title="SI4844 Class.">SI4844</a>.</p>
<p>This library can be freely distributed using the MIT Free Software model.</p>
<p>Copyright (c) 2019 Ricardo Lima Caratti </p>
Expand Down
2 changes: 1 addition & 1 deletion src/SI4844.h
View file
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
/**
* @brief SI4844 ARDUINO LIBRARY
*
* @details This is an Arduino library for the SI48XX family, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs.
* @details This is an Arduino library for the SI4822, SI4826, SI4827, SI4840, 4844A, and 4844B, BROADCAST AM/FM/SW RADIO RECEIVER IC family from Silicon Labs.
* @details This library is intended to provide an easier interface for controlling the SI47XX by using Arduino platform.
* @details The communication used by this library is I2C.
* @details This file contains: const (#define), Defined Data type and Methods declarations
Expand Down

0 comments on commit 7605eaa

Please sign in to comment.