RadioControl.hxx

Go to the documentation of this file.

#pragma once
/*
Copyright (c) 2026 Matthew H. Reilly (kb1vc)
All rights reserved.
 
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are
met:
 
    Redistributions of source code must retain the above copyright
    notice, this list of conditions and the following disclaimer.
    Redistributions in binary form must reproduce the above copyright
    notice, this list of conditions and the following disclaimer in
    the documentation and/or other materials provided with the
    distribution.
 
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/

 
#include "SoDaBase.hxx"
#include "SoDaThread.hxx"
#include "Command.hxx"
#include "Params.hxx"
#include <SoDa/MailBox.hxx>
 
namespace SoDa {
  class RadioControl;
  typedef std::shared_ptr<RadioControl> RadioControlPtr;
  
  class RadioControl : public SoDa::Thread {
  public:
    RadioControl(ParamsPtr params, const std::string & name);

    void run() final;

    virtual void init() { }
    
    void subscribeToMailBoxes(const std::vector<MailBoxBasePtr> & mailboxes); 
 
    virtual RadioControlPtr getSelfPtr() = 0;
    
  protected:
    ParamsPtr params; 
    virtual void execCommand(CommandPtr cmd) final;
 
    virtual void execGetCommand(CommandPtr cmd) final; 
 
    void execSetCommand(CommandPtr cmd) final; 
 
    void execRepCommand(CommandPtr cmd) final; 

    double getTime();
 
 
  private:
    // These are the command handlers. They call virtual methods provided
    // by specific radio modules. They can't be over-ridden. 
    virtual void reportAntennas() final;
 

    bool isLocked(SoDa::RXTX rxtx);
    
    void auxRun() { }
    void subExecGetCommand(CommandPtr cmd) { }
    void subExecSetCommand(CommandPtr cmd) { }
    void subExecRepCommand(CommandPtr cmd) { }
    
 
  protected:

    virtual bool isLOLocked(SoDa::RXTX rxtx) = 0; 

    virtual std::vector<std::string> listAntennas(SoDa::RXTX rxtx) = 0; 

    virtual void setAntenna(const std::string & ant, SoDa::RXTX rxtx) = 0;

    virtual std::string getAntenna(SoDa::RXTX rxtx) = 0;
    
    virtual void setSampleRate(float rate, SoDa::RXTX rxtx) = 0;

    virtual float getSampleRate(SoDa::RXTX rxtx) = 0;
    
    virtual float setRFGain(float gain, SoDa::RXTX rxtx) = 0;

    virtual double setLOFreq(double freq, SoDa::RXTX rxtx) = 0;
 
 
    virtual double getLOFreq(SoDa::RXTX rxtx) = 0;
    
    void setFreq(double freq, SoDa::RXTX rxtx);
    
    virtual bool getTXEna() = 0;
    virtual bool getTXRelayOn() = 0;

    virtual void setTXEna(bool tx_on, bool full_duplex) = 0;


    void setTXRXMode(Command::RxTxState rxtxst, bool full_duplex);

    virtual bool setClockSource(Command::ClockSource src);
    

    virtual Command::ClockSource getClockSource();

    virtual std::string getHardwareDescription() = 0;
 
 
  protected:

    double findGoodRXLO(double freq, double cur_lo_freq);
    
    CmdMBoxPtr cmd_stream; 
    CmdMBox::Subscription cmd_subs;   
 
    double first_gettime; 
 
    // gain settings
    double rx_rf_gain; 
    double tx_rf_gain; 
 
    // state of the box
    bool tx_on; 
 
    double cur_rx_lo_freq; 
    double cur_rx_if_freq; 
    double cur_tx_lo_freq; 
    double cur_tx_if_freq; 
 
    static const double tx_freq_rxmode_offset; 
 
    double tx_samp_rate; 
    std::string tx_ant;  
 
    std::string motherboard_name; 
 
    // transverter local oscillator support.
    bool tvrt_lo_capable; 
    bool tvrt_lo_mode; 
    double tvrt_lo_gain; 
    double tvrt_lo_freq; 
    double tvrt_lo_fe_freq; 
    
    // enables verbose messages
    bool debug_mode; 
  };
}