PU2CLR RDA5807 Arduino Library 1.1.3
Arduino Library for RDA5807 Devices - By Ricardo Lima Caratti
Loading...
Searching...
No Matches
FM Tune Functions

Functions

uint8_t RDA5807::getSpace ()
 Returns the current Band Space.
 
bool RDA5807::isFmTrue ()
 Returns true if the current channel is a station.

 
bool RDA5807::isFmReady ()
 Returns true if the FM is ready.

 
void RDA5807::setGpio (uint8_t gpioPin, uint8_t gpioSetup=0, int mcuPin=-1)
 Set the Device GPIO pins.
 
void RDA5807::setSoftBlendEnable (bool value)
 Sets Soft Blend.
 
void RDA5807::setAFC (bool value)
 Sets AFC true or false.
 
void RDA5807::setChannel (uint16_t channel)
 Sets the channel.
 
void RDA5807::setFrequency (uint16_t frequency)
 Sets the frequency.
 
void RDA5807::setFrequencyUp ()
 Increments the current frequency.
 
void RDA5807::setFrequencyDown ()
 Decrements the current frequency.
 
uint16_t RDA5807::getFrequency ()
 Gets the current frequency.
 
uint16_t RDA5807::getRealChannel ()
 Gets the current channel stored in 0x0A status register.
 
uint16_t RDA5807::getRealFrequency ()
 Gets the current frequency bases on the current channel.
 
void RDA5807::seek (uint8_t seek_mode, uint8_t direction)
 Seek function.
 
void RDA5807::seek (uint8_t seek_mode, uint8_t direction, void(*showFunc)())
 Seek function.
 
void RDA5807::setSeekThreshold (uint8_t value)
 Sets RSSI Seek Threshold.
 
void RDA5807::setBand (uint8_t band=0)
 Sets the FM band. See table below.
 
void RDA5807::setSpace (uint8_t space=0)
 Sets the FM channel space.
 
void RDA5807::setStep (uint8_t step=100)
 Sets the FM Step;.
 
int RDA5807::getRssi ()
 Gets the current Rssi.
 
uint8_t RDA5807::getDeviceId ()
 Gets the Device identification.
 
void RDA5807::setFmDeemphasis (uint8_t de)
 Sets De-emphasis.
 

Detailed Description

Basic

Function Documentation

◆ getSpace()

uint8_t RDA5807::getSpace ( )
inline

Returns the current Band Space.

Returns
uint8_t value (0 = 100kHz, 1 = 200kHz, 2 = 50kHz e 3 = 25kHz)

Definition at line 676 of file RDA5807.h.

◆ isFmTrue()

bool RDA5807::isFmTrue ( )
inline

Returns true if the current channel is a station.

Returns
true or false

Definition at line 686 of file RDA5807.h.

◆ isFmReady()

bool RDA5807::isFmReady ( )
inline

Returns true if the FM is ready.

Returns
true or false

Definition at line 693 of file RDA5807.h.

◆ setGpio()

void RDA5807::setGpio ( uint8_t  gpioPin,
uint8_t  gpioSetup = 0,
int  mcuPin = -1 
)

Set the Device GPIO pins.

This method is useful to add control to the system via GPIO RDA devive pins.

For example: You can use these pins to control RDS and SEEK via interrupt.

GPIOs are General Purpose I/O pin.

GPIO setup

