PU2CLR RDA5807 Arduino Library

https://pu2clr.github.io/RDA5807/
Admin
The PU2CLR RDA5807 Arduino Library is a cross-platform Arduino library for the RDA5807 and RDA7088...
Tokens:54,118
Snippets:535
Trust Score:9.7
Update:4 months ago
Show doc for...
Tokens:
Raw
### setup

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Initializes and starts the FM receiver device with specified configuration parameters.

```APIDOC
## setup

### Description
Initializes and starts the FM receiver device with specified configuration parameters.

### Method
void

### Parameters
#### Path Parameters
- **clock_frequency** (uint8_t) - Optional - The clock frequency for the device (default CLOCK_32K).
- **oscillator_type** (uint8_t) - Optional - The type of oscillator to use (default OSCILLATOR_TYPE_PASSIVE).
- **rlck_no_calibrate** (uint8_t) - Optional - Calibration mode setting (default RLCK_NO_CALIBRATE_MODE_OFF).

### Endpoint
N/A (This is a library function call)

### Request Example
```c
setup(CLOCK_128K, OSCILLATOR_TYPE_ACTIVE, RLCK_NO_CALIBRATE_MODE_ON);
```

### Response
N/A (This is a void function)
```

--------------------------------

### Install RDA5807 Library via arduino-cli (macOS/Linux)

Source: https://pu2clr.github.io/RDA5807

Installs the latest version of the PU2CLR RDA5807 Arduino Library from GitHub using the arduino-cli on macOS or Linux. This method installs the current development version.

```bash
curl -fsSL https://raw.githubusercontent.com/arduino/arduino-cli/master/install.sh | sh
export ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true
./bin/arduino-cli lib install --git-url https://github.com/pu2clr/RDA5807

```

--------------------------------

### RDA5807 Seek Example

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Demonstrates how to use the seek function to find the next or previous station. It includes setup for Arduino pins to control seek direction and initializes the RDA5807 receiver.

```cpp
#include <RDA5807.h>
RDA5807 rx;
void setup() {
pinMode(4, INPUT_PULLUP); // Arduino pin 4 - Seek station down
pinMode(5, INPUT_PULLUP); // Arduino pin 5 - Seek station up
rx.setup(); // Starts the receiver with default parameters
rx.setFrequency(10390); // Tunes at 103.9 MHz - Switch to your local favorite station
}
void loop() {
if (digitalRead(4) == LOW) rx.seek(RDA_SEEK_WRAP,RDA_SEEK_DOWN);
if (digitalRead(5) == LOW) rx.seek(RDA_SEEK_WRAP,RDA_SEEK_UP);
delay(200);
}
```

--------------------------------

### Install RDA5807 Library via arduino-cli (Windows)

Source: https://pu2clr.github.io/RDA5807

Installs the latest version of the PU2CLR RDA5807 Arduino Library from GitHub using the arduino-cli on Windows. This method installs the current development version.

```batch
echo off  
curl -fsSL https://downloads.arduino.cc/arduino-cli/arduino-cli_latest_Windows_64bit.zip --output arduinocli.zip
tar -xf arduinocli.zip 
set ARDUINO_LIBRARY_ENABLE_UNSAFE_INSTALL=true
.\arduino-cli lib install --git-url https://github.com/pu2clr/RDA5807

```

--------------------------------

### RDA5807::setup

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA02.html

Initializes and starts the device with specified clock frequency, oscillator type, and RLCK calibration mode.

```APIDOC
## RDA5807::setup

### Description
Starts the device.

### Method
void

### Parameters
#### Path Parameters
- **clock_frequency** (uint8_t) - Optional - Default: CLOCK_32K - Description not provided
- **oscillator_type** (uint8_t) - Optional - Default: OSCILLATOR_TYPE_PASSIVE - Description not provided
- **rlck_no_calibrate** (uint8_t) - Optional - Default: RLCK_NO_CALIBRATE_MODE_OFF - Description not provided
```

--------------------------------

### RDA5807::setup

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA02.html

Starts the device, allowing selection of clock type and frequency. It configures the oscillator type and calibration mode.

```APIDOC
## RDA5807::setup()

### Description
Starts the device. You can select the clock type and the frequency.

### Parameters
- **_clock_frequency_** (uint8_t) - Optional. Clock frequency. Default is CLOCK_32K (32.768 kHz).
- **_oscillator_type_** (uint8_t) - Optional. Sets the Oscillator type (OSCILLATOR_TYPE_CRYSTAL for passive crystal; OSCILLATOR_TYPE_REFCLK for active crystal or signal generator). Default is OSCILLATOR_TYPE_PASSIVE.
- **_rlck_no_calibrate_** (uint8_t) - Optional. If 0, RCLK clock is always supplied; if 1, RCLK clock is not always supplied when FM work. Default is RLCK_NO_CALIBRATE_MODE_OFF.

### Clock Types
- CLOCK_32K
- CLOCK_12M
- CLOCK_13M
- CLOCK_19_2M
- CLOCK_24M
- CLOCK_26M
- CLOCK_38_4M

### Example Usage
```cpp
#include <RDA5807.h>

RDA5807 rx;

