diff --git a/extras/apidoc/def/doxygen.def b/extras/apidoc/def/doxygen.def index 0593c16..80e1a3c 100644 --- a/extras/apidoc/def/doxygen.def +++ b/extras/apidoc/def/doxygen.def @@ -25,7 +25,7 @@ _EnD_oF_dEf_TeXt_; Mutes the audio output. _EnD_oF_dEf_TeXt_; sec-mem-documentation = <<_EnD_oF_dEf_TeXt_ -\iline 609 +\iline 612 @param value value 0 = normal (no mute); 1 = Right side mute; 2; Left side mute; 3 = both side _EnD_oF_dEf_TeXt_; @@ -87,7 +87,7 @@ _EnD_oF_dEf_TeXt_; Up or down the sound volume level. _EnD_oF_dEf_TeXt_; sec-mem-documentation = <<_EnD_oF_dEf_TeXt_ - \xrefitem deprecated 1.\iline 430 + \xrefitem deprecated 1.\iline 433 @param command '+' up and '-' down _EnD_oF_dEf_TeXt_; @@ -210,12 +210,12 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga1d119d683bed417b108ef1ccf3a2d20c'; - sec-mem-ref-line = '673'; + sec-mem-ref-line = '676'; sec-mem-ref-name = 'getFirmware'; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; - sec-mem-ref-line = '276'; + sec-mem-ref-line = '279'; sec-mem-ref-name = 'reset'; }; }; /* sec-member */ @@ -350,16 +350,16 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1gacd42a278c3304a591d80ae7ab351b87a'; - sec-mem-ref-line = '233'; + sec-mem-ref-line = '236'; sec-mem-ref-name = 'debugDevice'; }; sec-mem-referencedby = { - sec-mem-ref-id = '_s_i4844_8cpp_1ga4ee550ad12649badcb3d54da6c7e62ee'; + sec-mem-ref-id = '_s_i4844_8cpp_1ga11a97916ce91dfb5ad6f49e5156219b1'; sec-mem-ref-line = '171'; sec-mem-ref-name = 'setup'; }; @@ -528,7 +528,7 @@ _EnD_oF_dEf_TeXt_; }; /* sec-member */ sec-member = { sec-mem-kind = 'function'; - sec-mem-id = 'group___t_o_o_l_s_1gab73eede639c03740773261c551ead9a5'; + sec-mem-id = 'group___t_o_o_l_s_1ga168919a06150d7ceb185d8293b1c6eeb'; sec-mem-virt = normal; sec-mem-prot = public; sec-mem-type = <<_EnD_oF_dEf_TeXt_ @@ -542,6 +542,15 @@ _EnD_oF_dEf_TeXt_; sec-mem-param-declname = 'removeRightDigit'; sec-mem-param-defval = <<_EnD_oF_dEf_TeXt_ 0 +_EnD_oF_dEf_TeXt_; + }; /* sec-mem-param--param */ + sec-mem-param = { + sec-mem-param-type = <<_EnD_oF_dEf_TeXt_ +uint8_t +_EnD_oF_dEf_TeXt_; + sec-mem-param-declname = 'thousandsSeparator'; + sec-mem-param-defval = <<_EnD_oF_dEf_TeXt_ +',' _EnD_oF_dEf_TeXt_; }; /* sec-mem-param--param */ sec-mem-desc-file = '/Users/rcaratti/Desenvolvimento/eu/Arduino/DSP/si4844/SI4844/src/SI4844.h'; @@ -591,7 +600,7 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3437ce047c5649597e1bccfb8c42cd5b'; - sec-mem-ref-line = '640'; + sec-mem-ref-line = '643'; sec-mem-ref-name = 'getStatus'; }; }; /* sec-member */ @@ -627,7 +636,7 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3437ce047c5649597e1bccfb8c42cd5b'; - sec-mem-ref-line = '640'; + sec-mem-ref-line = '643'; sec-mem-ref-name = 'getStatus'; }; }; /* sec-member */ @@ -662,7 +671,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -722,27 +731,27 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga0404927e7414a32125e32ff508bd450e'; - sec-mem-ref-line = '701'; + sec-mem-ref-line = '704'; sec-mem-ref-name = 'getFrequency'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga0eafb7b0438fb9e70c91d368929c6aed'; - sec-mem-ref-line = '747'; + sec-mem-ref-line = '750'; sec-mem-ref-name = 'getFrequencyInteger'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3de561a939b708030dae788781adf7e0'; - sec-mem-ref-line = '361'; + sec-mem-ref-line = '364'; sec-mem-ref-name = 'setBand'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga5c766d254b0c261a93dfd817f11b712c'; - sec-mem-ref-line = '828'; + sec-mem-ref-line = '831'; sec-mem-ref-name = 'setCustomBand'; }; }; /* sec-member */ @@ -1050,7 +1059,7 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -1118,16 +1127,21 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1gacd42a278c3304a591d80ae7ab351b87a'; - sec-mem-ref-line = '233'; + sec-mem-ref-line = '236'; sec-mem-ref-name = 'debugDevice'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3de561a939b708030dae788781adf7e0'; - sec-mem-ref-line = '361'; + sec-mem-ref-line = '364'; sec-mem-ref-name = 'setBand'; }; sec-mem-referencedby = { - sec-mem-ref-id = '_s_i4844_8cpp_1ga4ee550ad12649badcb3d54da6c7e62ee'; + sec-mem-ref-id = '_s_i4844_8cpp_1ga5c766d254b0c261a93dfd817f11b712c'; + sec-mem-ref-line = '831'; + sec-mem-ref-name = 'setCustomBand'; + }; + sec-mem-referencedby = { + sec-mem-ref-id = '_s_i4844_8cpp_1ga11a97916ce91dfb5ad6f49e5156219b1'; sec-mem-ref-line = '171'; sec-mem-ref-name = 'setup'; }; @@ -1236,7 +1250,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -1398,7 +1412,7 @@ _EnD_oF_dEf_TeXt_; Set audio mode. _EnD_oF_dEf_TeXt_; sec-mem-documentation = <<_EnD_oF_dEf_TeXt_ -\iline 553 +\iline 556 @see Si48XX ATDD PROGRAMMING GUIDE; AN610; page 21 @@ -1423,7 +1437,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -1448,7 +1462,7 @@ _EnD_oF_dEf_TeXt_; Mutes the audio output. _EnD_oF_dEf_TeXt_; sec-mem-documentation = <<_EnD_oF_dEf_TeXt_ -\iline 620 +\iline 623 @param bool on false = normal (no mute); true = mute _EnD_oF_dEf_TeXt_; @@ -1487,12 +1501,12 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3437ce047c5649597e1bccfb8c42cd5b'; - sec-mem-ref-line = '640'; + sec-mem-ref-line = '643'; sec-mem-ref-name = 'getStatus'; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; - sec-mem-ref-line = '276'; + sec-mem-ref-line = '279'; sec-mem-ref-name = 'reset'; }; sec-mem-referenceto = { @@ -1502,7 +1516,7 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -1527,7 +1541,7 @@ _EnD_oF_dEf_TeXt_; Set the sound volume level, bass and treble. _EnD_oF_dEf_TeXt_; sec-mem-documentation = <<_EnD_oF_dEf_TeXt_ -\iline 508 +\iline 511 @@ -1718,8 +1732,13 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3437ce047c5649597e1bccfb8c42cd5b'; - sec-mem-ref-line = '640'; + sec-mem-ref-line = '643'; sec-mem-ref-name = 'getStatus'; + }; + sec-mem-referenceto = { + sec-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; + sec-mem-ref-line = '279'; + sec-mem-ref-name = 'reset'; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga34c4b208e45ee1b414afe5113b98db9f'; @@ -1728,7 +1747,7 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -1923,7 +1942,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -2042,7 +2061,7 @@ _EnD_oF_dEf_TeXt_; }; /* sec-member */ sec-member = { sec-mem-kind = 'function'; - sec-mem-id = 'group___g_b1_1ga4ee550ad12649badcb3d54da6c7e62ee'; + sec-mem-id = 'group___g_b1_1ga11a97916ce91dfb5ad6f49e5156219b1'; sec-mem-virt = normal; sec-mem-prot = public; sec-mem-type = <<_EnD_oF_dEf_TeXt_ @@ -2063,9 +2082,12 @@ _EnD_oF_dEf_TeXt_; }; /* sec-mem-param--param */ sec-mem-param = { sec-mem-param-type = <<_EnD_oF_dEf_TeXt_ -byte +int8_t _EnD_oF_dEf_TeXt_; sec-mem-param-declname = 'defaultBand'; + sec-mem-param-defval = <<_EnD_oF_dEf_TeXt_ +0 +_EnD_oF_dEf_TeXt_; }; /* sec-mem-param--param */ sec-mem-param = { sec-mem-param-type = <<_EnD_oF_dEf_TeXt_ @@ -2087,7 +2109,7 @@ _EnD_oF_dEf_TeXt_; \ilinebr\ilinebr In this case, you have to call interrupt_hundler() (see SI4844.h)
@param resetPin arduino pin used to reset the device @param interruptPin interruprPin arduino pin used to handle interrupt -@param defaultBand band that the radio should start +@param defaultBand band that the radio should start. If -1 no band is selected and you must select one after starting. Default 0 = FM. @param hightClockSpeed hight I2C clock speed to be used by the system (optional - default 50000 - 50kHz). _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { @@ -2097,12 +2119,12 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga1d119d683bed417b108ef1ccf3a2d20c'; - sec-mem-ref-line = '673'; + sec-mem-ref-line = '676'; sec-mem-ref-name = 'getFirmware'; }; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; - sec-mem-ref-line = '276'; + sec-mem-ref-line = '279'; sec-mem-ref-name = 'reset'; }; }; /* sec-member */ @@ -2133,7 +2155,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -2212,7 +2234,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga7e14f020d74ec2492070e84cb24a68c3'; - sec-mem-ref-line = '420'; + sec-mem-ref-line = '423'; sec-mem-ref-name = 'waitToSend'; }; }; /* sec-member */ @@ -2235,7 +2257,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3437ce047c5649597e1bccfb8c42cd5b'; - sec-mem-ref-line = '640'; + sec-mem-ref-line = '643'; sec-mem-ref-name = 'getStatus'; }; }; /* sec-member */ @@ -2263,7 +2285,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; - sec-mem-ref-line = '276'; + sec-mem-ref-line = '279'; sec-mem-ref-name = 'reset'; }; }; /* sec-member */ @@ -2321,17 +2343,17 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; - sec-mem-ref-line = '276'; + sec-mem-ref-line = '279'; sec-mem-ref-name = 'reset'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3de561a939b708030dae788781adf7e0'; - sec-mem-ref-line = '361'; + sec-mem-ref-line = '364'; sec-mem-ref-name = 'setBand'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga5c766d254b0c261a93dfd817f11b712c'; - sec-mem-ref-line = '828'; + sec-mem-ref-line = '831'; sec-mem-ref-name = 'setCustomBand'; }; }; /* sec-member */ @@ -2359,12 +2381,12 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referenceto = { sec-mem-ref-id = '_s_i4844_8cpp_1ga5b2ae6cf8a96c47b8725e6a1615e7b45'; - sec-mem-ref-line = '404'; + sec-mem-ref-line = '407'; sec-mem-ref-name = 'isClearToSend'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga1d119d683bed417b108ef1ccf3a2d20c'; - sec-mem-ref-line = '673'; + sec-mem-ref-line = '676'; sec-mem-ref-name = 'getFirmware'; }; sec-mem-referencedby = { @@ -2374,12 +2396,12 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3437ce047c5649597e1bccfb8c42cd5b'; - sec-mem-ref-line = '640'; + sec-mem-ref-line = '643'; sec-mem-ref-name = 'getStatus'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1gaff14988c6be8a5fb9d1a5e6934dcff47'; - sec-mem-ref-line = '297'; + sec-mem-ref-line = '300'; sec-mem-ref-name = 'powerDown'; }; sec-mem-referencedby = { @@ -2389,17 +2411,17 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1gadb6affba868c9c99f44918e5a48a423d'; - sec-mem-ref-line = '576'; + sec-mem-ref-line = '579'; sec-mem-ref-name = 'setAudioMode'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga3de561a939b708030dae788781adf7e0'; - sec-mem-ref-line = '361'; + sec-mem-ref-line = '364'; sec-mem-ref-name = 'setBand'; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga5c766d254b0c261a93dfd817f11b712c'; - sec-mem-ref-line = '828'; + sec-mem-ref-line = '831'; sec-mem-ref-name = 'setCustomBand'; }; sec-mem-referencedby = { @@ -2409,7 +2431,7 @@ _EnD_oF_dEf_TeXt_; }; sec-mem-referencedby = { sec-mem-ref-id = '_s_i4844_8cpp_1ga65eab6c860e3e11c5d3726144dd3b73d'; - sec-mem-ref-line = '484'; + sec-mem-ref-line = '487'; sec-mem-ref-name = 'setVolume'; }; }; /* sec-member */ @@ -2611,8 +2633,8 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; sec-mem-referencedby = { - sec-mem-ref-id = '_s_i4844_8cpp_1gab73eede639c03740773261c551ead9a5'; - sec-mem-ref-line = '1126'; + sec-mem-ref-id = '_s_i4844_8cpp_1ga168919a06150d7ceb185d8293b1c6eeb'; + sec-mem-ref-line = '1128'; sec-mem-ref-name = 'getFormattedFrequency'; }; }; /* sec-member */ @@ -5083,7 +5105,7 @@ _EnD_oF_dEf_TeXt_; _EnD_oF_dEf_TeXt_; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1gacd42a278c3304a591d80ae7ab351b87a'; - var-mem-ref-line = '233'; + var-mem-ref-line = '236'; var-mem-ref-name = 'SI4844::debugDevice'; }; var-mem-referencedby = { @@ -5093,22 +5115,22 @@ _EnD_oF_dEf_TeXt_; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga1d119d683bed417b108ef1ccf3a2d20c'; - var-mem-ref-line = '673'; + var-mem-ref-line = '676'; var-mem-ref-name = 'SI4844::getFirmware'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga0404927e7414a32125e32ff508bd450e'; - var-mem-ref-line = '701'; + var-mem-ref-line = '704'; var-mem-ref-name = 'SI4844::getFrequency'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga0eafb7b0438fb9e70c91d368929c6aed'; - var-mem-ref-line = '747'; + var-mem-ref-line = '750'; var-mem-ref-name = 'SI4844::getFrequencyInteger'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1gae362404004bde2ed561a0c34604e0254'; - var-mem-ref-line = '795'; + var-mem-ref-line = '798'; var-mem-ref-name = 'SI4844::hasStatusChanged'; }; var-mem-referencedby = { @@ -5118,27 +5140,27 @@ _EnD_oF_dEf_TeXt_; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1gaff14988c6be8a5fb9d1a5e6934dcff47'; - var-mem-ref-line = '297'; + var-mem-ref-line = '300'; var-mem-ref-name = 'SI4844::powerDown'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga683a81897fe79e6909817aab36622684'; - var-mem-ref-line = '276'; + var-mem-ref-line = '279'; var-mem-ref-name = 'SI4844::reset'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga2f14c89d348c5e3214615258b8f9c918'; - var-mem-ref-line = '804'; + var-mem-ref-line = '807'; var-mem-ref-name = 'SI4844::resetStatus'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga3de561a939b708030dae788781adf7e0'; - var-mem-ref-line = '361'; + var-mem-ref-line = '364'; var-mem-ref-name = 'SI4844::setBand'; }; var-mem-referencedby = { var-mem-ref-id = '_s_i4844_8cpp_1ga5c766d254b0c261a93dfd817f11b712c'; - var-mem-ref-line = '828'; + var-mem-ref-line = '831'; var-mem-ref-name = 'SI4844::setCustomBand'; }; var-mem-referencedby = { @@ -5147,7 +5169,7 @@ _EnD_oF_dEf_TeXt_; var-mem-ref-name = 'SI4844::setStatusInterruptFromDevice'; }; var-mem-referencedby = { - var-mem-ref-id = '_s_i4844_8cpp_1ga4ee550ad12649badcb3d54da6c7e62ee'; + var-mem-ref-id = '_s_i4844_8cpp_1ga11a97916ce91dfb5ad6f49e5156219b1'; var-mem-ref-line = '171'; var-mem-ref-name = 'SI4844::setup'; }; diff --git a/extras/apidoc/html/_s_i4844_8h.html b/extras/apidoc/html/_s_i4844_8h.html index 828f37c..3e7a2f8 100644 --- a/extras/apidoc/html/_s_i4844_8h.html +++ b/extras/apidoc/html/_s_i4844_8h.html @@ -755,7 +755,7 @@

