radio.h

Go to the documentation of this file.

#ifndef __RADIO_h__
#define __RADIO_h__

#include <arduino.h>
#include <Wire.h>

// The DEBUG_xxx Macros enable Information to the Serial port.
// They can be enabled by setting the _debugEnabled variable to true disabled by using the debugEnable function.
// When the code has to be minimized they can be redefined without implementation like:
// #define DEBUG_STR(txt) {}

#define DEBUG_STR(txt)           if (_debugEnabled) { Serial.println(txt); }

#define DEBUG_VAL(label, val)    if (_debugEnabled) { Serial.print(label);  Serial.print(':');  Serial.println(val); }
#define DEBUG_VALX(label, val)    if (_debugEnabled) { Serial.print(label);  Serial.print(':');  Serial.println(val, HEX); }

#define DEBUG_FUNC0(fn)          if (_debugEnabled) { Serial.print(fn); Serial.println("()"); }

#define DEBUG_FUNC1(fn, p1)      if (_debugEnabled) { Serial.print(fn); Serial.print('('); Serial.print(p1); Serial.println(')'); }

#define DEBUG_FUNC1X(fn, p1) if (_debugEnabled) { Serial.print(fn); Serial.print("(0x"); Serial.print(p1, HEX); Serial.println(')'); }

#define DEBUG_FUNC2(fn, p1, p2)  if (_debugEnabled) { Serial.print(fn); Serial.print('('); Serial.print(p1); Serial.print(", "); Serial.print(p2); Serial.println(')'); }

#define DEBUG_FUNC2X(fn, p1, p2) if (_debugEnabled) { Serial.print(fn); Serial.print("(0x"); Serial.print(p1, HEX); Serial.print(", 0x"); Serial.print(p2, HEX); Serial.println(')'); }


// ----- Callback function types -----

extern "C" {
  typedef void(*receiveRDSFunction)(uint16_t block1, uint16_t block2, uint16_t block3, uint16_t block4);
}


// ----- type definitions -----

enum RADIO_BAND {
  RADIO_BAND_NONE = 0, 

  RADIO_BAND_FM = 1, 
  RADIO_BAND_FMWORLD = 2, 
  RADIO_BAND_AM = 3, 
  RADIO_BAND_KW = 4, 

  RADIO_BAND_MAX = 4  
};


typedef uint16_t RADIO_FREQ;


typedef struct RADIO_INFO {
  bool active;   
  uint8_t rssi;  
  bool rds;      
  bool tuned;    
  bool mono;     
  bool stereo;   
};


typedef struct AUDIO_INFO {
  uint8_t volume;
  bool mute;
  bool softmute;
  bool bassBoost;
};

// ----- common RADIO class definition -----

class RADIO {

public:
  const uint8_t MAXVOLUME = 15; 

  RADIO(); 

  virtual bool   init();  
  virtual void   term();  

  // ----- Audio features -----

  virtual void    setVolume(uint8_t newVolume); 
  virtual uint8_t getVolume();                  

  virtual void    setMute(bool switchOn);       
  virtual bool    getMute();                    

  virtual void    setSoftMute(bool switchOn);   
  virtual bool    getSoftMute();                

  virtual void    setBassBoost(bool switchOn);  
  virtual bool    getBassBoost();               

  // ----- Receiver features -----

  virtual RADIO_FREQ getMinFrequency();     
  virtual RADIO_FREQ getMaxFrequency();     
  virtual RADIO_FREQ getFrequencyStep();    

  virtual void       setBand(RADIO_BAND newBand);   
  virtual RADIO_BAND getBand();                     

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

  virtual void       setBandFrequency(RADIO_BAND newBand, RADIO_FREQ newFreq); 

  virtual void       seekUp(bool toNextSender = true);   
  virtual void       seekDown(bool toNextSender = true); 

  virtual void       setMono(bool switchOn);   
  virtual bool       getMono();                

  // ----- combined status functions -----

  virtual void getRadioInfo(RADIO_INFO *info); 

  virtual void getAudioInfo(AUDIO_INFO *info); 

  // ----- Supporting RDS for FM bands -----

  virtual void checkRDS(); 
  virtual void clearRDS(); 
  virtual void attachReceiveRDS(receiveRDSFunction newFunction); 

  // ----- Utilitys -----

  virtual void formatFrequency(char *s, uint8_t length);

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

  virtual void debugEnable(bool enable = true);  
  virtual void debugRadioInfo(); 
  virtual void debugAudioInfo(); 
  virtual void debugStatus();    

protected:
  bool _debugEnabled; 

  uint8_t _volume;    
  bool    _bassBoost; 
  bool    _mono;      
  bool    _mute;      
  bool    _softMute;  

  RADIO_BAND _band;   
  RADIO_FREQ _freq;   

  RADIO_FREQ _freqLow;    
  RADIO_FREQ _freqHigh;   
  RADIO_FREQ _freqSteps;  

  receiveRDSFunction _sendRDS; 

  void _printHex4(uint16_t val); 

private:
  void int16_to_s(char *s, uint16_t val); 

}; // class RADIO


#endif

// End.