void setup() {
  rx.setup(); // Starts the receiver with default parameters
  // rx.setup(CLOCK_32K, OSCILLATOR_TYPE_ACTIVE); // 32.768kHz Active Crystal
  // rx.setup(CLOCK_12M, OSCILLATOR_TYPE_PASSIVE); // 12MHz passive crystal 
  // rx.setup(CLOCK_38_4M, OSCILLATOR_TYPE_PASSIVE); // 38.4 MHz passive crystal
  rx.setFrequency(10390); // Tunes at 103.9 MHz 
}

void loop() {
}
```

### See also
- OSCILLATOR_TYPE_PASSIVE, OSCILLATOR_TYPE_ACTIVE, RLCK_NO_CALIBRATE_MODE_ON, RLCK_NO_CALIBRATE_MODE_OFF
- powerUp, rda_reg02

### References
- RDA5807::powerUp()
```

--------------------------------

### getBass

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current status of the Bass Boost feature. Returns true if Bass Boost is enabled, false otherwise.

```APIDOC
## getBass

### Description
Gets the current status of the Bass Boost feature. Returns true if Bass Boost is enabled, false otherwise.

### Method
bool

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
if (getBass()) {
  // Bass Boost is enabled
}
```

### Response
#### Success Response
- **return value** (bool) - True if Bass Boost is enabled, false otherwise.
```

--------------------------------

### RDA5807::getRdsAllData

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets Station Name, Station Information, Program Information, and UTC Time.

```APIDOC
## RDA5807::getRdsAllData()

### Description
Gets Station Name, Station Information, Program Information, and UTC Time.

### Method
`bool RDA5807::getRdsAllData (char **stationName, char **stationInformation, char **programInformation, char **utcTime)`

### Parameters
- **stationName** (char **) - Output parameter for the station name.
- **stationInformation** (char **) - Output parameter for the station information.
- **programInformation** (char **) - Output parameter for the program information.
- **utcTime** (char **) - Output parameter for the UTC time.

### Response
- Returns `true` if data was successfully retrieved, `false` otherwise.
```

--------------------------------

### Basic RDA5807 Arduino Library Usage

Source: https://pu2clr.github.io/RDA5807

Demonstrates a common way to use the RDA5807 library in an Arduino sketch. It includes setup for the receiver, setting volume, and tuning to a specific frequency.

```cpp
#include <RDA5807.h>

RDA5807 rx;

void setup() {
    . 
    . 
    . 
    // Start your receiver here
    rx.setup();
    rx.setVolume(6);
    rx.setFrequency(some_frequency); // Example 10390 for 103,9 MHz
    . 
    . 
    . 
}

void loop() {
    //  Control your receiver here 
    . 
    . 
    . 
}


```

--------------------------------

### Minimal RDA5807 Arduino Receiver Implementation

Source: https://pu2clr.github.io/RDA5807

Shows the most basic implementation required to get an RDA5807 receiver working with the library. It initializes the receiver and tunes to a default frequency.

```cpp
#include <RDA5807.h> 
RDA5807 rx; 
void setup() {
  rx.setup(); // Starts the receiver with default parameters
  rx.setFrequency(10390); // Tunes in 103.9 MHz  - Switch to your local favorite station
}
void loop() {

}


```

--------------------------------

### Arduino IDE Preferences - Additional Boards Manager URLs

Source: https://pu2clr.github.io/RDA5807/examples/RDA5807_08_LILYGO_T_EMBED

Add the ESP32 board manager URL to your Arduino IDE preferences to enable installation of ESP32-based boards.

```text
https://raw.githubusercontent.com/espressif/arduino-esp32/gh-pages/package_esp32_index.json
```

--------------------------------

### getVolume

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current audio volume level. Returns the current volume setting as an 8-bit value.

```APIDOC
## getVolume

### Description
Gets the current audio volume level. Returns the current volume setting as an 8-bit value.

### Method
uint8_t

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
uint8_t current_volume = getVolume();
```

### Response
#### Success Response
- **current_volume** (uint8_t) - The current volume level (0-255).
```

--------------------------------

### Set Audio Volume and Control

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Sets the audio volume to a specific level (0-15) and provides functions to increment or decrement the volume. Also includes setup for volume control buttons.

```cpp
#include <RDA5807.h>
RDA5807 rx;
void setup() {
pinMode(4, INPUT_PULLUP); // Arduino pin 4 - Volume Up
pinMode(5, INPUT_PULLUP); // Arduino pin 5 - Volume Down
rx.setup();
rx.setFrequency(10390); // Tunes at 103.9 MHz
rx.setVolume(7);
}
void loop() {
if (digitalRead(4) == LOW) rx.setVolumeUp();
if (digitalRead(5) == LOW) rx.setVolumeDown();
delay(200);
}
```

--------------------------------

### MAX_DELAY_AFTER_OSCILLATOR Definition

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/RDA5807_8h.html

Defines the maximum delay allowed after the oscillator starts.

```c
#define | MAX_DELAY_AFTER_OSCILLATOR 100
```

--------------------------------

### Tune to Band Start Frequency

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Tunes the receiver to the lowest frequency within the current band. For band 0, this is 87MHz (represented as 8700).