See also
interrupt_hundler() function in SI44.cpp.
-

Referenced by SI4844::debugDevice(), SI4844::getDataStatusInterruptFromDevice(), SI4844::getFirmware(), SI4844::getFrequency(), SI4844::getFrequencyInteger(), SI4844::hasStatusChanged(), interrupt_hundler(), SI4844::powerDown(), SI4844::reset(), SI4844::resetStatus(), SI4844::setBand(), SI4844::setCustomBand(), SI4844::setStatusInterruptFromDevice(), SI4844::setup(), and SI4844::waitInterrupt().

+

Referenced by SI4844::debugDevice(), SI4844::getDataStatusInterruptFromDevice(), SI4844::getFirmware(), SI4844::getFrequency(), SI4844::getFrequencyInteger(), SI4844::hasStatusChanged(), interrupt_hundler(), SI4844::powerDown(), SI4844::reset(), SI4844::resetStatus(), SI4844::setBand(), SI4844::setCustomBand(), SI4844::setStatusInterruptFromDevice(), SI4844::setup(), and SI4844::waitInterrupt().

diff --git a/extras/apidoc/html/_s_i4844_8h_source.html b/extras/apidoc/html/_s_i4844_8h_source.html index 391436c..f984edb 100644 --- a/extras/apidoc/html/_s_i4844_8h_source.html +++ b/extras/apidoc/html/_s_i4844_8h_source.html @@ -428,7 +428,7 @@
333 void sendCommand(uint8_t cmd, int parameter_size, const uint8_t *parameter);
334 void getCommandResponse(int response_size, uint8_t *response);
335
-
336 void setup(uint16_t resetPin, int interruptPin, byte defaultBand, uint32_t hightClockSpeed = 50000);
+
336 void setup(uint16_t resetPin, int interruptPin, int8_t defaultBand = 0, uint32_t hightClockSpeed = 50000);
337 void debugDevice(uint16_t resetPin, uint16_t interruptPin, uint8_t defaultBand, void (*showFunc)(char *msg));
338 void reset(void );
339 void setBand(byte);
@@ -597,7 +597,7 @@
502 uint8_t scanI2CBus(uint8_t *device, uint8_t limit);
503 bool detectDevice();
504 void convertToChar(uint32_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator, bool remove_leading_zeros = true);
-
505 char* getFormattedFrequency(uint8_t removeRightDigit = 0);
+
505 char* getFormattedFrequency(uint8_t removeRightDigit = 0, uint8_t thousandsSeparator = ',');
506
507};
interrupt_hundler
void interrupt_hundler()
Library handle interrupt.
Definition: SI4844.cpp:27
@@ -652,7 +652,7 @@
SI4844::getFirmwarePartNumber
uint16_t getFirmwarePartNumber()
Definition: SI4844.h:492
SI4844::strFormattedCurrentFrequenct
char strFormattedCurrentFrequenct[8]
Definition: SI4844.h:306
SI4844::interruptPin
uint16_t interruptPin
Definition: SI4844.h:268
-
SI4844::setDefaultBandIndx
void setDefaultBandIndx(uint8_t bandidx)
Definition: SI4844.cpp:308
+
SI4844::setDefaultBandIndx
void setDefaultBandIndx(uint8_t bandidx)
Definition: SI4844.cpp:311
SI4844::status_response
si4844_status_response status_response
Definition: SI4844.h:265
SI4844::bassTreble
uint8_t bassTreble
Definition: SI4844.h:309
SI4844::getFirmwareReserved
uint16_t getFirmwareReserved()
Definition: SI4844.h:489
@@ -661,13 +661,13 @@
SI4844::getDataStatusInterruptFromDevice
bool getDataStatusInterruptFromDevice()
Get the Data Status From Device.
Definition: SI4844.h:328
SI4844::waitInterrupt
void waitInterrupt(void)
Waiting for an external interrupt.
Definition: SI4844.cpp:151
SI4844::setClockLow
void setClockLow(void)
Sets I2C bus speed to 10kHz.
Definition: SI4844.h:288
-
SI4844::isClearToSend
bool isClearToSend(void)
Checks the CTS status.
Definition: SI4844.cpp:404
-
SI4844::waitToSend
void waitToSend(void)
Wait for the ATDD become Clear to Send.
Definition: SI4844.cpp:420
+
SI4844::isClearToSend
bool isClearToSend(void)
Checks the CTS status.
Definition: SI4844.cpp:407
+
SI4844::waitToSend
void waitToSend(void)
Wait for the ATDD become Clear to Send.
Definition: SI4844.cpp:423
SI4844::sendCommand
void sendCommand(uint8_t cmd, int parameter_size, const uint8_t *parameter)
Sends a given command to the SI4844 device.
Definition: SI4844.cpp:114
-
SI4844::setResetPin
void setResetPin(uint16_t resetPin)
Sets the MCU RESET pin.
Definition: SI4844.cpp:207
+
SI4844::setResetPin
void setResetPin(uint16_t resetPin)
Sets the MCU RESET pin.
Definition: SI4844.cpp:210
SI4844::setProperty
void setProperty(uint16_t propertyNumber, uint16_t parameter)
Sends (sets) property to the SI48XX.
Definition: SI4844.cpp:43
SI4844::getCommandResponse
void getCommandResponse(int response_size, uint8_t *response)
Returns with the command response.
Definition: SI4844.cpp:136
-
SI4844::setInterruptPin
void setInterruptPin(int interruptPin)
Sets the MCU Interrupt pin.
Definition: SI4844.cpp:219
+
SI4844::setInterruptPin
void setInterruptPin(int interruptPin)
Sets the MCU Interrupt pin.
Definition: SI4844.cpp:222
SI4844::setClockHigh
void setClockHigh()
Sets I2C bus speed to hight previous defined speed.
Definition: SI4844.h:295
SI4844::getProperty
uint16_t getProperty(uint16_t propertyNumber)
Gets a given property from the SI4844.
Definition: SI4844.cpp:72
si4844_audiomode::raw
uint8_t raw
Definition: SI4844.h:211
@@ -701,58 +701,58 @@
si4844_get_status::INFORDY
uint8_t INFORDY
Definition: SI4844.h:142
si4844_get_status::CTS
uint8_t CTS
Definition: SI4844.h:145
si4844_get_status::BCFG0
uint8_t BCFG0
Definition: SI4844.h:138
-
SI4844::setAmSoftMuteMaxAttenuation
void setAmSoftMuteMaxAttenuation(uint8_t value)
Sets AM Soft Mute Max Attenuation..
Definition: SI4844.cpp:885
-
SI4844::getFrequency
float getFrequency(void)
Get the current frequency of the radio in KHz.
Definition: SI4844.cpp:701
-
SI4844::getFrequencyInteger
uint32_t getFrequencyInteger(void)
Get the current frequency of the radio in KHz in uint32_t (long integer) .
Definition: SI4844.cpp:747
+
SI4844::setAmSoftMuteMaxAttenuation
void setAmSoftMuteMaxAttenuation(uint8_t value)
Sets AM Soft Mute Max Attenuation..
Definition: SI4844.cpp:887
+
SI4844::getFrequency
float getFrequency(void)
Get the current frequency of the radio in KHz.
Definition: SI4844.cpp:704
+
SI4844::getFrequencyInteger
uint32_t getFrequencyInteger(void)
Get the current frequency of the radio in KHz in uint32_t (long integer) .
Definition: SI4844.cpp:750
SI4844::getStatusBCFG0
uint16_t getStatusBCFG0()
Gets Band CFG0 (Band Detection Configuration).
Definition: SI4844.h:418
-
SI4844::setFmDeemphasis
void setFmDeemphasis(uint8_t value)
Sets de-emphasis time constant.
Definition: SI4844.cpp:908
-
SI4844::changeVolume
void changeVolume(char)
Up or down the sound volume level.
Definition: SI4844.cpp:434
-
SI4844::getFirmware
si4844_firmware_response * getFirmware(void)
Get part number, chip revision, firmware, patch, and component revision numbers.
Definition: SI4844.cpp:673
-
SI4844::setFmSoftMuteRate
void setFmSoftMuteRate(uint8_t value)
Sets the attack and decay rates when entering and leaving soft mute.
Definition: SI4844.cpp:921
-
SI4844::setAmSoftMuteSnrThreshold
void setAmSoftMuteSnrThreshold(uint8_t value)
Sets the SNR threshold to engage soft mute.
Definition: SI4844.cpp:992
+
SI4844::setup
void setup(uint16_t resetPin, int interruptPin, int8_t defaultBand=0, uint32_t hightClockSpeed=50000)
Initiates the SI4844 instance and connect the device (SI4844) to Arduino.
Definition: SI4844.cpp:171
+
SI4844::setFmDeemphasis
void setFmDeemphasis(uint8_t value)
Sets de-emphasis time constant.
Definition: SI4844.cpp:910
+
SI4844::changeVolume
void changeVolume(char)
Up or down the sound volume level.
Definition: SI4844.cpp:437
+
SI4844::getFirmware
si4844_firmware_response * getFirmware(void)
Get part number, chip revision, firmware, patch, and component revision numbers.
Definition: SI4844.cpp:676
+
SI4844::setFmSoftMuteRate
void setFmSoftMuteRate(uint8_t value)
Sets the attack and decay rates when entering and leaving soft mute.
Definition: SI4844.cpp:923
+
SI4844::setAmSoftMuteSnrThreshold
void setAmSoftMuteSnrThreshold(uint8_t value)
Sets the SNR threshold to engage soft mute.
Definition: SI4844.cpp:994
SI4844::getStatusBandMode
uint16_t getStatusBandMode()
Gets the current Band Mode.
Definition: SI4844.h:475
-
SI4844::setFmSoftMuteSlope
void setFmSoftMuteSlope(uint8_t value)
Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR th...
Definition: SI4844.cpp:936
-
SI4844::resetStatus
void resetStatus(void)
set the interrupr status to false. It will turn true after next interrupr
Definition: SI4844.cpp:804
+
SI4844::setFmSoftMuteSlope
void setFmSoftMuteSlope(uint8_t value)
Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR th...
Definition: SI4844.cpp:938
+
SI4844::resetStatus
void resetStatus(void)
set the interrupr status to false. It will turn true after next interrupr
Definition: SI4844.cpp:807
SI4844::getStatusBandIndex
uint16_t getStatusBandIndex()
Gets the current Band Index Detected.
Definition: SI4844.h:482
-
SI4844::getStatus
si4844_status_response * getStatus(void)
Get tune freq, band, and others information, status of the device.
Definition: SI4844.cpp:640
+
SI4844::getStatus
si4844_status_response * getStatus(void)
Get tune freq, band, and others information, status of the device.
Definition: SI4844.cpp:643
SI4844::getVolume
uint8_t getVolume()
Gets the current audio volume level.
Definition: SI4844.h:395
SI4844::getStatusStationIndicator
uint16_t getStatusStationIndicator()
Gets Station Indicator.
Definition: SI4844.h:441
-
SI4844::bassTrebleUp
void bassTrebleUp()
More treble, less bass.
Definition: SI4844.cpp:544
-
SI4844::setBand
void setBand(byte)
Sets a new band to the device.
Definition: SI4844.cpp:361
-
SI4844::setBassTreble
void setBassTreble(uint8_t bass_treble)
Set the sound volume level, bass and treble.
Definition: SI4844.cpp:525
-
SI4844::setReferenceClockFrequency
void setReferenceClockFrequency(uint16_t value)
Sets the frequency of the REFCLK from the output of the prescaler.
Definition: SI4844.cpp:1006
-
SI4844::getVolumeProperty
uint8_t getVolumeProperty()
Gets the current volume value stored in SI4844 device.
Definition: SI4844.cpp:501
-
SI4844::setup
void setup(uint16_t resetPin, int interruptPin, byte defaultBand, uint32_t hightClockSpeed=50000)
Initiates the SI4844 instance and connect the device (SI4844) to Arduino.
Definition: SI4844.cpp:171
-
SI4844::setBlendThresholdStereoIndicator
void setBlendThresholdStereoIndicator(uint16_t value)
Sets the blend threshold for stereo indicator.
Definition: SI4844.cpp:949
-
SI4844::setCustomBand
void setCustomBand(uint8_t bandIndex, uint16_t botton, uint16_t top, uint8_t bandSpace, uint8_t dfband=0, uint8_t uni_am=0, uint8_t tvreq=0)
This method allows you to customize the frequency range of a band.
Definition: SI4844.cpp:828
-
SI4844::setVolume
void setVolume(byte)
Sets the volume level.
Definition: SI4844.cpp:484
-
SI4844::reset
void reset(void)
Resets the SI4844 device.
Definition: SI4844.cpp:276
-
SI4844::setAmSoftMuteSlope
void setAmSoftMuteSlope(uint8_t value)
Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR th...
Definition: SI4844.cpp:979
+
SI4844::bassTrebleUp
void bassTrebleUp()
More treble, less bass.
Definition: SI4844.cpp:547
+
SI4844::setBand
void setBand(byte)
Sets a new band to the device.
Definition: SI4844.cpp:364
+
SI4844::setBassTreble
void setBassTreble(uint8_t bass_treble)
Set the sound volume level, bass and treble.
Definition: SI4844.cpp:528
+
SI4844::setReferenceClockFrequency
void setReferenceClockFrequency(uint16_t value)
Sets the frequency of the REFCLK from the output of the prescaler.
Definition: SI4844.cpp:1008
+
SI4844::getVolumeProperty
uint8_t getVolumeProperty()
Gets the current volume value stored in SI4844 device.
Definition: SI4844.cpp:504
+
SI4844::setBlendThresholdStereoIndicator
void setBlendThresholdStereoIndicator(uint16_t value)
Sets the blend threshold for stereo indicator.
Definition: SI4844.cpp:951
+
SI4844::setCustomBand
void setCustomBand(uint8_t bandIndex, uint16_t botton, uint16_t top, uint8_t bandSpace, uint8_t dfband=0, uint8_t uni_am=0, uint8_t tvreq=0)
This method allows you to customize the frequency range of a band.
Definition: SI4844.cpp:831
+
SI4844::setVolume
void setVolume(byte)
Sets the volume level.
Definition: SI4844.cpp:487
+
SI4844::reset
void reset(void)
Resets the SI4844 device.
Definition: SI4844.cpp:279
+
SI4844::setAmSoftMuteSlope
void setAmSoftMuteSlope(uint8_t value)
Configures attenuation slope during soft mute in dB attenuation per dB SNR below the soft mute SNR th...
Definition: SI4844.cpp:981
SI4844::getStatusStereo
uint16_t getStatusStereo()
Gets Stereo indicator.
Definition: SI4844.h:433
SI4844::getStereoIndicator
char * getStereoIndicator()
Get the Stereo Indicator.
Definition: SI4844.h:410
SI4844::getBandMode
char * getBandMode()
Get the Band Mode.
Definition: SI4844.h:403
SI4844::getRawChannelFrequency
uint16_t getRawChannelFrequency()
Gets the Channel Frequency.
Definition: SI4844.h:465
-
SI4844::powerUp
void powerUp(void)
Power the device up.
Definition: SI4844.cpp:318
-
SI4844::volumeUp
void volumeUp(void)
Increases the volume level.
Definition: SI4844.cpp:459
-
SI4844::setCrystalOscillatorStabilizationWaitTime
void setCrystalOscillatorStabilizationWaitTime(uint8_t XOWAIT)
Sets Crystal Oscillator Stabilization Wait Time After Reset.
Definition: SI4844.cpp:347
-
SI4844::volumeDown
void volumeDown(void)
Decreases the volume level.
Definition: SI4844.cpp:470
-
SI4844::setCrystalOscillatorEnable
void setCrystalOscillatorEnable(uint8_t XOSCEN)
Sets Crystal Oscillator Enable.
Definition: SI4844.cpp:333
+
SI4844::powerUp
void powerUp(void)
Power the device up.
Definition: SI4844.cpp:321
+
SI4844::volumeUp
void volumeUp(void)
Increases the volume level.
Definition: SI4844.cpp:462
+
SI4844::setCrystalOscillatorStabilizationWaitTime
void setCrystalOscillatorStabilizationWaitTime(uint8_t XOWAIT)
Sets Crystal Oscillator Stabilization Wait Time After Reset.
Definition: SI4844.cpp:350
+
SI4844::volumeDown
void volumeDown(void)
Decreases the volume level.
Definition: SI4844.cpp:473
+
SI4844::setCrystalOscillatorEnable
void setCrystalOscillatorEnable(uint8_t XOSCEN)
Sets Crystal Oscillator Enable.
Definition: SI4844.cpp:336
SI4844::getStatusInformationReady
uint16_t getStatusInformationReady()
Gets Information Ready.
Definition: SI4844.h:452
SI4844::getStatusBCFG1
uint16_t getStatusBCFG1()
Gets Band CFG1 (Band Properties Priority)
Definition: SI4844.h:425
-
SI4844::debugDevice
void debugDevice(uint16_t resetPin, uint16_t interruptPin, uint8_t defaultBand, void(*showFunc)(char *msg))
Used to debug
Definition: SI4844.cpp:233
-
SI4844::audioMute
void audioMute(uint8_t value)
Mutes the audio output.
Definition: SI4844.cpp:613
-
SI4844::bassTrebleDown
void bassTrebleDown()
Less treble, more bass.
Definition: SI4844.cpp:533
-
SI4844::setFmSoftMuteMaxAttenuation
void setFmSoftMuteMaxAttenuation(uint8_t value)
FM Soft Mute Maximum Attenuation.
Definition: SI4844.cpp:896
-
SI4844::setAudioMode
si4844_audiomode_status_response setAudioMode(uint8_t audiomode, uint8_t fm_mono, uint8_t adjpt_attn, uint8_t adjpt_steo, uint8_t opcode)
Set audio mode.
Definition: SI4844.cpp:576
-
SI4844::setReferenceClockPrescaler
void setReferenceClockPrescaler(uint16_t value)
Sets the number used by the prescaler to divide the external reference clock frequency down to the in...
Definition: SI4844.cpp:1021
-
SI4844::hasStatusChanged
bool hasStatusChanged(void)
Checks whether the SI4844 has its status changed.
Definition: SI4844.cpp:795
-
SI4844::setAudioMute
void setAudioMute(bool on)
Mutes the audio output.
Definition: SI4844.cpp:624
-
SI4844::setAmSoftMuteRate
void setAmSoftMuteRate(uint8_t value)
Sets the attack and decay rates when entering or leaving soft mute.
Definition: SI4844.cpp:965
-
SI4844::powerDown
void powerDown(void)
Power the device down.
Definition: SI4844.cpp:297
-
SI4844::convertToChar
void convertToChar(uint32_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator, bool remove_leading_zeros=true)
Converts a number to a char array.
Definition: SI4844.cpp:1088
-
SI4844::detectDevice
bool detectDevice()
Checks communication with SI4844 via I2C.
Definition: SI4844.cpp:1035
-
SI4844::scanI2CBus
uint8_t scanI2CBus(uint8_t *device, uint8_t limit)
Scans the I2C bus and returns the addresses of the devices found.
Definition: SI4844.cpp:1051
-
SI4844::getFormattedFrequency
char * getFormattedFrequency(uint8_t removeRightDigit=0)
Gets Formatted Frequency.
Definition: SI4844.cpp:1126
+
SI4844::debugDevice
void debugDevice(uint16_t resetPin, uint16_t interruptPin, uint8_t defaultBand, void(*showFunc)(char *msg))
Used to debug
Definition: SI4844.cpp:236
+
SI4844::audioMute
void audioMute(uint8_t value)
Mutes the audio output.
Definition: SI4844.cpp:616
+
SI4844::bassTrebleDown
void bassTrebleDown()
Less treble, more bass.
Definition: SI4844.cpp:536
+
SI4844::setFmSoftMuteMaxAttenuation
void setFmSoftMuteMaxAttenuation(uint8_t value)
FM Soft Mute Maximum Attenuation.
Definition: SI4844.cpp:898
+
SI4844::setAudioMode
si4844_audiomode_status_response setAudioMode(uint8_t audiomode, uint8_t fm_mono, uint8_t adjpt_attn, uint8_t adjpt_steo, uint8_t opcode)
Set audio mode.
Definition: SI4844.cpp:579
+
SI4844::setReferenceClockPrescaler
void setReferenceClockPrescaler(uint16_t value)
Sets the number used by the prescaler to divide the external reference clock frequency down to the in...
Definition: SI4844.cpp:1023
+
SI4844::hasStatusChanged
bool hasStatusChanged(void)
Checks whether the SI4844 has its status changed.
Definition: SI4844.cpp:798
+
SI4844::setAudioMute
void setAudioMute(bool on)
Mutes the audio output.
Definition: SI4844.cpp:627
+
SI4844::setAmSoftMuteRate
void setAmSoftMuteRate(uint8_t value)
Sets the attack and decay rates when entering or leaving soft mute.
Definition: SI4844.cpp:967
+
SI4844::powerDown
void powerDown(void)
Power the device down.
Definition: SI4844.cpp:300
+
SI4844::getFormattedFrequency
char * getFormattedFrequency(uint8_t removeRightDigit=0, uint8_t thousandsSeparator=',')
Gets Formatted Frequency.
Definition: SI4844.cpp:1128
+
SI4844::convertToChar
void convertToChar(uint32_t value, char *strValue, uint8_t len, uint8_t dot, uint8_t separator, bool remove_leading_zeros=true)
Converts a number to a char array.
Definition: SI4844.cpp:1090
+
SI4844::detectDevice
bool detectDevice()
Checks communication with SI4844 via I2C.
Definition: SI4844.cpp:1037
+
SI4844::scanI2CBus
uint8_t scanI2CBus(uint8_t *device, uint8_t limit)
Scans the I2C bus and returns the addresses of the devices found.
Definition: SI4844.cpp:1053
diff --git a/extras/apidoc/html/class_s_i4844-members.html b/extras/apidoc/html/class_s_i4844-members.html index 6243518..abe30c7 100644 --- a/extras/apidoc/html/class_s_i4844-members.html +++ b/extras/apidoc/html/class_s_i4844-members.html @@ -121,7 +121,7 @@

