SI4705.h

Go to the documentation of this file.

#ifndef SI4705_h
#define SI4705_h

#include <arduino.h>

// The wire library is used for the communication with the radio chip.
#include <Wire.h>

// Include the radio library that is extended by the SI4705 library.
#include <radio.h>

// ----- library definition -----

class SI4705 : public RADIO {
public:
  const uint8_t MAXVOLUME = 15;   
  const uint8_t MAXVOLUMEX = 63;  

  SI4705();

  bool   init();  
  void   term();  

  // ----- Audio functions -----

  void    setVolume(uint8_t newVolume);   

  void    setVolumeX(uint8_t newVolume);  
  uint8_t getVolumeX();                   

  void    setMute(bool switchOn);         
  void    setSoftMute(bool switchOn);     

  // Overwrite audio functions that are not supported.
  void    setBassBoost(bool switchOn);    

  // ----- Radio receiver functions -----

  void    setMono(bool switchOn);         

  void    setBand(RADIO_BAND newBand);    

  void    setFrequency(RADIO_FREQ newF);  
  RADIO_FREQ getFrequency(void);

  void seekUp(bool toNextSender = true);   // start seek mode upwards
  void seekDown(bool toNextSender = true); // start seek mode downwards

  void checkRDS(); // read RDS data from the current station and process when data available.

  void getRadioInfo(RADIO_INFO *info);
  void getAudioInfo(AUDIO_INFO *info);

  // ----- debug Helpers send information to Serial port

  void  debugScan();               // Scan all frequencies and report a status
  void  debugStatus();             // Report Info about actual Station

private:
  // ----- local variables

  uint8_t _realVolume; 

  // store the current status values
  uint8_t _status;        

  uint8_t tuneStatus[8];
  uint8_t rsqStatus[1 + 7];
  uint8_t rdsStatusx[1 + 12];
  uint8_t agcStatus[1 + 2];

  union {
    // use structured access 
    struct {
      uint8_t  status;
      uint8_t  resp1;
      uint8_t  resp2;
      uint8_t  rdsFifoUsed;
      uint8_t  blockAH; uint8_t  blockAL;
      uint8_t  blockBH; uint8_t  blockBL;
      uint8_t  blockCH; uint8_t  blockCL;
      uint8_t  blockDH; uint8_t  blockDL;
      uint8_t  blockErrors;
    };
    // use the the byte while receiving and sending.
    uint8_t buffer[1 + 12];
  } rdsStatus; // union RDSSTATUS


  // ----- low level communication to the chip using I2C bus

  void _sendCommand(int cnt, int cmd, ...);

  void _setProperty(uint16_t prop, uint16_t value);

  uint8_t _readStatus();

  void _readStatusData(uint8_t cmd, uint8_t param, uint8_t *values, uint8_t len);

  void _seek(bool seekUp = true);
  void _waitEnd();
};

#endif