```c++
void RDA5807::setFrequencyToBeginBand()
```

--------------------------------

### Initialize RDA5807 Device

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA02.html

Starts the RDA5807 device, allowing selection of clock type and frequency. Supports various clock frequencies and oscillator types (passive or active crystal).

```cpp
#include <RDA5807.h>
RDA5807 rx;
void setup() {
rx.setup(); // Starts the receiver with default parameters
// rx.setup(CLOCK_32K, OSCILLATOR_TYPE_ACTIVE); // 32.768kHz Active Crystal
// rx.setup(CLOCK_12M, OSCILLATOR_TYPE_PASSIVE); // 12MHz passive crystal 
// rx.setup(CLOCK_38_4M, OSCILLATOR_TYPE_PASSIVE); // 38.4 MHz passive crystal
rx.setFrequency(10390); // Tunes at 103.9 MHz 
}
void loop() {
}
```

--------------------------------

### setFrequencyToBeginBand()

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Tunes the receiver to the first frequency of the current band. This is useful for starting a scan from the lowest available frequency in the band.

```APIDOC
## setFrequencyToBeginBand()

### Description
Tunes the receiver at the first channel/frequency of the current band.
If the current band is 0, the lowest frequency is 87Mhz (8700).

### Method Signature
`void RDA5807::setFrequencyToBeginBand()`
```

--------------------------------

### Minimalist FM Receiver with Push Buttons

Source: https://pu2clr.github.io/RDA5807/examples

A basic FM receiver using two push buttons for station tuning (Seek Up/Down). This example is suitable for ATmega328-based boards like Arduino Uno or Nano.

```Arduino
#include <RDA5807.h> // It is a minimal receicer with two push buttons (ATmega328 - Uno, Nano etc)
RDA5807 rx;
void setup() {
  pinMode(4, INPUT_PULLUP); // Arduino pin 4 - Seek station down
  pinMode(5, INPUT_PULLUP); // Arduino pin 5 - Seek station up
  rx.setup(); // Starts the receiver with default parameters
  rx.setFrequency(10390); // Tunes in 103.9 MHz  - Switch to your local favorite station
}
void loop() {
  if (digitalRead(4) == LOW) rx.seek(RDA_SEEK_WRAP,RDA_SEEK_DOWN);
  if (digitalRead(5) == LOW) rx.seek(RDA_SEEK_WRAP,RDA_SEEK_UP);
  delay(200);
}
```

--------------------------------

### RDA5807::getBass

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Gets the status of the Bass Boost feature. Returns true if Bass Boost is enabled.

```APIDOC
## getBass

### Description
Gets Bass Boost.

### Method
```
bool RDA5807::getBass ()
```

### Returns
- FALSE = Disable; TRUE = Enable
```

--------------------------------

### Get All RDS Data

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Retrieves Station Name, Station Information, Program Information, and UTC time. Ensure setRDS(true) and setRdsFifo(true) are called before this function. The function populates provided character pointers with the respective data.

```cpp
bool RDA5807::getRdsAllData(char ** _stationName_, 
                           char ** _stationInformation_, 
                           char ** _programInformation_, 
                           char ** _utcTime_)
```

```cpp
char *stationName, *stationInfo, *programInfo, *rdsTime;
if (rx.getRdsAllData(&stationName, &stationInfo , &programInfo, &rdsTime) ) {
    showProgramaInfo(programInfo); 
    showStationName(stationName); 
    showStationInfo(stationInfo);
    showUtcTime(rdsTime);
}
```

--------------------------------

### isStereo

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current Stereo status of the audio output. Returns true if the output is Stereo, false if it is Mono.

```APIDOC
## isStereo

### Description
Gets the current Stereo status of the audio output. Returns true if the output is Stereo, false if it is Mono.

### Method
bool

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
if (isStereo()) {
  // Audio is in Stereo mode
}
```

### Response
#### Success Response
- **return value** (bool) - True if the audio output is Stereo, false otherwise.
```

--------------------------------

### rda_reg02

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Represents Register 0x02, used for basic setup including RESET configuration, clock type, seek operation, stereo/mono mode, bass, and audio settings. It also details soft reset functionality and clock mode configurations.

```APIDOC
## rda_reg02

union rda_reg02

---

Register 0x02 - Basic setup: RESET configuration;.

Clock type configuration; seek operation; Sterio/Mono; Bass; and Audio configuration
The RDA5807M is RESET itself when power up. You also can use soft reset by triggering SOFT_RESET bit to 1.
Seek begins in the direction specified by SEEKUP and ends when a channel is found, or the entire band has been searched.
The SEEK bit is set low and the STC bit is set high when the seek operation completes.
RCLK NON-CALIBRATE MODE. if 0=RCLK clock is always supply; if 1=RCLK clock is not always supply when FM work ( when 1, RDA5807M can’t directly support -20 °C ~70 °C temperature.
Only suppory ±20°C temperature swing from tune point).
Clock CLK_MODE table
Value | Clock
---
000 | 32.768kHz
001 | 12Mhz
101 | 24Mhz
010 | 13Mhz
110 | 26Mhz
011 | 19.2Mhz
111 | 38.4Mhz