- + @@ -176,7 +176,7 @@ - + diff --git a/extras/apidoc/html/class_s_i4844.html b/extras/apidoc/html/class_s_i4844.html index aca99d0..a49d3a9 100644 --- a/extras/apidoc/html/class_s_i4844.html +++ b/extras/apidoc/html/class_s_i4844.html @@ -159,9 +159,9 @@ - - - + + + @@ -304,9 +304,9 @@ - - - + + + @@ -908,7 +908,7 @@

-

Referenced by getFormattedFrequency().

+

Referenced by getFormattedFrequency().

diff --git a/extras/apidoc/html/class_s_i4844.js b/extras/apidoc/html/class_s_i4844.js index fd56a9c..a82c27b 100644 --- a/extras/apidoc/html/class_s_i4844.js +++ b/extras/apidoc/html/class_s_i4844.js @@ -20,7 +20,7 @@ var class_s_i4844 = [ "getFirmwareMinorRevision", "class_s_i4844.html#a5ffed2d0e9ea37c2d823322491e82d8b", null ], [ "getFirmwarePartNumber", "class_s_i4844.html#aada13c283d6450faf9f8c1b05dd86ca9", null ], [ "getFirmwareReserved", "class_s_i4844.html#af727aa9c1860b88825fb7254fdf9eabb", null ], - [ "getFormattedFrequency", "group___t_o_o_l_s.html#gab73eede639c03740773261c551ead9a5", null ], + [ "getFormattedFrequency", "group___t_o_o_l_s.html#ga168919a06150d7ceb185d8293b1c6eeb", null ], [ "getFrequency", "group___g_b1.html#ga0404927e7414a32125e32ff508bd450e", null ], [ "getFrequencyInteger", "group___g_b1.html#ga0eafb7b0438fb9e70c91d368929c6aed", null ], [ "getProperty", "group___b_f.html#gaf4b90cf2e7a654718e2c65de5def0928", null ], @@ -73,7 +73,7 @@ var class_s_i4844 = [ "setReferenceClockPrescaler", "group___g_b1.html#gae0618088d11ae5e79193672554e39dad", null ], [ "setResetPin", "group___b_f.html#gab8dd1a10df601b5d99c29d879a2720e7", null ], [ "setStatusInterruptFromDevice", "group___b_f.html#ga1a00037a2cedbe25d1d53716a1c20c00", null ], - [ "setup", "group___g_b1.html#ga4ee550ad12649badcb3d54da6c7e62ee", null ], + [ "setup", "group___g_b1.html#ga11a97916ce91dfb5ad6f49e5156219b1", null ], [ "setVolume", "group___g_b1.html#ga65eab6c860e3e11c5d3726144dd3b73d", null ], [ "volumeDown", "group___g_b1.html#gab6f68232b768a6c257940407c32be77f", null ], [ "volumeUp", "group___g_b1.html#gab48b1d3c4c87d120de56d3195fa071cc", null ], diff --git a/extras/apidoc/html/functions.html b/extras/apidoc/html/functions.html index 5c033e5..7d62f9f 100644 --- a/extras/apidoc/html/functions.html +++ b/extras/apidoc/html/functions.html @@ -160,7 +160,7 @@

