ocam2KCtrl.hpp

Go to the documentation of this file.

/** \file ocam2KCtrl.hpp
  * \brief The MagAO-X OCAM2K EMCCD camera controller.
  *
  * \author Jared R. Males (jaredmales@gmail.com)
  *
  * \ingroup ocam2KCtrl_files
  */
 
#ifndef ocam2KCtrl_hpp
#define ocam2KCtrl_hpp
 
 
#include <edtinc.h>
 
 
 
#include "../../libMagAOX/libMagAOX.hpp" //Note this is included on command line to trigger pch
#include "../../magaox_git_version.h"
 
typedef MagAOX::app::MagAOXApp<true> MagAOXAppT; //This needs to be before pdvUtils.hpp for logging to work.
 
#include "fli/ocam2_sdk.h"
#include "ocamUtils.hpp"
 
namespace MagAOX
{
namespace app
{
 
/** \defgroup ocam2KCtrl OCAM2K EMCCD Camera
  * \brief Control of the OCAM2K EMCCD Camera.
  *
  * <a href="../handbook/operating/software/apps/ocam2KCtrl.html">Application Documentation</a>
  *
  * \ingroup apps
  *
  */
 
/** \defgroup ocam2KCtrl_files OCAM2K EMCCD Camera Files
  * \ingroup ocam2KCtrl
  */
 
/** MagAO-X application to control the OCAM 2K EMCCD
  *
  * \ingroup ocam2KCtrl
  * 
  */
class ocam2KCtrl : public MagAOXApp<>, public dev::stdCamera<ocam2KCtrl>, public dev::edtCamera<ocam2KCtrl>, public dev::frameGrabber<ocam2KCtrl>,  
                                           public dev::dssShutter<ocam2KCtrl>, public dev::telemeter<ocam2KCtrl>
{
    friend class dev::stdCamera<ocam2KCtrl>;
    friend class dev::edtCamera<ocam2KCtrl>;
    friend class dev::frameGrabber<ocam2KCtrl>;
    friend class dev::dssShutter<ocam2KCtrl>;
    friend class dev::telemeter<ocam2KCtrl>;
    
    typedef MagAOXApp<> MagAOXAppT;
   
public:
    /** \name app::dev Configurations
      *@{
      */
    static constexpr bool c_stdCamera_tempControl = true; ///< app::dev config to tell stdCamera to expose temperature controls
    
    static constexpr bool c_stdCamera_temp = true; ///< app::dev config to tell stdCamera to expose temperature (ignored since tempControl==true)
 
    static constexpr bool c_stdCamera_readoutSpeed = false; ///< app::dev config to tell stdCamera not to expose readout speed controls
    
    static constexpr bool c_stdCamera_vShiftSpeed = false; ///< app:dev config to tell stdCamera not to expose vertical shift speed control
 
    static constexpr bool c_stdCamera_emGain = true; ///< app::dev config to tell stdCamera to expose EM gain controls 
    
    static constexpr bool c_stdCamera_exptimeCtrl = false; ///< app::dev config to tell stdCamera not to expose exposure time controls
    
    static constexpr bool c_stdCamera_fpsCtrl = true; ///< app::dev config to tell stdCamera to expose FPS controls
 
    static constexpr bool c_stdCamera_fps = true; ///< app::dev config to tell stdCamera not to expose FPS status (ignored since fpsCtrl==true)
    
    static constexpr bool c_stdCamera_synchro = true; ///< app::dev config to tell stdCamera to expose synchro mode controls
 
    static constexpr bool c_stdCamera_usesModes = true; ///< app:dev config to tell stdCamera not to expose mode controls
    
    static constexpr bool c_stdCamera_usesROI = false; ///< app:dev config to tell stdCamera to expose ROI controls
 
    static constexpr bool c_stdCamera_cropMode = false; ///< app:dev config to tell stdCamera to expose Crop Mode controls
    
    static constexpr bool c_stdCamera_hasShutter = true; ///< app:dev config to tell stdCamera to expose shutter controls
 
    static constexpr bool c_stdCamera_usesStateString = true; ///< app::dev confg to tell stdCamera to expose the state string property
 
    static constexpr bool c_edtCamera_relativeConfigPath = true; ///< app::dev config to tell edtCamera to use relative path to camera config file
    
    static constexpr bool c_frameGrabber_flippable = false; ///< app:dev config to tell framegrabber these images can not be flipped
    
    ///@}
protected:
 
    /** \name configurable parameters 
      *@{
      */ 
 
    //Camera:
 
    std::string m_ocamDescrambleFile; ///< Path the OCAM 2K pixel descrambling file, relative to MagAO-X config directory.
 
    
    
    ///@}
    
    ocam2_id m_ocam2_id {0}; ///< OCAM SDK id.
    
    long m_currImageNumber {-1}; ///< The current image number, retrieved from the image itself.
        
    long m_lastImageNumber {-1};  ///< The last image number, saved from the last loop through.
 
    bool m_protectionReset {false}; ///< Flag indicating that protection has been reset at least once.
    
    unsigned m_protectionResetConfirmed {0}; ///< Counter indicating the number of times that the protection reset has been requested within 10 seconds, for confirmation.
 
    double m_protectionResetReqTime {0}; ///< The time at which protection reset was requested.  You have 10 seconds to confirm.
 
    bool m_poweredOn {false};
    
    ocamTemps m_temps; ///< Structure holding the last temperature measurement.
   
    unsigned m_digitalBinX {1};
    
    unsigned m_digitalBinY {1};
 
    bool m_digitalBin {false};
 
    mx::improc::eigenImage<int16_t> m_digitalBinWork;
 
    std::string m_syncDevice {"fxngensync"};
    std::string m_syncFreqProp {"C1freq"};
 
    float m_syncFreq {0};
 
public:
 
   ///Default c'tor
   ocam2KCtrl();
 
   ///Destructor
   ~ocam2KCtrl() noexcept;
 
   /// Setup the configuration system (called by MagAOXApp::setup())
   virtual void setupConfig();
 
   /// load the configuration system results (called by MagAOXApp::setup())
   virtual void loadConfig();
 
   /// Startup functions
   /** Sets up the INDI vars, and the f.g. thread.
     *
     */
   virtual int appStartup();
 
   /// Implementation of the FSM for the OCAM 2K.
   virtual int appLogic();
 
   /// Implementation of the on-power-off FSM logic
   virtual int onPowerOff();
 
   /// Implementation of the while-powered-off FSM
   virtual int whilePowerOff();
 
   /// Do any needed shutdown tasks. 
   virtual int appShutdown();
 
   /// Get the current device temperatures
   /**
     * \returns 0 on success
     * \returns -1 on error
     */ 
   int getTemps();
   
   /// Get the current frame rate.
   /**
     * \returns 0 on success
     * \returns -1 on error
     */
   int getFPS();
 
   /** \name stdCamera Interface 
     * 
     * @{
     */
   
   /// Set defaults for a power on state.
   /** 
     * \returns 0 on success
     * \returns -1 on error
     */ 
   int powerOnDefaults();
   
   /// Turn temperature control on or off.
   /** Sets temperature control on or off based on the current value of m_tempControlStatus
     * \returns 0 on success
     * \returns -1 on error
     */ 
   int setTempControl();
   
   /// Set the CCD temperature setpoint [stdCamera interface].
   /** Sets the temperature to m_ccdTempSetpt.
     * \returns 0 on success
     * \returns -1 on error
     */
   int setTempSetPt();
   
   /// Set the frame rate. [stdCamera interface]
   /** Sets the frame rate to m_fpsSet.
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int setFPS();
   
   /// Set the synchro state. [stdCamera interface]
   /** Sets the synchro state to m_synchroSet.
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int setSynchro();
 
   /// Required by stdCamera, but this does not do anything for this camera [stdCamera interface]
   /**
     * \returns 0 always
     */ 
   int setExpTime();
   
   /// Required by stdCamera, but this does not do anything for this camera [stdCamera interface]
   /**
     * \returns 0 always
     */
   int setNextROI();
   
   /// Sets the shutter state, via call to dssShutter::setShutterState(int) [stdCamera interface]
   /**
     * \returns 0 always
     */
   int setShutter(int sh);
   
   std::string stateString();
   
   bool stateStringValid();
 
   ///@}
   
   /// Reset the EM Protection 
   /** 
     * \returns 0 on success
     * \returns -1 on error
     */
   int resetEMProtection();
   
   /// Get the current EM Gain.
   /**
     * \returns 0 on success
     * \returns -1 on error
     */
   int getEMGain();
   
   /// Set the EM gain.
   /** Sets it to the value of stdCamera::m_emGainSet
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int setEMGain();
   
   /// Implementation of the framegrabber configureAcquisition interface
   /** Sends the mode command over serial, sets the FPS, and initializes the OCAM SDK.
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int configureAcquisition();
   
   /// Implementation of the frameGrabber fps interface
   /** Just returns the value of m_fps
     */
   float fps();
   
   /// Implementation of the framegrabber startAcquisition interface
   /** Initializes m_lastImageNumber, and calls edtCamera::pdvStartAcquisition
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int startAcquisition();
   
   /// Implementation of the framegrabber acquireAndCheckValid interface
   /** Calls edtCamera::pdvAcquire, then analyzes the OCAM generated framenumber for skips and corruption.
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int acquireAndCheckValid();
   
   /// Implementation of the framegrabber loadImageIntoStream interface
   /** Conducts the OCAM descramble.
     * 
     * \returns 0 on success
     * \returns -1 on error
     */
   int loadImageIntoStream( void * dest  /**< [in] */);
   
   /// Implementation of the framegrabber reconfig interface
   /** Locks the INDI mutex and calls edtCamera::pdvReconfig.
     * \returns 0 on success
     * \returns -1 on error
     */
   int reconfig();
   
   
   //INDI:
protected:
   //declare our properties
   pcf::IndiProperty m_indiP_temps;
   pcf::IndiProperty m_indiP_emProt;
   pcf::IndiProperty m_indiP_emProtReset;
 
   pcf::IndiProperty m_indiP_syncFreq;
 
public:
   INDI_NEWCALLBACK_DECL(ocam2KCtrl, m_indiP_emProtReset);
 
   INDI_SETCALLBACK_DECL(ocam2KCtrl, m_indiP_syncFreq);
 
   /** \name Telemeter Interface
     * 
     * @{
     */ 
   int checkRecordTimes();
   
   int recordTelem( const ocam_temps * );
   
   int recordTelem( const telem_stdcam * );
   
   int recordTelem( const telem_fgtimings * );
 
   int recordTemps(bool force = false);
   
   ///@}
};
 
inline
ocam2KCtrl::ocam2KCtrl() : MagAOXApp(MAGAOX_CURRENT_SHA1, MAGAOX_REPO_MODIFIED)
{
   //--- MagAOXApp Power Mgt. ---
   m_powerMgtEnabled = true;
   m_powerOnWait = 10;
   
   //--- stdCamera ---
   m_startupTemp = 20;
   
   m_maxEMGain = 600;
   
   return;
}
 
inline
ocam2KCtrl::~ocam2KCtrl() noexcept
{
   return;
}
 
inline
void ocam2KCtrl::setupConfig()
{
   dev::stdCamera<ocam2KCtrl>::setupConfig(config);
 
   dev::edtCamera<ocam2KCtrl>::setupConfig(config);
      
   config.add("camera.ocamDescrambleFile", "", "camera.ocamDescrambleFile", argType::Required, "camera", "ocamDescrambleFile", false, "string", "The path of the OCAM descramble file, relative to MagAOX/config.");
   
   dev::frameGrabber<ocam2KCtrl>::setupConfig(config);
   
   dev::dssShutter<ocam2KCtrl>::setupConfig(config);
   
   dev::telemeter<ocam2KCtrl>::setupConfig(config);
}
 
 
inline
void ocam2KCtrl::loadConfig()
{
   dev::stdCamera<ocam2KCtrl>::loadConfig(config);
   dev::edtCamera<ocam2KCtrl>::loadConfig(config);
   
   config(m_ocamDescrambleFile, "camera.ocamDescrambleFile");
   
   if(m_maxEMGain < 1)
   {
      m_maxEMGain = 1;
      log<text_log>("maxEMGain set to 1");
   }
   
   if(m_maxEMGain > 600)
   {
      m_maxEMGain = 600;
      log<text_log>("maxEMGain set to 600");
   }
   
   dev::frameGrabber<ocam2KCtrl>::loadConfig(config);
   dev::dssShutter<ocam2KCtrl>::loadConfig(config);
   dev::telemeter<ocam2KCtrl>::loadConfig(config);
}
 
inline
int ocam2KCtrl::appStartup()
{
   REG_INDI_NEWPROP_NOCB(m_indiP_temps, "temps", pcf::IndiProperty::Number);
   m_indiP_temps.add (pcf::IndiElement("cpu"));
   m_indiP_temps["cpu"].set(0);
   m_indiP_temps.add (pcf::IndiElement("power"));
   m_indiP_temps["power"].set(0);
   m_indiP_temps.add (pcf::IndiElement("bias"));
   m_indiP_temps["bias"].set(0);
   m_indiP_temps.add (pcf::IndiElement("water"));
   m_indiP_temps["water"].set(0);
   m_indiP_temps.add (pcf::IndiElement("left"));
   m_indiP_temps["left"].set(0);
   m_indiP_temps.add (pcf::IndiElement("right"));
   m_indiP_temps["right"].set(0);
   m_indiP_temps.add (pcf::IndiElement("cooling"));
   m_indiP_temps["cooling"].set(0);
 
   REG_INDI_NEWPROP_NOCB(m_indiP_emProt, "emProtection", pcf::IndiProperty::Text);
   m_indiP_emProt.add(pcf::IndiElement("status"));
   m_indiP_emProt["status"].set("UNKNOWN");
   m_indiP_emProt.setState(INDI_IDLE);
   
   createStandardIndiRequestSw( m_indiP_emProtReset, "emProtectionReset", "Reset", "EM Protection"); 
   registerIndiPropertyNew( m_indiP_emProtReset, INDI_NEWCALLBACK(m_indiP_emProtReset));
   
   REG_INDI_SETPROP(m_indiP_syncFreq, m_syncDevice, m_syncFreqProp);
 
   if(dev::stdCamera<ocam2KCtrl>::appStartup() < 0)
   {
      return log<software_critical,-1>({__FILE__,__LINE__});
   }
   
   if(dev::edtCamera<ocam2KCtrl>::appStartup() < 0)
   {
      return log<software_critical,-1>({__FILE__,__LINE__});
   }
   
   if(dev::frameGrabber<ocam2KCtrl>::appStartup() < 0)
   {
      return log<software_critical,-1>({__FILE__,__LINE__});
   }
   
   if(dev::dssShutter<ocam2KCtrl>::appStartup() < 0)
   {
      return log<software_critical,-1>({__FILE__,__LINE__});
   }
   
   m_temps.setInvalid();
   if(dev::telemeter<ocam2KCtrl>::appStartup() < 0)
   {
      return log<software_error,-1>({__FILE__,__LINE__});
   }
   
   return 0;
 
}
 
 
 
inline
int ocam2KCtrl::appLogic()
{
   
   //and run stdCamera's appLogic
   if(dev::stdCamera<ocam2KCtrl>::appLogic() < 0)
   {
      return log<software_error, -1>({__FILE__, __LINE__});
   }
   
   //and run edtCamera's appLogic
   if(dev::edtCamera<ocam2KCtrl>::appLogic() < 0)
   {
      return log<software_error, -1>({__FILE__, __LINE__});
   }
   
   //first run frameGrabber's appLogic to see if the f.g. thread has exited.
   if(dev::frameGrabber<ocam2KCtrl>::appLogic() < 0)
   {
      return log<software_error, -1>({__FILE__, __LINE__});
   }
   
   //and run dssShutter's appLogic
   if(dev::dssShutter<ocam2KCtrl>::appLogic() < 0)
   {
      return log<software_error, -1>({__FILE__, __LINE__});
   }
 
   if( state() == stateCodes::POWERON) return 0;
   
   if( state() == stateCodes::NOTCONNECTED || state() == stateCodes::ERROR)
   {
      m_temps.setInvalid();
      
      std::string response;
 
      //Might have gotten here because of a power off.
      if(MagAOXAppT::m_powerState == 0) return 0;
      
      int ret = pdvSerialWriteRead( response, "fps"); //m_pdv, "fps", m_readTimeout);
      if( ret == 0)
      {
         state(stateCodes::CONNECTED);
      }
      else
      {
         sleep(1);
         return 0;
      }
   }
 
   if( state() == stateCodes::CONNECTED )
   {
      //Get a lock
      std::unique_lock<std::mutex> lock(m_indiMutex);
      
      if( getFPS() == 0 )
      {
         if(m_fpsSet == 0) state(stateCodes::READY);
         else state(stateCodes::OPERATING);
         
         if(m_poweredOn && m_ccdTempSetpt > -999)
         {
            m_poweredOn = false;
            if(setTempSetPt() < 0)
            {
               if(powerState() != 1 || powerStateTarget() != 1) return 0;
               return log<software_error,0>({__FILE__,__LINE__});
            }
         }
 
         //We always have to set synchro on connecting, b/c otherwise we don't know the state.
         m_synchroSet = false;
         if( setSynchro() != 0 )
         {
            log<software_error>({__FILE__, __LINE__, "error from setSynchro on CONNECT"});
         }
      }
      else
      {
         if(powerState() != 1 || powerStateTarget() != 1) return 0;
         state(stateCodes::ERROR);
         return log<software_error,0>({__FILE__,__LINE__});
      }
   }
 
   if( state() == stateCodes::READY || state() == stateCodes::OPERATING )
   {
      //Get a lock if we can
      std::unique_lock<std::mutex> lock(m_indiMutex, std::try_to_lock);
 
      //but don't wait for it, just go back around.
      if(!lock.owns_lock()) return 0;
      
      if(getTemps() < 0)
      {
         if(powerState() != 1 || powerStateTarget() != 1) return 0;
         m_temps.setInvalid();
         state(stateCodes::ERROR);
         return 0;
      }
 
      if(getFPS() < 0)
      {
         if(powerState() != 1 || powerStateTarget() != 1) return 0;
         
         state(stateCodes::ERROR);
         return 0;
      }
      
      if(m_protectionResetConfirmed > 0 )
      {
         if( mx::sys::get_curr_time() - m_protectionResetReqTime > 10.0)
         {
            m_protectionResetConfirmed = 0;
            updateIfChanged(m_indiP_emProt, "status", std::string("UNCONFIRMED"));
            log<text_log>("protection reset request not confirmed", logPrio::LOG_NOTICE);
         }
      }
      
      if(getEMGain () < 0)
      {
         if(MagAOXAppT::m_powerState == 0) return 0;
         
         state(stateCodes::ERROR);
         return 0;
      }
      
      if(frameGrabber<ocam2KCtrl>::updateINDI() < 0)
      {
         log<software_error>({__FILE__, __LINE__});
         state(stateCodes::ERROR);
         return 0;
      }
      
      if(stdCamera<ocam2KCtrl>::updateINDI() < 0)
      {
         log<software_error>({__FILE__, __LINE__});
         state(stateCodes::ERROR);
         return 0;
      }
      
      if(edtCamera<ocam2KCtrl>::updateINDI() < 0)
      {
         log<software_error>({__FILE__, __LINE__});
         state(stateCodes::ERROR);
         return 0;
      }
      
      if(telemeter<ocam2KCtrl>::appLogic() < 0)
      {
         log<software_error>({__FILE__, __LINE__});
         return 0;
      }
      
   }
 
   ///\todo Fall through check?
 
   return 0;
 
}
 
inline
int ocam2KCtrl::onPowerOff()
{
   m_powerOnCounter = 0;
   
   std::lock_guard<std::mutex> lock(m_indiMutex);
   
   updateIfChanged(m_indiP_emProt, "status", std::string("UNKNOWN"), INDI_IDLE);
   
   m_temps.setInvalid();
   
   updateIfChanged(m_indiP_temps, "cpu", m_temps.CPU);
   updateIfChanged(m_indiP_temps, "power", m_temps.POWER);
   updateIfChanged(m_indiP_temps, "bias", m_temps.BIAS);
   updateIfChanged(m_indiP_temps, "water", m_temps.WATER);
   updateIfChanged(m_indiP_temps, "left", m_temps.LEFT);
   updateIfChanged(m_indiP_temps, "right", m_temps.RIGHT);
   updateIfChanged(m_indiP_temps, "cooling", m_temps.COOLING_POWER);
      
   if(stdCamera<ocam2KCtrl>::onPowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   if(edtCamera<ocam2KCtrl>::onPowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   if(frameGrabber<ocam2KCtrl>::onPowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   if(dssShutter<ocam2KCtrl>::onPowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   //Setting m_poweredOn
   m_poweredOn = true;
 
   
   return 0;
}
 
inline
int ocam2KCtrl::whilePowerOff()
{
   std::lock_guard<std::mutex> lock(m_indiMutex);
   
   if(stdCamera<ocam2KCtrl>::whilePowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   if(edtCamera<ocam2KCtrl>::whilePowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   if(dssShutter<ocam2KCtrl>::whilePowerOff() < 0)
   {
      log<software_error>({__FILE__, __LINE__});
   }
   
   return 0;
}
 
inline
int ocam2KCtrl::appShutdown()
{
   ///\todo error check these base class fxns.
   
   dev::stdCamera<ocam2KCtrl>::appShutdown();
   
   dev::edtCamera<ocam2KCtrl>::appShutdown();
   
   dev::frameGrabber<ocam2KCtrl>::appShutdown();
   
   dev::dssShutter<ocam2KCtrl>::appShutdown();
   
   dev::telemeter<ocam2KCtrl>::appShutdown();
   
   return 0;
}
 
 
inline
int ocam2KCtrl::getTemps()
{
   std::string response;
 
   if( pdvSerialWriteRead( response, "temp") == 0)
   {
      ocamTemps temps;
 
      if(parseTemps( temps, response ) < 0) 
      {
         if(powerState() != 1 || powerStateTarget() != 1) return -1;
 
         m_temps.setInvalid();
         m_ccdTemp = m_temps.CCD;
         m_ccdTempSetpt = m_temps.SET;
         m_tempControlStatus = false;
         m_tempControlStatusStr = "UNKNOWN";
         
         recordTemps();
         recordCamera();
 
         std::cerr << "Temp. parse error. Response:\n" << response << std::endl;
 
         //We don't trust the temps, but don't reconfig just for this.
         return log<software_error, 0>({__FILE__, __LINE__, "Temp. parse error"});
      }
      
      m_temps = temps;
 
      //stdCamera temp control:
      m_ccdTemp = m_temps.CCD;
      m_ccdTempSetpt = m_temps.SET;
      
      //Detect that temperature control is off
      if(m_temps.COOLING_POWER < 5)
      {
         if( m_temps.CCD - m_temps.SET > 2.99 )
         {
            m_tempControlStatus = false;
         }
      }
      else m_tempControlStatus = true;
      
      if(m_tempControlStatus == true)
      {
         if(fabs(m_temps.CCD - m_temps.SET) < 1.0)
         {
            m_tempControlStatusStr = "ON TARGET";
            m_tempControlOnTarget = true;
         }
         else
         {
            m_tempControlStatusStr = "OFF TARGET";
            m_tempControlOnTarget = false;
         }
      }
      else
      {
         m_tempControlStatusStr = "TEMP OFF";
         m_tempControlOnTarget = false;
      }
      
      
      //Telemeter:
      recordTemps();
      recordCamera();
      
      updateIfChanged(m_indiP_temps, "cpu", m_temps.CPU);
      updateIfChanged(m_indiP_temps, "power", m_temps.POWER);
      updateIfChanged(m_indiP_temps, "bias", m_temps.BIAS);
      updateIfChanged(m_indiP_temps, "water", m_temps.WATER);
      updateIfChanged(m_indiP_temps, "left", m_temps.LEFT);
      updateIfChanged(m_indiP_temps, "right", m_temps.RIGHT);
      updateIfChanged(m_indiP_temps, "cooling", m_temps.COOLING_POWER);
      return 0;
 
   }
   else 
   {
      if(powerState() != 1 || powerStateTarget() != 1) return -1;
      return log<software_error,-1>({__FILE__, __LINE__});
   }
}
 
inline
int ocam2KCtrl::powerOnDefaults()
{
   //Camera boots up with this true in most cases.
   m_tempControlStatusSet = false;
   m_tempControlStatus =false;
      
   return 0;
}
 
inline
int ocam2KCtrl::setTempControl()
{
   std::string response;
 
   std::string command;
   
   std::string comStr = "temp ";
   if(m_tempControlStatusSet)
   {
      command = "on";
      m_tempControlStatusSet = true;
      m_tempControlStatus = true;
   }
   else
   {
      if( m_ccdTemp > 19) //19 is 20 with a 1 C slop
      {
         command = "off";
         m_tempControlStatusSet = false;
         m_tempControlStatus = false;
      }
      else
      {
         return log<text_log,-1>("Can not turn temp control off when not at 20 C or higher", logPrio::LOG_ERROR);
      }
   }
    
   comStr += command;
   
   if( pdvSerialWriteRead( response, comStr) == 0)
   {
      std::cerr << "response: " << response << "\n";
      ///\todo check response
      log<text_log,0>({"Set temperature control to " + command});
   }
   else 
   {
      if(powerState() != 1 || powerStateTarget() != 1) return -1;
      return log<software_error,-1>({__FILE__, __LINE__});
   }
 
   if( m_tempControlStatusSet && m_ccdTempSetpt > -999)
   {
      return setTempSetPt();
   }
   
   recordCamera();
   
   return 0;
}
 
inline
int ocam2KCtrl::setTempSetPt()
{
   std::string response;
 
   std::string tempStr = std::to_string( m_ccdTempSetpt );
   
   ///\todo make more configurable
   if(m_ccdTempSetpt >= 30 || m_ccdTempSetpt < -50) 
   {
      return log<text_log,-1>({"attempt to set temperature outside valid range: " + tempStr}, logPrio::LOG_ERROR);
   }
   
   if( pdvSerialWriteRead( response, "temp " + tempStr) == 0)
   {
      std::cerr << "response: " << response << "\n";
      
      recordCamera();
      
      ///\todo check response
      std::cerr << "temp " <<  tempStr << " response: " << response << "\n";
 
      return log<text_log,0>({"set temperature: " + tempStr});
   }
   else 
   {
      if(powerState() != 1 || powerStateTarget() != 1) return -1;
      return log<software_error,-1>({__FILE__, __LINE__});
   }
 
}
 
inline
int ocam2KCtrl::getFPS()
{
    if(!m_synchro)
    {
        std::string response;
 
        if( pdvSerialWriteRead( response, "fps") == 0) // m_pdv, "fps", m_readTimeout) == 0)
        {
            float fps;
            if(parseFPS( fps, response ) < 0) 
            {
                if(powerState() != 1 || powerStateTarget() != 1) return -1;
 
                std::cerr << "fps parse error. Response:\n" << response << "\n";
 
                return log<software_error, 0>({__FILE__, __LINE__, "fps parse error"});
            }
            m_fps = fps;
 
            recordCamera();
      
            return 0;
 
        }
        else 
        {
            return log<software_error,-1>({__FILE__, __LINE__});
        }
    }
    else 
    {
        m_fps = m_syncFreq;
        recordCamera();
 
        return 0;
    }
}
 
inline
int ocam2KCtrl::setFPS()
{
    std::string fpsStr= std::to_string(m_fpsSet);
 
    if(!m_synchro)
    {
        std::string response;
    
        if( pdvSerialWriteRead( response, "fps " + fpsStr ) == 0)
        {
            ///\todo check response
            std::cerr << "fps " << fpsStr << " response: " << response << "\n";
            log<text_log>({"set fps: " + fpsStr});
      
            //We always want to reset the latency circular buffers
            ///\todo verify that this works!! 
            m_nextMode = m_modeName;
            m_reconfig = true;
 
        }
        else 
        {
            if(powerState() != 1 || powerStateTarget() != 1) return -1;
            return log<software_error,-1>({__FILE__, __LINE__});
        }
    }
    else 
    {
        std::cerr << "setting: " << fpsStr << "\n";
 
        pcf::IndiProperty ipFreq(pcf::IndiProperty::Number);
   
        ipFreq.setDevice(m_syncDevice);
        ipFreq.setName(m_syncFreqProp);
        ipFreq.add(pcf::IndiElement("target"));
   
        ipFreq["target"] = fpsStr;
   
        sendNewProperty(ipFreq);
    }
 
    
      
    return 0;
}
 
inline
int ocam2KCtrl::setSynchro()
{
    std::string response;
   
    //First set the actual FPS to 0 to get to max
    std::string fpsStr= std::to_string(0);
    if( pdvSerialWriteRead( response, "fps " + fpsStr ) == 0)
    {
        ///\todo check response
        std::cerr << "fps " << fpsStr << " response: " << response << "\n";
        log<text_log>({"set fps: " + fpsStr});      
    }
    else 
    {
        if(powerState() != 1 || powerStateTarget() != 1) return -1;
        return log<software_error,-1>({__FILE__, __LINE__});
    }
 
    //Now actually turn synchro on
    std::string sStr;
    if(m_synchroSet) sStr = "on";
    else sStr = "off";
    if( pdvSerialWriteRead( response, "synchro " + sStr ) == 0)
    {
        ///\todo check response
        std::cerr << "synchro " << sStr << " resonse: " << response << "\n";
        log<text_log>({"set synchro: " + sStr});
      
        m_synchro = m_synchroSet;
 
        if(m_synchro == false) 
        {
            updateSwitchIfChanged(m_indiP_synchro, "toggle", pcf::IndiElement::Off, INDI_IDLE);
        }
        else
        {
            updateSwitchIfChanged(m_indiP_synchro, "toggle", pcf::IndiElement::On, INDI_OK);
        }
    }
    else 
    {
        if(powerState() != 1 || powerStateTarget() != 1) return -1;
        return log<software_error,-1>({__FILE__, __LINE__});
    }
 
    //Finally we set the FPS of the synchro device
    return setFPS();
}
 
inline 
int ocam2KCtrl::setExpTime()
{
   return 0;
}
   
inline 
int ocam2KCtrl::setNextROI()
{
   return 0;
}
 
inline 
int ocam2KCtrl::setShutter(int sh)
{
   return dssShutter<ocam2KCtrl>::setShutterState(sh);
}
 
inline
std::string ocam2KCtrl::stateString()
{
   std::string ss;
 
   ss += m_modeName + "_";
   ss += std::to_string(m_fps) + "_";
   ss += std::to_string(m_emGain) + "_";
   ss += std::to_string(m_ccdTempSetpt);
 
   return ss;
}
 
inline
bool ocam2KCtrl::stateStringValid()
{
   if(state() == stateCodes::OPERATING && m_tempControlOnTarget)
   {
      return true;
   }
   else return false;
}
 
inline 
int ocam2KCtrl::resetEMProtection()
{
   std::string response;
   
   if( pdvSerialWriteRead( response, "protection reset") == 0)
   {
      std::cerr << "\n******************************************\n";
      std::cerr << "protection reset:\n";
      std::cerr << response << "\n";
      std::cerr << "\n******************************************\n";
      ///\todo check response.
      
      updateIfChanged(m_indiP_emProt, "status", std::string("RESET"), INDI_OK);
      
      log<text_log>("overillumination protection has been reset", logPrio::LOG_NOTICE);
      
      m_protectionResetConfirmed = 0;
      
      m_protectionReset = true;
         
      return 0;
 
   }
   else 
   {
      if(powerState() != 1 || powerStateTarget() != 1) return -1;
      return log<software_error,-1>({__FILE__, __LINE__});
   }
}
 
inline
int ocam2KCtrl::getEMGain()
{
   std::string response;
 
   if( pdvSerialWriteRead( response, "gain") == 0)
   {
      unsigned emGain;
      if(parseEMGain( emGain, response ) < 0) 
      {
         if(powerState() != 1 || powerStateTarget() != 1) return -1;
         
         if(response.find("HV") != std::string::npos)
         {
            m_emGain = 1;
            updateIfChanged(m_indiP_emProt, "status", std::string("TRIPPED"), INDI_ALERT);
            return log<software_warning, -1>({__FILE__, __LINE__, "EM Gain tripped!"});
 
         }
 
         std::cerr << "EM Gain parse error, response:\n" << response << "\n";
 
         return log<software_error, -1>({__FILE__, __LINE__, "EM Gain parse error"});
      }
 
      m_emGain = emGain;
 
      return 0;
 
   }
   else 
   {
      if(powerState() != 1 || powerStateTarget() != 1) return -1;
      return log<software_error,-1>({__FILE__, __LINE__});
   }
}
   
inline
int ocam2KCtrl::setEMGain( )
{
   std::string response;
 
   if(m_protectionReset == false)
   {
      log<text_log>("Attempt to set EM gain before protection reset", logPrio::LOG_NOTICE);
 
      if(m_emGainSet > 1) //we allow setting to 1 for safety
      {
         return 0;
      }
   }
   
   unsigned emg  = m_emGainSet; //a float
   
   if(emg < 1 || emg > m_maxEMGain)
   {
      log<text_log>("Attempt to set EM gain to " + std::to_string(emg) + " outside limits refused", logPrio::LOG_WARNING);
      return 0;
   }
   
   std::string emgStr= std::to_string(emg);
   if( pdvSerialWriteRead( response, "gain " + emgStr ) == 0) //m_pdv, "gain " + emgStr, m_readTimeout) == 0)
   {
      ///\todo check response
      std::cerr << "gain " << emgStr << " response: " << emgStr << "\n";
 
      log<text_log>({"set EM Gain: " + emgStr});
      
      return 0;
   }
   else 
   {
      if(powerState() != 1 || powerStateTarget() != 1) return -1;
      return log<software_error,-1>({__FILE__, __LINE__});
   }
   
}
 
inline
int ocam2KCtrl::configureAcquisition()
{
    //lock mutex
    std::unique_lock<std::mutex> lock(m_indiMutex);
    
    //Send command to camera to place it in the correct mode
    std::string response;
    if( pdvSerialWriteRead( response, m_cameraModes[m_modeName].m_serialCommand) != 0) //m_pdv, m_cameraModes[m_modeName].m_serialCommand, m_readTimeout) != 0)
    {
        if(powerState() != 1 || powerStateTarget() != 1) return -1;
  
        log<software_error>({__FILE__, __LINE__, "Error sending command to set mode"});
        sleep(1);
        return -1;
    }
    
    m_currentROI.x = 119.5;
    m_currentROI.y = 119.5;
    m_currentROI.w = 240;
    m_currentROI.h = 240;
    m_currentROI.bin_x = m_cameraModes[m_modeName].m_binningX;
    m_currentROI.bin_y = m_cameraModes[m_modeName].m_binningY;
    
    m_digitalBinX = m_cameraModes[m_modeName].m_digitalBinX;
    m_digitalBinY = m_cameraModes[m_modeName].m_digitalBinY;
    
    if(m_digitalBinX > 1)
    {
        m_digitalBin = true;
        std::cerr << "digital binning!\n";
    }
    else
    {
        m_digitalBin = false;
    }
 
    recordCamera();
    
     ///\todo check response of pdvSerialWriteRead
    log<text_log>("camera configured with: " +m_cameraModes[m_modeName].m_serialCommand);
    
    if(m_fpsSet > 0) setFPS();
    
    log<text_log>("Send command to set mode: " + m_cameraModes[m_modeName].m_serialCommand);
    log<text_log>("Response was: " + response);
   
    if(setSynchro() < 0)
    { 
        log<software_error>({__FILE__, __LINE__, "Error setting synchro during configureAcquisition"});
    }
 
    /* Initialize the OCAM2 SDK
        */
 
    if(m_ocam2_id > 0)
    {
        ocam2_exit(m_ocam2_id);
    }
    ocam2_rc rc;
    ocam2_mode mode;
 
    int OCAM_SZw;
    int OCAM_SZh;
    if(m_raw_height == 121)
    {
        mode = OCAM2_NORMAL;
        OCAM_SZw = 240;
        OCAM_SZh = 240;
    }
    else if (m_raw_height == 62)
    {
        mode = OCAM2_BINNING;
        OCAM_SZw = 120;
        OCAM_SZh = 120;
    }
    else if (m_raw_height == 41)
    {
        mode = OCAM2_BINNING1x3;
        OCAM_SZw = 240;
        OCAM_SZh = 80;
    }
    else if (m_raw_height == 31)
    {
        mode = OCAM2_BINNING1x4;
        OCAM_SZw = 240;
        OCAM_SZh = 60;
    }
    else
    {
        log<text_log>("Unrecognized OCAM2 mode.", logPrio::LOG_ERROR);
        return -1;
    }
 
    std::string ocamDescrambleFile = m_configDir + "/" + m_ocamDescrambleFile;
 
    std::cerr << "ocamDescrambleFile: " << ocamDescrambleFile << std::endl;
    
    rc=ocam2_init(mode, ocamDescrambleFile.c_str(), &m_ocam2_id);
    
    if (rc != OCAM2_OK)
    {
        if(powerState() != 1 || powerStateTarget() != 1) return -1;
        log<text_log>("ocam2_init error. Failed to initialize OCAM SDK with descramble file: " + ocamDescrambleFile, logPrio::LOG_ERROR);
        return -1;
    }
    
 
    log<text_log>("OCAM2K initialized. id: " + std::to_string(m_ocam2_id));
 
    log<text_log>(std::string("OCAM2K mode is:") + ocam2_modeStr(ocam2_getMode(m_ocam2_id)));
    
    
    
    
    if(m_digitalBin)
    {
        std::cerr << "and digital binning!\n";
        m_digitalBinWork.resize(OCAM_SZw, OCAM_SZh);
 
        m_width = OCAM_SZw / m_digitalBinX;
        m_height = OCAM_SZh / m_digitalBinY;
    }
    else
    {
        m_width = OCAM_SZw;
        m_height = OCAM_SZh;
    }
 
    m_dataType = _DATATYPE_UINT16;
 
    state(stateCodes::OPERATING);
    
    return 0;
}
 
inline
float ocam2KCtrl::fps()
{
   return m_fps;
}
 
inline
int ocam2KCtrl::startAcquisition()
{
   m_lastImageNumber = -1;
   return edtCamera<ocam2KCtrl>::pdvStartAcquisition();
   
}
 
inline
int ocam2KCtrl::acquireAndCheckValid()
{
   edtCamera<ocam2KCtrl>::pdvAcquire( m_currImageTimestamp );
   
   /* Removed all pdv timeout and overrun checking, since we can rely on frame number from the camera
      to detect missed and corrupted frames.
   
      See ef0dd24 for last version with full checks in it.
   */
  
   //Get the image number to see if this is valid.
   //This is how it is in the ocam2_sdk:
   unsigned currImageNumber = (reinterpret_cast<int *>(m_image_p))[OCAM2_IMAGE_NB_OFFSET/4]; /* int offset */
   m_currImageNumber = currImageNumber;
   
   //For the first loop after a restart
   if( m_lastImageNumber == -1 ) 
   {
      m_lastImageNumber = m_currImageNumber - 1;
   }
      
   if(m_currImageNumber - m_lastImageNumber != 1)
   {
      //Detect exact condition of a wraparound on the unsigned int.
      // Yes, this can only happen once every 13.72 days at 3622 fps 
      // But just in case . . .
      if(m_lastImageNumber != std::numeric_limits<unsigned int>::max() && m_currImageNumber != 0)
      {
         //The far more likely case is a problem...
   
         //If a reasonably small number of frames skipped, then we trust the image number
         if(m_currImageNumber - m_lastImageNumber > 1 && m_currImageNumber - m_lastImageNumber < 100)
         { 
            //This we handle as a non-timeout -- report how many frames were skipped
            long framesSkipped = m_currImageNumber - m_lastImageNumber - 1;
            
            log<text_log>("frames skipped: " + std::to_string(framesSkipped), logPrio::LOG_ERROR);
            
            m_lastImageNumber = -1;
            m_nextMode = m_modeName;
            m_reconfig = 1;
            return 1;
            
         }
         else //but if it's any bigger or < 0, it's probably garbage
         {
            if(powerState() != 1 || powerStateTarget() != 1) return -1;
 
            ///\todo need frame corrupt log type
            log<text_log>("frame number possibly corrupt: " + std::to_string(m_currImageNumber) + " - " + std::to_string(m_lastImageNumber), logPrio::LOG_ERROR);
            
            m_nextMode = m_modeName;
            m_reconfig = 1;
      
            //Reset the counters.
            m_lastImageNumber = -1;
            return 1;
         
         }
      }
   }
   m_lastImageNumber = m_currImageNumber;
   return 0;
}
 
inline
int ocam2KCtrl::loadImageIntoStream(void * dest)
{
    unsigned currImageNumber = 0;
 
    if(!m_digitalBin)
    {
        ocam2_descramble(m_ocam2_id, &currImageNumber, reinterpret_cast<int16_t *>(dest), reinterpret_cast<int16_t *>(m_image_p));
        //memcpy(dest, m_image_p, 120*120*2); //This is about 10 usec faster -- but we have to descramble.
    }
    else
    {
        ocam2_descramble(m_ocam2_id, &currImageNumber, m_digitalBinWork.data(), reinterpret_cast<int16_t *>(m_image_p));
 
        mx::improc::eigenMap<int16_t> destMap( reinterpret_cast<int16_t*>(dest), m_width, m_height);
 
        if(m_digitalBinX > 1)
        {
            for(int cc = 0; cc < destMap.cols(); ++cc)
            {
                for(int rr = 0; rr < destMap.rows(); ++rr)
                {
                    destMap(rr,cc)  = m_digitalBinWork(rr*m_digitalBinX + 0, cc);
                    
                    for(unsigned b = 1; b < m_digitalBinX; ++b)
                    {
                        destMap(rr,cc)  = m_digitalBinWork(rr*m_digitalBinX + b,cc);
                    }
                }
            }
        }
    }
 
   
   return 0;
}
   
inline
int ocam2KCtrl::reconfig()
{
   //lock mutex
   std::unique_lock<std::mutex> lock(m_indiMutex);
   
   int rv = edtCamera<ocam2KCtrl>::pdvReconfig();
   if(rv < 0) return rv;
   state(stateCodes::READY);
   return 0;
}
   
INDI_NEWCALLBACK_DEFN(ocam2KCtrl, m_indiP_emProtReset)(const pcf::IndiProperty &ipRecv)
{
   if(MagAOXAppT::m_powerState == 0) return 0;
   
   if (ipRecv.getName() != m_indiP_emProtReset.getName())
   {
      log<software_error>({__FILE__,__LINE__, "wrong INDI property received."});
      return -1;
   }
   
   if(!ipRecv.find("request")) 
   {
      return 0;
   }
   
   if( ipRecv["request"].getSwitchState() == pcf::IndiElement::Off )
   {
      return 0;
   }
 
   std::unique_lock<std::mutex> lock(m_indiMutex);
 
   if(m_protectionResetConfirmed == 0)
   {
      updateIfChanged(m_indiP_emProt, "status", std::string("CONFIRM"), INDI_BUSY);
       
      m_protectionResetConfirmed = 1;
         
      m_protectionResetReqTime = mx::sys::get_curr_time();
         
      log<text_log>("protection reset requested", logPrio::LOG_NOTICE);
        
      return 0;
   }
      
 
   //If here, this is a confirmation.      
   return resetEMProtection();
}
 
INDI_SETCALLBACK_DEFN(ocam2KCtrl, m_indiP_syncFreq)(const pcf::IndiProperty &ipRecv)
{
    INDI_VALIDATE_CALLBACK_PROPS(ipRecv, m_indiP_syncFreq)
 
    if(!ipRecv.find("current")) 
    {   
        return -1;
    }
 
    m_syncFreq = ipRecv["current"].get<double>();
 
    if(m_synchro && m_syncFreq != m_fps)
    {
        recordCamera(true);
        m_fps = m_syncFreq;
        
        //We always want to reset the latency circular buffers
        m_nextMode = m_modeName;
        m_reconfig = true;
    }
 
    return 0;
}
 
inline
int ocam2KCtrl::checkRecordTimes()
{
   return telemeter<ocam2KCtrl>::checkRecordTimes(ocam_temps(), telem_stdcam(), telem_fgtimings());
}
   
inline
int ocam2KCtrl::recordTelem( const ocam_temps * )
{
   return recordTemps(true);
}
 
inline
int ocam2KCtrl::recordTelem( const telem_stdcam * )
{
   return recordCamera(true);
}
 
inline
int ocam2KCtrl::recordTelem( const telem_fgtimings * )
{
   return recordFGTimings(true);
}
 
inline
int ocam2KCtrl::recordTemps( bool force )
{
   static ocamTemps lastTemps;
   
   if(!(lastTemps == m_temps) || force)
   {
      telem<ocam_temps>({m_temps.CCD, m_temps.CPU, m_temps.POWER, m_temps.BIAS, m_temps.WATER, m_temps.LEFT, m_temps.RIGHT, m_temps.COOLING_POWER});
      lastTemps = m_temps;
   }
   
   return 0;
} 
   
}//namespace app
} //namespace MagAOX
 
#endif