### Class Members

---

- uint16_t | raw
- struct rda_reg02.refined | refined
```

--------------------------------

### Implement and Use a Seek Callback Function

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Demonstrates how to implement a callback function to display the frequency during a seek operation and how to initiate the seek process.

```cpp
#include <RDA5807.h>
SI470X rx;
void showFrequency() {
uint16_t freq = rx.getFrequency();
Serial.print(freq);
Serial.println("MHz ");
}
void loop() {
. 
. 
rx.seek(RDA_SEEK_WRAP, RDA_SEEK_UP, showFrequency); // Seek Up
. 
. 
}
```

--------------------------------

### RDA5807::setI2SOn

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA06.html

Enables or disables the I2S setup. When enabled, the RDA5807FP can output I2S signals (SCK, WS, SD) from its GPIO pins, acting as an I2S master.

```APIDOC
## RDA5807::setI2SOn()

### Description
Enables I2S setup. When setting I2S_ENABLE (register 04) bit is high, the RDA5807FP you can get the output signals SCK, WS, SD signals from GPIO3, GPIO1 and GPIO2 (I2S master).

### Parameters
- **_value_** (bool) - true or false
```

--------------------------------

### RDA5807::getRdsSync

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the RDS Sync status.

```APIDOC
## RDA5807::getRdsSync()

### Description
Gets the RDS Sync status.

### Method
`bool RDA5807::getRdsSync ()`

### Parameters
None

### Response
- Returns `true` if RDS is synchronized, `false` otherwise.
```

--------------------------------

### Configure LED for Stereo Indicator

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Sets up GPIO3 to indicate stereo reception with a LED. The LED turns on when the system is in stereo mode.

```cpp
#include <RDA5807.h>
RDA5807 rx;
void setup() {
rx.setup();
rx.setFrequency(10390); // Tunes in 103.9 MHz
rx.setLedStereoIndicator(true); // The GPIO3 (pin 15 of the RDA5807) can use to turn a LED on when Stereo
}
void loop() {
}
```

--------------------------------

### getBand3Status

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current status of Band 3 operation.

```APIDOC
## getBand3Status

### Description
Gets the current status of Band 3 operation.

### Method
uint8_t

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
uint8_t band3_status = getBand3Status();
```

### Response
#### Success Response
- **band3_status** (uint8_t) - The status of Band 3.
```

--------------------------------

### RDA5807::getFrequency

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Gets the current frequency the receiver is tuned to.

```APIDOC
## RDA5807::getFrequency

### Description
Gets the current frequency.

### Method
```
uint16_t RDA5807::getFrequency ()
```

### Returns
- uint16_t: The current frequency.
```

--------------------------------

### Check RDS Ready and Retrieve Information

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

This snippet demonstrates how to check if the RDS module is ready and then retrieve program information, station name, and time. It includes a check for available RDS information and notes that time data might be inaccurate.

```C++
if (rx.getRdsReady()) {
if (rx.hasRdsInfo() ) {
rdsMsg = rx.getRdsProgramInformation();
stationName = rx.getRdsStationName();
rdsTime = rx.getRdsTime(); 
}
}
```

--------------------------------

### RDA5807::getRdsStationInformation

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the Station Information from the RDS data.

```APIDOC
## RDA5807::getRdsStationInformation()

### Description
Gets the Station Information from the RDS data.

### Method
`char * RDA5807::getRdsStationInformation (void)`

### Parameters
None

### Response
- Returns a `char *` pointing to the station information.
```

--------------------------------

### RDA5807::getRdsStationName

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the Station Name from the RDS data.

```APIDOC
## RDA5807::getRdsStationName()

### Description
Gets the Station Name from the RDS data.

### Method
`char * RDA5807::getRdsStationName (void)`

### Parameters
None

### Response
- Returns a `char *` pointing to the station name.
```

--------------------------------

### getFrequency

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current frequency the FM receiver is tuned to, in kHz.

```APIDOC
## getFrequency

### Description
Gets the current frequency the FM receiver is tuned to, in kHz.

### Method
uint16_t

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
uint16_t current_freq = getFrequency();
```

### Response
#### Success Response
- **current_freq** (uint16_t) - The current tuned frequency in kHz.
```

--------------------------------

### RDA5807::getRealFrequency

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Gets the current frequency based on the current channel.

```APIDOC
## RDA5807::getRealFrequency

### Description
Gets the current frequency bases on the current channel.

### Method
```
uint16_t RDA5807::getRealFrequency ()
```

### Returns
- uint16_t: The current frequency.
```

--------------------------------

### RDA5807::getMinimumFrequencyOfTheBand

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Gets the minimum frequency of the current FM band.

```APIDOC
## RDA5807::getMinimumFrequencyOfTheBand

### Description
Gets the minimum frequency of the current band.

### Method
```
uint16_t RDA5807::getMinimumFrequencyOfTheBand ()
```

### Returns
- uint16_t: The first valid frequency of the current band.
```

--------------------------------

### RDA5807::getMaximunFrequencyOfTheBand

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Gets the maximum frequency of the current FM band.

```APIDOC
## RDA5807::getMaximunFrequencyOfTheBand