- g -

- - - + + + @@ -449,7 +449,7 @@

References data_from_device, and SI4844::waitToSend().

-

Referenced by SI4844::debugDevice(), and SI4844::setup().

+

Referenced by SI4844::debugDevice(), and SI4844::setup().

@@ -932,7 +932,7 @@

References data_from_device, SI4844::setClockLow(), and SI4844::waitInterrupt().

-

Referenced by SI4844::debugDevice(), SI4844::setBand(), and SI4844::setup().

+

Referenced by SI4844::debugDevice(), SI4844::setBand(), SI4844::setCustomBand(), and SI4844::setup().

@@ -1404,7 +1404,7 @@

References data_from_device, SI4844::getStatus(), SI4844::waitInterrupt(), and SI4844::waitToSend().

+

References data_from_device, SI4844::getStatus(), SI4844::reset(), SI4844::waitInterrupt(), and SI4844::waitToSend().

@@ -1578,8 +1578,8 @@

-

◆ setup()

+ +

◆ setup()

@@ -1599,8 +1599,8 @@

- - + + @@ -1624,7 +1624,7 @@

- +
bass_treble \ilinebr Description \ilinebr
getFirmwareMinorRevision()SI4844inline
getFirmwarePartNumber()SI4844inline
getFirmwareReserved()SI4844inline
getFormattedFrequency(uint8_t removeRightDigit=0)SI4844
getFormattedFrequency(uint8_t removeRightDigit=0, uint8_t thousandsSeparator=',')SI4844
getFrequency(void)SI4844
getFrequencyInteger(void)SI4844
getProperty(uint16_t propertyNumber)SI4844
setReferenceClockPrescaler(uint16_t value)SI4844
setResetPin(uint16_t resetPin)SI4844
setStatusInterruptFromDevice(bool value)SI4844inline
setup(uint16_t resetPin, int interruptPin, byte defaultBand, uint32_t hightClockSpeed=50000)SI4844
setup(uint16_t resetPin, int interruptPin, int8_t defaultBand=0, uint32_t hightClockSpeed=50000)SI4844
setVolume(byte)SI4844
status_responseSI4844private
stereo_indicator_tableSI4844private
 