When GPIO1 (#1), gpioSetup can be: 00 = High impedance; 01 = Reserved; 10 = Low; 11 = High

When GPIO2 (#2), gpioSetup can be: 00 = High impedance; 01 = Interrupt (INT) 10 = Low; 11 = High

When GPIO3 (#3), gpioSetup can be: 00 = High impedance; 01 = Mono/Stereo indicator (ST) = Low; 11 = High

Parameters
gpioPingpio number (1, 2 or 3)
gpioSetupSee description above
mcuPipMCU (Arduino) pin connected to the gpio

Definition at line 34 of file RDA5807.cpp.

◆ setSoftBlendEnable()

void RDA5807::setSoftBlendEnable ( bool  value)

Sets Soft Blend.

Parameters
valuetrue or false

Definition at line 238 of file RDA5807.cpp.

◆ setAFC()

void RDA5807::setAFC ( bool  value)

Sets AFC true or false.

Parameters
valuetrue or false

Definition at line 249 of file RDA5807.cpp.

◆ setChannel()

void RDA5807::setChannel ( uint16_t  channel)

Sets the channel.

This method tunes the rteceiver in a given channel.

The channel can be calculated by using the follow formula

channel = (desired frequency - start band frequency) / space channel in use / 10.0);

See also
setFrequency, setBand, setSpace
RDA5807M - SINGLE-CHIP BROADCAST FM RADIO TUNER - Rev.1.1–Aug.2015; pages 9 and 12.
Parameters
channel

Definition at line 268 of file RDA5807.cpp.

References RDA5807::waitAndFinishTune().

◆ setFrequency()

void RDA5807::setFrequency ( uint16_t  frequency)

Sets the frequency.

Parameters
frequency

Definition at line 284 of file RDA5807.cpp.

◆ setFrequencyUp()

void RDA5807::setFrequencyUp ( )

Increments the current frequency.

The increment uses the band space as step. See array: uint16_t fmSpace[4] = {100/10, 200/10, 50/10, 25/10};

Definition at line 296 of file RDA5807.cpp.

◆ setFrequencyDown()

void RDA5807::setFrequencyDown ( )

Decrements the current frequency.

The drecrement uses the band space as step. See array: uint16_t fmSpace[4] = {20, 10, 5, 1};

Definition at line 311 of file RDA5807.cpp.

◆ getFrequency()

uint16_t RDA5807::getFrequency ( )

Gets the current frequency.

Returns
uint16_t

Definition at line 326 of file RDA5807.cpp.

◆ getRealChannel()

uint16_t RDA5807::getRealChannel ( )

Gets the current channel stored in 0x0A status register.

See also
setChannel, setFrequency, setBand, setSpace
RDA5807M - SINGLE-CHIP BROADCAST FM RADIO TUNER - Rev.1.1–Aug.2015; pages 9 and 12.
Returns
uint16_t current channel value

Definition at line 340 of file RDA5807.cpp.

◆ getRealFrequency()

uint16_t RDA5807::getRealFrequency ( )

Gets the current frequency bases on the current channel.

The current channel is stored in the 0x0A register. This value is updated after a tune or seek operation.

The current frequency can be calculated by the formula below

Band Formula
0 Frequency = Channel Spacing (kHz) x READCHAN[9:0]+ 87.0 MHz
1 or 2 Frequency = Channel Spacing (kHz) x READCHAN[9:0]+ 76.0 MHz
3 Frequency = Channel Spacing (kHz) x READCHAN[9:0]+ 65.0 MHz
See also
setChannel, setFrequency, setBand, setSpace
RDA5807M - SINGLE-CHIP BROADCAST FM RADIO TUNER - Rev.1.1–Aug.2015; pages 9 and 12.
Returns
uint16_t

Definition at line 362 of file RDA5807.cpp.

◆ seek() [1/2]

void RDA5807::seek ( uint8_t  seek_mode,
uint8_t  direction 
)

Seek function.

Parameters
seek_modeif 0, wrap at the upper or lower band limit and continue seeking; 1 = stop seeking at the upper or lower band limit
directionif 0, seek down; if 1, seek up.

Definition at line 373 of file RDA5807.cpp.

◆ seek() [2/2]

void RDA5807::seek ( uint8_t  seek_mode,
uint8_t  direction,
void(*)()  showFunc 
)

Seek function.

Seeks a station up or down.

Seek up or down a station and call a function defined by the user to show the frequency during the seek process.

Seek begins at the current channel, and goes in the direction specified with the SEEKUP bit. Seek operation stops when a channel is qualified as valid according to the seek parameters, the entire band has been searched (SKMODE = 0), or the upper or lower band limit has been reached (SKMODE = 1).

The STC bit is set high when the seek operation completes and/or the SF/BL bit is set high if the seek operation was unable to find a channel qualified as valid according to the seek parameters. The STC and SF/BL bits must be set low by setting the SEEK bit low before the next seek or tune may begin.

The SEEK bit is set low and the STC bit is set high when the seek operation completes.

It is important to say you have to implement a show frequency function. This function have to get the frequency via getFrequency function.

Example:

SI470X rx;
void showFrequency() {
uint16_t freq = rx.getFrequency();
Serial.print(freq);
Serial.println("MHz ");
}
void loop() {
.
.
rx.seek(SI470X_SEEK_WRAP, SI470X_SEEK_UP, showFrequency); // Seek Up
.
.
}
Parameters
seek_modeSeek Mode; 0 = Wrap at the upper or lower band limit and continue seeking (default); 1 = Stop seeking at the upper or lower band limit.
directionSeek Direction; 0 = Seek down (default); 1 = Seek up.
showFuncfunction that you have to implement to show the frequency during the seeking process. Set NULL if you do not want to show the progress.

Definition at line 413 of file RDA5807.cpp.

References RDA5807::waitAndFinishTune().

◆ setSeekThreshold()

void RDA5807::setSeekThreshold ( uint8_t  value)

Sets RSSI Seek Threshold.

Parameters
value

Definition at line 441 of file RDA5807.cpp.

◆ setBand()

void RDA5807::setBand ( uint8_t  band = 0)

Sets the FM band. See table below.

FM band table

Value Description
00 87–108 MHz (US/Europe)
01 76–91 MHz (Japan)
10 76–108 MHz (world wide)
11 65 –76 MHz (East Europe) or 50-65MHz (see bit 9 of gegister 0x06)
Parameters
bandFM band index. See table above.

Definition at line 462 of file RDA5807.cpp.

◆ setSpace()

void RDA5807::setSpace ( uint8_t  space = 0)

Sets the FM channel space.

Channel space table

Value Description
00 100KHz
01 200KHz
10 50KHz
11 25KHz
Parameters
spaceFM channel space. See table above.
Todo:
make the space 01 (200kHz) work.

Definition at line 485 of file RDA5807.cpp.

◆ setStep()

void RDA5807::setStep ( uint8_t  step = 100)

Sets the FM Step;.

  • Converts the step frequency (25, 50, 100 or 200 kHz) to Space. Invalid values will be converted to 0 (100 kHz)
    Parameters
    step25, 50, 100 or 200 kHz
    Todo:
    Make the step 200kHz work well

Definition at line 499 of file RDA5807.cpp.

◆ getRssi()

int RDA5807::getRssi ( )

Gets the current Rssi.

RSSI; 000000 = min; 111111 = max; RSSI scale is logarithmic.

Returns
int

Definition at line 529 of file RDA5807.cpp.

◆ getDeviceId()

uint8_t RDA5807::getDeviceId ( )

Gets the Device identification.

Todo:
Returns
number

Definition at line 542 of file RDA5807.cpp.

◆ setFmDeemphasis()

void RDA5807::setFmDeemphasis ( uint8_t  de)

Sets De-emphasis.

75 μs. Used in USA (default); 50 μs. Used in Europe, Australia, Japan.

Parameters
de0 = 75 μs; 1 = 50 μs

Definition at line 554 of file RDA5807.cpp.