### Description
Gets the maximum frequency of the current band.

### Method
```
uint16_t RDA5807::getMaximunFrequencyOfTheBand ()
```

### Returns
- uint16_t: The last valid frequency of the current band.
```

--------------------------------

### RDA5807::getRdsLocalTime

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the RDS time converted to local time.

```APIDOC
## RDA5807::getRdsLocalTime()

### Description
Gets the RDS time converted to local time.

### Method
`char * RDA5807::getRdsLocalTime ()`

### Parameters
None

### Response
- Returns a `char *` pointing to the RDS local time.
```

--------------------------------

### Include RDA5807 Library

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/RDA5807_8cpp.html

Include the main RDA5807 Arduino Library header file to use its functionalities.

```cpp
#include <RDA5807.h>
```

--------------------------------

### RDA5807::getRdsText2B

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the Station Information from RDS group 2B.

```APIDOC
## RDA5807::getRdsText2B()

### Description
Gets the Station Information from RDS group 2B.

### Method
`char * RDA5807::getRdsText2B (void)`

### Parameters
None

### Response
- Returns a `char *` pointing to the station information.
```

--------------------------------

### getRdsStationInformation()

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Fetches the Station Information, which is a text string of up to 33 bytes. This function is currently under construction and may require further checks. It must be called after `getRdsReady()`.

```APIDOC
## getRdsStationInformation()

### Description
Gets the Station Information.

### Returns
`char array` with the Text of Station Information (33 bytes).

### ATTENTION
- Call `getRdsReady()` before this function.

### TODO
- Under construction... To be checked.
```

--------------------------------

### RDA5807::getRdsText2A

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the Program Information from RDS group 2A.

```APIDOC
## RDA5807::getRdsText2A()

### Description
Gets the Program Information from RDS group 2A.

### Method
`char * RDA5807::getRdsText2A (void)`

### Parameters
None

### Response
- Returns a `char *` pointing to the program information.
```

--------------------------------

### RDA5807::getRdsVersionCode

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the version code (extracted from the Block B).

```APIDOC
## RDA5807::getRdsVersionCode()

### Description
Gets the version code (extracted from the Block B).

### Method
`uint8_t RDA5807::getRdsVersionCode (void)`

### Parameters
None

### Response
- Returns a `uint8_t` representing the version code.
```

--------------------------------

### waitAndFinishTune

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Waits for the seek or tune operation to complete. This function should be called after initiating a seek or tune command.

```APIDOC
## waitAndFinishTune

### Description
Waits for the seek or tune operation to complete. This function should be called after initiating a seek or tune command.

### Method
void

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
waitAndFinishTune();
```

### Response
N/A (This is a void function)
```

--------------------------------

### Enable RDS Operation

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

This snippet demonstrates how to initialize the RDA5807 receiver and enable RDS functionality. It sets up the receiver, enables RDS, configures the FIFO mode, and sets a specific frequency for an RDS station.

```cpp
#include <RDA5807.h>
RDA5807 rx;
void setup()
rx.setup(); // Starts the receiver with default parameters
rx.setRDS(true);
rx.setRdsFifo(true);
rx.setFrequency(10390); // Station with RDS service
}
```

--------------------------------

### RDA5807::getErrorBlockA

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the current Status of block A from the RDS data.

```APIDOC
## RDA5807::getErrorBlockA()

### Description
Gets the current Status of block A from the RDS data.

### Method
`uint8_t RDA5807::getErrorBlockA ()`

### Parameters
None

### Response
- Returns a `uint8_t` representing the status of block A.
```

--------------------------------

### RDA5807::getBlockId

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the current Block ID from the RDS data.

```APIDOC
## RDA5807::getBlockId()

### Description
Gets the current Block ID from the RDS data.

### Method
`uint8_t RDA5807::getBlockId ()`

### Parameters
None

### Response
- Returns a `uint8_t` representing the current Block ID.
```

--------------------------------

### setBass

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Enables or disables the Bass Boost feature. This can enhance the low-frequency response of the audio.

```APIDOC
## setBass

### Description
Enables or disables the Bass Boost feature. This can enhance the low-frequency response of the audio.

### Method
void

### Parameters
#### Path Parameters
- **value** (bool) - Required - True to enable Bass Boost, false to disable.

### Endpoint
N/A (This is a library function call)

### Request Example
```c
setBass(true);
```

### Response
N/A (This is a void function)
```

--------------------------------

### I2S Configuration

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Functions to configure and enable the I2S interface for audio output.