uint16_t getFirmwareReserved ()
 
char * getFormattedFrequency (uint8_t removeRightDigit=0)
 Gets Formatted Frequency.
 
char * getFormattedFrequency (uint8_t removeRightDigit=0, uint8_t thousandsSeparator=',')
 Gets Formatted Frequency.
 
float getFrequency (void)
 Get the current frequency of the radio in KHz.
 
void setStatusInterruptFromDevice (bool value)
 Set the Data Status From Device.
 
void setup (uint16_t resetPin, int interruptPin, byte defaultBand, uint32_t hightClockSpeed=50000)
 Initiates the SI4844 instance and connect the device (SI4844) to Arduino.
 
void setup (uint16_t resetPin, int interruptPin, int8_t defaultBand=0, uint32_t hightClockSpeed=50000)
 Initiates the SI4844 instance and connect the device (SI4844) to Arduino.
 
void setVolume (byte)
 Sets the volume level.
 
void SI4844::setReferenceClockPrescaler (uint16_t value)
 Sets the number used by the prescaler to divide the external reference clock frequency down to the internal REFCLK.
 
void SI4844::setup (uint16_t resetPin, int interruptPin, byte defaultBand, uint32_t hightClockSpeed=50000)
 Initiates the SI4844 instance and connect the device (SI4844) to Arduino.
 
void SI4844::setup (uint16_t resetPin, int interruptPin, int8_t defaultBand=0, uint32_t hightClockSpeed=50000)
 Initiates the SI4844 instance and connect the device (SI4844) to Arduino.
 
void SI4844::setVolume (byte)
 Sets the volume level.
 
byte defaultBand, int8_t defaultBand = 0,
resetPinarduino pin used to reset the device
interruptPininterruprPin arduino pin used to handle interrupt
defaultBandband that the radio should start
defaultBandband that the radio should start. If -1 no band is selected and you must select one after starting. Default 0 = FM.
hightClockSpeedhight I2C clock speed to be used by the system (optional - default 50000 - 50kHz).
diff --git a/extras/apidoc/html/group___g_b1.js b/extras/apidoc/html/group___g_b1.js index 082c719..a34be28 100644 --- a/extras/apidoc/html/group___g_b1.js +++ b/extras/apidoc/html/group___g_b1.js @@ -44,7 +44,7 @@ var group___g_b1 = [ "SI4844::setFmSoftMuteSlope", "group___g_b1.html#ga26ac2207be432e5c4587793b3f8b4904", null ], [ "SI4844::setReferenceClockFrequency", "group___g_b1.html#ga43fab184f53c1f8191f769167934bfd1", null ], [ "SI4844::setReferenceClockPrescaler", "group___g_b1.html#gae0618088d11ae5e79193672554e39dad", null ], - [ "SI4844::setup", "group___g_b1.html#ga4ee550ad12649badcb3d54da6c7e62ee", null ], + [ "SI4844::setup", "group___g_b1.html#ga11a97916ce91dfb5ad6f49e5156219b1", null ], [ "SI4844::setVolume", "group___g_b1.html#ga65eab6c860e3e11c5d3726144dd3b73d", null ], [ "SI4844::volumeDown", "group___g_b1.html#gab6f68232b768a6c257940407c32be77f", null ], [ "SI4844::volumeUp", "group___g_b1.html#gab48b1d3c4c87d120de56d3195fa071cc", null ] diff --git a/extras/apidoc/html/group___t_o_o_l_s.html b/extras/apidoc/html/group___t_o_o_l_s.html index 7c59a18..76ea311 100644 --- a/extras/apidoc/html/group___t_o_o_l_s.html +++ b/extras/apidoc/html/group___t_o_o_l_s.html @@ -104,9 +104,9 @@ bool SI4844::detectDevice ()  Checks communication with SI4844 via I2C.
  -char * SI4844::getFormattedFrequency (uint8_t removeRightDigit=0) - Gets Formatted Frequency.