```APIDOC
## setI2SOn

### Description
Enables the I2S interface setup.

### Parameters
#### Path Parameters
- **value** (bool) - Required - Set to true to enable I2S.

### Method
void

### Endpoint
N/A (SDK Method)

## setI2SAllParameters

### Description
Configures all parameters for the I2S interface.

### Parameters
#### Path Parameters
- **R_DELY** (uint8_t) - Required - Right channel delay.
- **L_DELY** (uint8_t) - Required - Left channel delay.
- **SCLK_O_EDGE** (uint8_t) - Required - SCLK output edge.
- **SW_O_EDGE** (uint8_t) - Required - SW output edge.
- **I2S_SW_CNT** (uint8_t) - Required - I2S SW count.
- **WS_I_EDGE** (uint8_t) - Required - WS input edge.
- **DATA_SIGNED** (uint8_t) - Required - Data signed setting (0 for unsigned, 1 for signed).
- **SCLK_I_EDGE** (uint8_t) - Required - SCLK input edge.
- **WS_LR** (uint8_t) - Required - WS LR setting.
- **SLAVE_MASTER** (uint8_t) - Required - Slave or Master mode.
- **OPEN_MODE** (uint8_t) - Required - Open mode setting.

### Method
void

### Endpoint
N/A (SDK Method)

## setI2SMaster

### Description
Sets the I2S interface to master mode.

### Parameters
#### Path Parameters
- **value** (bool) - Required - Set to true for master mode.

### Method
void

### Endpoint
N/A (SDK Method)

## setI2SSpeed

### Description
Sets the I2S speed in kbps. Predefined constants like I2S_WS_STEP_48, I2S_WS_STEP_44_1, I2S_WS_STEP_32 can be used.

### Parameters
#### Path Parameters
- **value** (uint8_t) - Required - The speed in kbps.

### Method
void

### Endpoint
N/A (SDK Method)

## setI2SDataSigned

### Description
Configures whether the I2S output is signed or unsigned 16-bit audio data.

### Parameters
#### Path Parameters
- **value** (bool) - Required - 0 for unsigned, 1 for signed 16-bit audio data.

### Method
void

### Endpoint
N/A (SDK Method)
```

--------------------------------

### getMute

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current status of the audio mute. This function is an alias for `isMuted`.

```APIDOC
## getMute

### Description
Gets the current status of the audio mute. This function is an alias for `isMuted`.

### Method
bool

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
if (getMute()) {
  // Audio is muted
}
```

### Response
#### Success Response
- **return value** (bool) - True if audio is muted, false otherwise.
```

--------------------------------

### setGpio

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Configures the device's GPIO pins. Allows setting pin mode and mapping to MCU pins.

```APIDOC
## setGpio

### Description
Configures the device's GPIO pins. Allows setting pin mode and mapping to MCU pins.

### Method
void

### Parameters
#### Path Parameters
- **gpioPin** (uint8_t) - Required - The GPIO pin to configure.
- **gpioSetup** (uint8_t) - Optional - The setup configuration for the GPIO pin (default 0).
- **mcuPin** (int) - Optional - The corresponding MCU pin (default -1).

### Endpoint
N/A (This is a library function call)

### Request Example
```c
setGpio(5, 1, 10);
```

### Response
N/A (This is a void function)
```

--------------------------------

### getDeviceId

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the identification of the device. This can be used to verify the connected device model.

```APIDOC
## getDeviceId

### Description
Gets the identification of the device. This can be used to verify the connected device model.

### Method
uint16_t

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
uint16_t device_id = getDeviceId();
```

### Response
#### Success Response
- **device_id** (uint16_t) - The device identification number.
```

--------------------------------

### RDA5807::getRealChannel

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA03.html

Gets the current channel stored in the 0x0A status register.

```APIDOC
## RDA5807::getRealChannel

### Description
Gets the current channel stored in 0x0A status register.

### Method
```
uint16_t RDA5807::getRealChannel ()
```

### Returns
- uint16_t: The current channel.
```

--------------------------------

### RDA5807::getRdsReady

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Returns true if RDS is ready.

```APIDOC
## RDA5807::getRdsReady()

### Description
Returns true if RDS is ready.

### Method
`bool RDA5807::getRdsReady ()`

### Parameters
None

### Response
- Returns `true` if RDS is ready, `false` otherwise.
```

--------------------------------

### RDA5807::getRdsText0A

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the station name and other messages from RDS group 0A.

```APIDOC
## RDA5807::getRdsText0A()

### Description
Gets the station name and other messages from RDS group 0A.

### Method
`char * RDA5807::getRdsText0A (void)`

### Parameters
None

### Response
- Returns a `char *` pointing to the station name and other messages.
```

--------------------------------

### setLnaPortSel

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA08.html

Configures the LNA input port selection bit. You can choose between 0 (no input), 1 (LNAN), 2 (LNAP), or 3 (dual port input) for the LNA.

```APIDOC
## setLnaPortSel(uint8_t value)

### Description
Sets LNA input port selection bit.
You can select: 0 = no input; 1 = LNAN; 2 = LNAP; 3: dual port input.

### Parameters
- **value** (uint8_t) - Required - The desired LNA input port selection (0-3).
```

--------------------------------

### RDA5807::getErrorBlockB

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the current Status of block B from the RDS data.

```APIDOC
## RDA5807::getErrorBlockB()

### Description
Gets the current Status of block B from the RDS data.

### Method
`uint8_t RDA5807::getErrorBlockB ()`

### Parameters
None

### Response
- Returns a `uint8_t` representing the status of block B.
```

--------------------------------

### RDA5807::getRdsTime

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the RDS UTC time and date when the Group type is 4.

```APIDOC
## RDA5807::getRdsTime()

### Description
Gets the RDS UTC time and date when the Group type is 4.

### Method
`char * RDA5807::getRdsTime ()`

### Parameters
None

### Response
- Returns a `char *` pointing to the RDS UTC time and date.
```

--------------------------------

### Set Audio Mono/Stereo

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Forces the audio output to mono or stereo. Set to true for mono, false to force stereo.

```cpp
void setMono(bool value)
```

--------------------------------

### RDA5807::getRdsProgramInformation

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA04.html

Gets the Program Information (RT - Radio Text) from the RDS data.

```APIDOC
## RDA5807::getRdsProgramInformation()

### Description
Gets the Program Information (RT - Radio Text) from the RDS data.

### Method
`char * RDA5807::getRdsProgramInformation (void)`

### Parameters
None

### Response
- Returns a `char *` pointing to the program information.
```

--------------------------------

### Include Arduino and Wire Libraries

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/RDA5807_8h.html

These lines include the necessary Arduino core library and the Wire library for I2C communication, which are fundamental for the RDA5807 library's operation.

```cpp
#include <Arduino.h>
#include <Wire.h>
```

--------------------------------

### RDA5807::getVolume

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Gets the current audio volume level. The returned value is between 0 and 15.

```APIDOC
## getVolume

### Description
Gets the current audio volume level.

### Method
```
uint8_t RDA5807::getVolume ()
```

### Returns
- uint8_t 0 to 15
```

--------------------------------

### RDA5807::isMuted

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Gets the current audio mute status. Returns true if the audio is muted.

```APIDOC
## isMuted

### Description
Gets Audio Mute Status.

### Method
```
bool RDA5807::isMuted ()
```

### Returns
- True if muted
```

--------------------------------

### RDA5807::setGpio

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA02.html

Configures the device's GPIO pins. Allows setting up GPIO pin functionality and MCU pin mapping.

```APIDOC
## RDA5807::setGpio

### Description
Sets the Device GPIO pins.

### Method
void

### Parameters
#### Path Parameters
- **gpioPin** (uint8_t) - Required - Description not provided
- **gpioSetup** (uint8_t) - Optional - Default: 0 - Description not provided
- **mcuPin** (int) - Optional - Default: -1 - Description not provided
```

--------------------------------

### RDA5807::isSoftmuted

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Gets the softmute status of the RDA5807 device. Returns true if softmute is enabled.

```APIDOC
## isSoftmuted

### Description
Gets the softmute status.

### Method
```
bool RDA5807::isSoftmuted ()
```

### Returns
- true if enabled
```

--------------------------------

### setMono

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Sets the audio output to Mono or forces it to Stereo.

```APIDOC
## setMono()

### Description
Sets audio Mono or stereo.

### Method
void

### Parameters
#### Value
- **value** (bool) - Required - `TRUE` to set Mono, `FALSE` to force Stereo.

### Example
```cpp
RDA5807 rx;
rx.setup();
rx.setMono(true); // Set to Mono
rx.setMono(false); // Force Stereo
```
```

--------------------------------

### isMuted

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current status of the audio mute. Returns true if the audio is muted, false otherwise.

```APIDOC
## isMuted

### Description
Gets the current status of the audio mute. Returns true if the audio is muted, false otherwise.

### Method
bool

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
if (isMuted()) {
  // Audio is muted
}
```

### Response
#### Success Response
- **return value** (bool) - True if audio is muted, false otherwise.
```

--------------------------------

### getRealChannel

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the current channel stored in the 0x0A status register. This indicates the currently selected channel.

```APIDOC
## getRealChannel

### Description
Gets the current channel stored in the 0x0A status register. This indicates the currently selected channel.

### Method
uint16_t

### Parameters
N/A

### Endpoint
N/A (This is a library function call)

### Request Example
```c
uint16_t current_channel = getRealChannel();
```

### Response
#### Success Response
- **current_channel** (uint16_t) - The current channel number.
```

--------------------------------

### getLnaPortSel

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA08.html

Retrieves the current setting for the LNA input port selection bit. This bit determines which input port is used for the LNA. Possible values are 0 (no input), 1 (LNAN), 2 (LNAP), and 3 (dual port input).

```APIDOC
## getLnaPortSel()

### Description
Gets the current value of the LNA input port selection bit.
Values: 0 = no input; 1 = LNAN; 2 = LNAP; 3: dual port input.

### Returns
- **uint8_t**: The current LNA input port selection (0-3).
```

--------------------------------

### getStatus

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the register content of a given status register. Valid register addresses are from 0x0A to 0x0F.

```APIDOC
## getStatus

### Description
Gets the register content of a given status register. Valid register addresses are from 0x0A to 0x0F.

### Method
void*

### Parameters
#### Path Parameters
- **reg** (uint8_t) - Required - The status register address (0x0A to 0x0F).

### Endpoint
N/A (This is a library function call)

### Request Example
```c
void* status_data = getStatus(0x0A);
```