-  +char * SI4844::getFormattedFrequency (uint8_t removeRightDigit=0, uint8_t thousandsSeparator=',') + Gets Formatted Frequency.
+  uint8_t SI4844::scanI2CBus (uint8_t *device, uint8_t limit)  Scans the I2C bus and returns the addresses of the devices found.
  @@ -200,8 +200,8 @@

-

◆ getFormattedFrequency()

+ +

◆ getFormattedFrequency()

@@ -210,8 +210,18 @@

char * SI4844::getFormattedFrequency ( uint8_t  - removeRightDigit = 0) + removeRightDigit = 0, + + + + uint8_t  + thousandsSeparator = ','  + + + + ) +

diff --git a/extras/apidoc/html/group___t_o_o_l_s.js b/extras/apidoc/html/group___t_o_o_l_s.js index 0d58ce8..18b2c24 100644 --- a/extras/apidoc/html/group___t_o_o_l_s.js +++ b/extras/apidoc/html/group___t_o_o_l_s.js @@ -2,6 +2,6 @@ var group___t_o_o_l_s = [ [ "SI4844::convertToChar", "group___t_o_o_l_s.html#ga1abfca870fe9a1feae6e8d56f7af37be", null ], [ "SI4844::detectDevice", "group___t_o_o_l_s.html#ga66d670fc742b379c642316daf7df9bca", null ], - [ "SI4844::getFormattedFrequency", "group___t_o_o_l_s.html#gab73eede639c03740773261c551ead9a5", null ], + [ "SI4844::getFormattedFrequency", "group___t_o_o_l_s.html#ga168919a06150d7ceb185d8293b1c6eeb", null ], [ "SI4844::scanI2CBus", "group___t_o_o_l_s.html#gab400fccf4b3c381c8ee8c060b56eef1b", null ] ]; \ No newline at end of file diff --git a/extras/apidoc/html/navtreeindex0.js b/extras/apidoc/html/navtreeindex0.js index 7c69944..7d29b42 100644 --- a/extras/apidoc/html/navtreeindex0.js +++ b/extras/apidoc/html/navtreeindex0.js @@ -189,6 +189,7 @@ var NAVTREEINDEX0 = "group___g_b1.html#ga0404927e7414a32125e32ff508bd450e":[2,2,7], "group___g_b1.html#ga0eafb7b0438fb9e70c91d368929c6aed":[2,2,8], "group___g_b1.html#ga1107f15e0f83e4d4f1746086cfd94deb":[2,2,13], +"group___g_b1.html#ga11a97916ce91dfb5ad6f49e5156219b1":[2,2,44], "group___g_b1.html#ga184028717d17cde7ef9993ab967afef5":[2,2,38], "group___g_b1.html#ga184362ec07964aaf36d27304437fac08":[2,2,3], "group___g_b1.html#ga1d119d683bed417b108ef1ccf3a2d20c":[2,2,6], @@ -206,7 +207,6 @@ var NAVTREEINDEX0 = "group___g_b1.html#ga4323a4cd070b75d84e7fc0a5ea7c8f41":[2,2,33], "group___g_b1.html#ga43fab184f53c1f8191f769167934bfd1":[2,2,42], "group___g_b1.html#ga44f5b3d8746dc30922cc92e778e98f16":[2,2,20], -"group___g_b1.html#ga4ee550ad12649badcb3d54da6c7e62ee":[2,2,44], "group___g_b1.html#ga536d522d459a7ac501182708f9ecab9d":[2,2,34], "group___g_b1.html#ga5c766d254b0c261a93dfd817f11b712c":[2,2,37], "group___g_b1.html#ga65eab6c860e3e11c5d3726144dd3b73d":[2,2,45], @@ -234,10 +234,10 @@ var NAVTREEINDEX0 = "group___g_b1.html#gaf37ee2371cb5c22fca70002c6a70aaee":[2,2,27], "group___g_b1.html#gaff14988c6be8a5fb9d1a5e6934dcff47":[2,2,22], "group___t_o_o_l_s.html":[2,1], +"group___t_o_o_l_s.html#ga168919a06150d7ceb185d8293b1c6eeb":[2,1,2], "group___t_o_o_l_s.html#ga1abfca870fe9a1feae6e8d56f7af37be":[2,1,0], "group___t_o_o_l_s.html#ga66d670fc742b379c642316daf7df9bca":[2,1,1], "group___t_o_o_l_s.html#gab400fccf4b3c381c8ee8c060b56eef1b":[2,1,3], -"group___t_o_o_l_s.html#gab73eede639c03740773261c551ead9a5":[2,1,2], "index.html":[0], "index.html":[], "modules.html":[2], diff --git a/extras/apidoc/html/search/all_6.js b/extras/apidoc/html/search/all_6.js index 1550282..693bb87 100644 --- a/extras/apidoc/html/search/all_6.js +++ b/extras/apidoc/html/search/all_6.js @@ -15,7 +15,7 @@ var searchData= ['getfirmwareminorrevision_12',['getFirmwareMinorRevision',['../class_s_i4844.html#a5ffed2d0e9ea37c2d823322491e82d8b',1,'SI4844']]], ['getfirmwarepartnumber_13',['getFirmwarePartNumber',['../class_s_i4844.html#aada13c283d6450faf9f8c1b05dd86ca9',1,'SI4844']]], ['getfirmwarereserved_14',['getFirmwareReserved',['../class_s_i4844.html#af727aa9c1860b88825fb7254fdf9eabb',1,'SI4844']]], - ['getformattedfrequency_15',['getFormattedFrequency',['../group___t_o_o_l_s.html#gab73eede639c03740773261c551ead9a5',1,'SI4844']]], + ['getformattedfrequency_15',['getFormattedFrequency',['../group___t_o_o_l_s.html#ga168919a06150d7ceb185d8293b1c6eeb',1,'SI4844']]], ['getfrequency_16',['getFrequency',['../group___g_b1.html#ga0404927e7414a32125e32ff508bd450e',1,'SI4844']]], ['getfrequencyinteger_17',['getFrequencyInteger',['../group___g_b1.html#ga0eafb7b0438fb9e70c91d368929c6aed',1,'SI4844']]], ['getproperty_18',['getProperty',['../group___b_f.html#gaf4b90cf2e7a654718e2c65de5def0928',1,'SI4844']]], diff --git a/extras/apidoc/html/search/all_b.js b/extras/apidoc/html/search/all_b.js index f3fa0d7..de86ecf 100644 --- a/extras/apidoc/html/search/all_b.js +++ b/extras/apidoc/html/search/all_b.js @@ -29,7 +29,7 @@ var searchData= ['setreferenceclockprescaler_26',['setReferenceClockPrescaler',['../group___g_b1.html#gae0618088d11ae5e79193672554e39dad',1,'SI4844']]], ['setresetpin_27',['setResetPin',['../group___b_f.html#gab8dd1a10df601b5d99c29d879a2720e7',1,'SI4844']]], ['setstatusinterruptfromdevice_28',['setStatusInterruptFromDevice',['../group___b_f.html#ga1a00037a2cedbe25d1d53716a1c20c00',1,'SI4844']]], - ['setup_29',['setup',['../group___g_b1.html#ga4ee550ad12649badcb3d54da6c7e62ee',1,'SI4844']]], + ['setup_29',['setup',['../group___g_b1.html#ga11a97916ce91dfb5ad6f49e5156219b1',1,'SI4844']]], ['setvolume_30',['setVolume',['../group___g_b1.html#ga65eab6c860e3e11c5d3726144dd3b73d',1,'SI4844']]], ['si4844_31',['SI4844',['../class_s_i4844.html',1,'']]], ['si4844_2ecpp_32',['SI4844.cpp',['../_s_i4844_8cpp.html',1,'']]], diff --git a/extras/apidoc/html/search/functions_4.js b/extras/apidoc/html/search/functions_4.js index 69d07b7..2c3b0ad 100644 --- a/extras/apidoc/html/search/functions_4.js +++ b/extras/apidoc/html/search/functions_4.js @@ -13,7 +13,7 @@ var searchData= ['getfirmwareminorrevision_10',['getFirmwareMinorRevision',['../class_s_i4844.html#a5ffed2d0e9ea37c2d823322491e82d8b',1,'SI4844']]], ['getfirmwarepartnumber_11',['getFirmwarePartNumber',['../class_s_i4844.html#aada13c283d6450faf9f8c1b05dd86ca9',1,'SI4844']]], ['getfirmwarereserved_12',['getFirmwareReserved',['../class_s_i4844.html#af727aa9c1860b88825fb7254fdf9eabb',1,'SI4844']]], - ['getformattedfrequency_13',['getFormattedFrequency',['../group___t_o_o_l_s.html#gab73eede639c03740773261c551ead9a5',1,'SI4844']]], + ['getformattedfrequency_13',['getFormattedFrequency',['../group___t_o_o_l_s.html#ga168919a06150d7ceb185d8293b1c6eeb',1,'SI4844']]], ['getfrequency_14',['getFrequency',['../group___g_b1.html#ga0404927e7414a32125e32ff508bd450e',1,'SI4844']]], ['getfrequencyinteger_15',['getFrequencyInteger',['../group___g_b1.html#ga0eafb7b0438fb9e70c91d368929c6aed',1,'SI4844']]], ['getproperty_16',['getProperty',['../group___b_f.html#gaf4b90cf2e7a654718e2c65de5def0928',1,'SI4844']]], diff --git a/extras/apidoc/html/search/functions_9.js b/extras/apidoc/html/search/functions_9.js index aa07898..3887ae0 100644 --- a/extras/apidoc/html/search/functions_9.js +++ b/extras/apidoc/html/search/functions_9.js @@ -28,6 +28,6 @@ var searchData= ['setreferenceclockprescaler_25',['setReferenceClockPrescaler',['../group___g_b1.html#gae0618088d11ae5e79193672554e39dad',1,'SI4844']]], ['setresetpin_26',['setResetPin',['../group___b_f.html#gab8dd1a10df601b5d99c29d879a2720e7',1,'SI4844']]], ['setstatusinterruptfromdevice_27',['setStatusInterruptFromDevice',['../group___b_f.html#ga1a00037a2cedbe25d1d53716a1c20c00',1,'SI4844']]], - ['setup_28',['setup',['../group___g_b1.html#ga4ee550ad12649badcb3d54da6c7e62ee',1,'SI4844']]], + ['setup_28',['setup',['../group___g_b1.html#ga11a97916ce91dfb5ad6f49e5156219b1',1,'SI4844']]], ['setvolume_29',['setVolume',['../group___g_b1.html#ga65eab6c860e3e11c5d3726144dd3b73d',1,'SI4844']]] ];