### Response
#### Success Response
- **status_data** (void*) - A pointer to the status register content.
```

--------------------------------

### Custom RDA5807 Class with Extended Functionality

Source: https://pu2clr.github.io/RDA5807

This C++ code defines a custom class 'MyCustomRDA5807' that inherits from the original 'RDA5807' class. It adds new methods like 'getSoftBlendEnable' and 'getDeviceInfo', and overrides 'setFrequencyUp' and 'setFrequencyDown' to modify their behavior. This approach is useful when the existing library lacks specific features or when existing functions need to be customized.

```cpp
#include <RDA5807.h>
class MyCustomRDA5807 : public RDA5807 {  // extending the original class RDA5807

private: 
  // Implements some specific members and methods to the new class if necessary
  uint16_t up_limit, down_limit;

  void getBandLimits() { 
    if (this->getBand3Status() == 0) {
      up_limit = 6500;
      down_limit = 5000;
    } else {
      up_limit = this->endBand[this->currentFMBand];
      down_limit = this->startBand[this->currentFMBand];
    }
  }

public:
  // Implements some new members functions to the new class
  int getSoftBlendEnable() {  // A RDA5807 command that PU2CLR RDA5807 Arduino Library does not implement
    rda_reg07 tmp;
    tmp.raw = this->getDirectRegister(0x07).raw;
    return tmp.refined.SOFTBLEND_EN;
  }

  uint16_t getDeviceInfo() {  // another RDA5807 command that PU2CLR RDA5807 Arduino Library does not implement
      rda_reg00 tmp;
      tmp.raw = this->getDirectRegister(0x00).raw;
      return tmp.refined.HIGH_CHIP_ID;
  }

  // Overwriting parent method setFrequencyUp - Chenging the behavior of the setFrequencyUp function
  void setFrequencyUp() {
    getBandLimits();
    if (this->currentFrequency < up_limit)
      this->currentFrequency += (this->fmSpace[currentFMSpace]);
    else
      this->currentFrequency = down_limit;

    setFrequency(this->currentFrequency);
  }

  // Overwriting parent method setFrequencyDown - Chenging the behavior of the setFrequencyDown function
  void setFrequencyDown() {
    getBandLimits();
    if (this->currentFrequency > down_limit)
      this->currentFrequency -= (this->fmSpace[currentFMSpace]);
    else
      this->currentFrequency = up_limit;

    setFrequency(this->currentFrequency);
  }
};

MyCustomRDA5807 radio;  // the instance of your custom class based on RDA5807 class

void setup() {
  Serial.begin(9600);
  while (!Serial);
  Serial.println("Customizing RDA5807 class example.");
  radio.setup();
  radio.setFrequency(10390);
  Serial.println(radio.getSoftBlendEnable());
  Serial.println(radio.getDeviceInfo());
  radio.setBand(3);
  radio.setBand3_50_65_Mode(0);
}

void loop() {

  radio.setFrequency(6500);
  Serial.println(radio.getFrequency());
  delay(2000);
  radio.setFrequencyUp();  // Go to 50 MHz
  Serial.println(radio.getFrequency());
  delay(2000);
  radio.setFrequencyDown();  // Go to 65 MHz
  Serial.println(radio.getFrequency());
  delay(2000);
}

```

--------------------------------

### getDirectRegister

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA01.html

Gets the content of a specific register via direct access. This is useful for low-level register inspection.

```APIDOC
## getDirectRegister

### Description
Gets the content of a specific register via direct access. This is useful for low-level register inspection.

### Method
word16_to_bytes

### Parameters
#### Path Parameters
- **reg** (uint8_t) - Required - The register address to read from.

### Endpoint
N/A (This is a library function call)

### Request Example
```c
word16_to_bytes register_content = getDirectRegister(0x01);
```

### Response
#### Success Response
- **register_content** (word16_to_bytes) - The content of the specified register.
```

--------------------------------

### setVolumeUp

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Increments the audio volume by one level.

```APIDOC
## setVolumeUp()

### Description
Increments the audio volume.

### Method
void

### Example
```cpp
RDA5807 rx;
rx.setup();
rx.setVolumeUp(); // Increase volume by one level
```
```

--------------------------------

### RDA5807::isStereo

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/group__GA07.html

Gets the current Stereo status of the audio output. Returns true if the output is Stereo.

```APIDOC
## isStereo

### Description
Gets the current Stereo status.

### Method
```
bool RDA5807::isStereo ()
```

### Returns
- TRUE if stereo
```

--------------------------------

### I2S Word Select Step Definitions

Source: https://pu2clr.github.io/RDA5807/extras/apidoc/html/RDA5807_8h.html

Macros defining step values for I2S Word Select (WS) signals, corresponding to different sample rates.

```c
#define | I2S_WS_STEP_48 0b1000
```

```c
#define | I2S_WS_STEP_44_1 0b0111
```

```c
#define | I2S_WS_STEP_32 0b0110
```

```c
#define | I2S_WS_STEP_24 0b0101
```

```c
#define | I2S_WS_STEP_22_05 0b0100
```

```c
#define | I2S_WS_STEP_16 0b0011
```

```c
#define | I2S_WS_STEP_12 0b0010
```

```c
#define | I2S_WS_STEP_11_025 0b0001
```

```c
#define | I2S_WS_STEP_8 0b0000
```
Tokens:
Raw