qcryostreamdevice.cpp

Go to the documentation of this file.

#include "qcryostreamdevice.h"
#include "qpidcontroller.h"
#include "qpidcommport.h"

typedef struct {
    unsigned char    Length;              /* Length of this packet, = 32 (bytes) */
    unsigned char    Type;                /* Status Packet ID = 1 for standard packet */
    unsigned short   GasSetPoint;         /* Set Temp 100*K */
    unsigned short   GasTemp;             /* Gas Temp 100*K */
    signed short     GasError;            /* Error 100*K */
    unsigned char    RunMode;             /* The current run mode */
    unsigned char    PhaseId;             /* The id of the current phase - see below */
    unsigned short   RampRate;            /* The ramp rate of the current phase */
    unsigned short   TargetTemp;          /* The target temperature of the current phase */
    unsigned short   EvapTemp;            /* Evap temp, 100*K */
    unsigned short   SuctTemp;            /* Suct temp, 100*K */
    unsigned short   Remaining;           /* Time remaining in phase */
    unsigned char    GasFlow;             /* Gas flow, 10*l/min */
    unsigned char    GasHeat;             /* Gas heater, % */
    unsigned char    EvapHeat;            /* Evap heater, % */
    unsigned char    SuctHeat;            /* Suct heater, % */
    unsigned char    LinePressure;        /* Back pressure, 100*bar */
    unsigned char    AlarmCode;           /* Indicates most serious alarm condition */
    unsigned short   RunTime;             /* Time in minutes pump has been up */
    unsigned short   ControllerNumber;    /* Controller number, from ROM */
    unsigned char    SoftwareVersion;     /* Software version */
    unsigned char    EvapAdjust;          /* EvapAdjust vacuum compensation */
} CryostreamStatus;

typedef struct {
    unsigned char    Length;              /* Length of this packet, = 42 (bytes) */
    unsigned char    Type;                /* Status Packet ID = 2 for extended packet */
    unsigned short   GasSetPoint;         /* Set Temp 100*K */
    unsigned short   GasTemp;             /* Gas Temp 100*K */
    signed short     GasError;            /* Error 100*K */
    unsigned char    RunMode;             /* The current run mode */
    unsigned char    PhaseId;             /* The id of the current phase - see below */
    unsigned short   RampRate;            /* The ramp rate of the current phase */
    unsigned short   TargetTemp;          /* The target temperature of the current phase */
    unsigned short   EvapTemp;            /* Evap temp, 100*K */
    unsigned short   SuctTemp;            /* Suct temp, 100*K */
    unsigned short   Remaining;           /* Time remaining in phase */
    unsigned char    GasFlow;             /* Gas flow, 10*l/min */
    unsigned char    GasHeat;             /* Gas heater, % */
    unsigned char    EvapHeat;            /* Evap heater, % */
    unsigned char    SuctHeat;            /* Suct heater, % */
    unsigned char    LinePressure;        /* Back pressure, 100*bar */
    unsigned char    AlarmCode;           /* Indicates most serious alarm condition */
    unsigned short   RunTime;             /* Time in minutes pump has been up */
    unsigned short   ControllerNumber;    /* Controller number, from ROM */
    unsigned char    SoftwareVersion;     /* Software version */
    unsigned char    EvapAdjust;          /* EvapAdjust vacuum compensation */
    unsigned char    TurboMode;           /* In Turbo mode ? */
    unsigned char    HardwareType;        /* Cryostream or Cryostream Plus, with/without Shutter */
    unsigned char    ShutterState;        /* Shutter status */
    unsigned char    ShutterTime;         /* Shutter time remaining */
    unsigned char    UnusedOne;           /* For expansion */
    unsigned char    UnusedTwo;           /* For expansion */
    unsigned short   UnusedThree;         /* For expansion */
    unsigned short   UnusedFour;          /* For expansion */
} ExtendedCryostreamStatus;

typedef struct {
    unsigned char  Length;               /* Length of this packet, = 44 (bytes)*/
    unsigned char  Type;                 /* Packet ID, = 150 for Cobra status packets */
    unsigned short GasSetPoint;          /* Set Temp 100*K */
    unsigned short GasTemp;              /* Gas Temp 100*K */
    signed short   GasError;             /* Error 100*K */
    unsigned char  RunMode;              /* The current run mode */
    unsigned char  PhaseId;              /* The id of the current phase - see below */
    unsigned short RampRate;             /* The ramp rate of the current phase */
    unsigned short TargetTemp;           /* The target temperature of the current phase */
    unsigned short RefrTemp;             /* Refrigerator temp, 100*K */
    unsigned short VacuumGauge;          /* Vacuum gauge reading */
    unsigned short Remaining;            /* Time remaining in phase */
    unsigned char  GasFlow;              /* Gas flow, 10*l/min */
    unsigned char  GasHeat;              /* Gas heater, % */
    unsigned char  RefrHeat;             /* Refrigerator heater, % */
    unsigned char  UnusedZero;           /* NOT USED */
    unsigned char  LinePressure;         /* Back pressure, 100*bar */
    unsigned char  AlarmCode;            /* Indicates most serious alarm condition */
    unsigned short RunTime;              /* Time in minutes pump has been up */
    unsigned short ControllerNumber;     /* Controller number, from ROM */
    unsigned char  SoftwareVersion;      /* Software version */
    unsigned char  CryoStatus;           /* Cryodrive status */
    unsigned char  CryoAdjust;           /* Cryodrive speed boost */
    unsigned char  CryoSpeed;            /* Cryodrive speed */
    unsigned char  TurboMode;            /* In Turbo mode ? */
    unsigned char  HardwareType;         /* With/without CryoShutter */
    unsigned char  ShutterState;         /* CryoShutter status */
    unsigned char  ShutterTime;          /* CryoShutter time remaining */
    unsigned char  UnusedOne;            /* For expansion */
    unsigned char  UnusedTwo;            /* For expansion */
    unsigned short UnusedThree;          /* For expansion */
   unsigned short  UnusedFour;           /* For expansion */
} CobraStatus;

typedef struct {
    unsigned char    Length;              /* Length of this packet = 32 (bytes) */
    unsigned char    Type;                /* Status Packet ID = 100 */
    unsigned short   SampleSetPoint;      /* Set Temp 100*K */
    unsigned short   SampleTemp;          /* Sample Temp 100*K */
    signed short     SampleError;         /* Error 100*K */
    unsigned char    RunMode;             /* The current run mode */
    unsigned char    PhaseId;             /* The id of the current phase - see below */
    unsigned short   RampRate;            /* The ramp rate of the current phase */
    unsigned short   TargetTemp;          /* The target temperature of the current phase */
    unsigned short   ShieldTemp;          /* Shield temp, 100*K */
    unsigned short   Unused1;             /* Unused in PheniX */
    unsigned short   Remaining;           /* Time remaining in phase */
    unsigned char    CryoSpeed;           /* Cryodrive speed */
    unsigned char    SampleHeat;          /* Sample stage heater, % */
    unsigned char    ShieldHeat;          /* Shield heater, % */
    unsigned char    Unused2;             /* Unused in PheniX */
    unsigned char    CryoStatus;          /* Cryodrive status */
    unsigned char    AlarmCode;           /* Indicates most serious alarm condition */
    unsigned short   RunTime;             /* Time in minutes pump has been up */
    unsigned short   ControllerNumber;    /* Controller number, from ROM */
    unsigned char    SoftwareVersion;     /* Software version */
    unsigned char    CryoAdjust;          /* Cryodrive speed adjustment */
} PhenixStatus;

typedef struct {
    unsigned char  Length;             /* Length of this packet, = 46 (bytes)*/
    unsigned char  Type;               /* Packet ID, = 200 for HeliX status packets */
    unsigned short GasSetPoint;        /* Gas set point Temp 100*K */
    unsigned short GasTemp;            /* Gas temp 100*K */
    signed short   GasError;           /* Gas error 100*K */
    unsigned char  RunMode;            /* The current run mode */
    unsigned char  PhaseId;            /* The id of the current phase - see below */
    unsigned short RampRate;           /* The ramp rate of the current phase */
    unsigned short TargetTemp;         /* The target temperature of the current phase */
    unsigned short ShieldTemp;         /* Shield temp, 100*K */
    unsigned short NozzleTemp;         /* Nozzle temperature, 100*K */
    unsigned short Remaining;          /* Time remaining in phase */
    unsigned char  CryoSpeed;          /* Cryodrive speed */
    unsigned char  GasHeat;            /* Sample stage heater, % */
    unsigned char  ShieldHeat;         /* Shield heater, % */
    unsigned char  NozzleHeat;         /* Nozzle heater, % */
    unsigned char  CryoStatus;         /* Cryodrive status */
    unsigned char  AlarmCode;          /* Indicates most serious alarm condition */
    unsigned short RunTime;            /* Time in minutes the machine has been running */
    unsigned short ControllerNumber;   /* Controller number, from ROM */
    unsigned char  SoftwareVersion;    /* Software version */
    unsigned char  GasFlow;            /* Gas flow, 10*l/min */
    unsigned char  LinePressure;       /* Back pressure, 100*bar */
    unsigned char  CryoAdjust;         /* Cryodrive speed boost */
    unsigned char  OuterFlow;          /* Flow rate in outer stream */
    unsigned char  GasType;            /* Helium or nitrogen in cold stream */
    unsigned char  TurboMode;          /* In Turbo mode ? */
    unsigned char  HardwareType;       /* Cryostream, Plus, with/without Shutter */
    unsigned char  ShutterState;       /* Shutter status */
    unsigned char  ShutterTime;        /* Shutter time remaining */
    unsigned char  UnusedOne;          /* For expansion */
    unsigned char  UnusedTwo;          /* For expansion */
    unsigned short UnusedThree;        /* For expansion */
    unsigned short UnusedFour;         /* For expansion */
} NHelixStatus;

enum CryostreamCommand {
  CSCOMMAND_RESTART=10,  /* Restart a Cryostream which has shutdown */
  CSCOMMAND_RAMP=11,     /* Ramp command identifier - parameters follow */
  CSCOMMAND_PLAT=12,     /* Plat command identifier - parameter follows */
  CSCOMMAND_HOLD=13,     /* Hold command identifier - enter programmed Hold */
  CSCOMMAND_COOL=14,     /* Cool command identifier - parameter follows  */
  CSCOMMAND_END=15,      /* End command identifier - parameter follows  */
  CSCOMMAND_PURGE=16,    /* Purge command identifier     */
  CSCOMMAND_PAUSE=17,    /* Pause command identifier - enter temporary Hold */
  CSCOMMAND_RESUME=18,   /* Resume command identifier - exit temporary Hold  */
  CSCOMMAND_STOP=19,     /* Stop command identifier      */
  CSCOMMAND_TURBO=20,    /* Turbo command identifier - parameter follows */
  CSCOMMAND_SETSTATUSFORMAT=40,        /* Set status packet format. Parameter follows */
  CSCOMMAND_CRYOSHUTTER_START_AUTO=80, /* Shut the CryoShutter for the specified length of time. - parameter follows */
  CSCOMMAND_CRYOSHUTTER_START_MAN=81,  /* Shut the CryoShutter until a CSCOMMAND_CRYOSHUTTER_STOP is received */
  CSCOMMAND_CRYOSHUTTER_STOP=82        /* Open the CryoShutter */
};

QCryostreamDevice::QCryostreamDevice(QPidControllerWPtr ctrl, QcepSettingsSaverWPtr saver, QString deviceName) :
  QPidDevice(ctrl, saver, QPidDevice::CryostreamDevice, deviceName, 1000, 2000),
  m_ObjectNamer(this, "cryostream"),
  m_CryostreamDeviceType(QcepSettingsSaverPtr(), this, "cryostreamDeviceType", UnknownDevice, "Detected Device Type")
{
}

void QCryostreamDevice::readoutInitial()
{
}

void QCryostreamDevice::readoutPolling()
{
}

void QCryostreamDevice::readoutTimeout()
{
}

void QCryostreamDevice::readyRead()
{
  m_Buffer.append(commPort()->readAll());

  parseStatusPacket();
}

int QCryostreamDevice::makeWord(int hi, int lo)
{
  return (hi&0xff << 8) | (lo&0xff);
}

void QCryostreamDevice::parseStatusPacket()
{
  while (m_Buffer.count() >= 2) {
    printMessage(tr("parseStatusPacket(len=%1)").arg(m_Buffer.count()));

    unsigned char len = m_Buffer[0];
    unsigned char typ = m_Buffer[1];

    if ((len == 32 && typ == 1) ||       // Standard status packet
        (len == 42 && typ == 2) ||       // Extended status packet
        (len == 44 && typ == 150) ||     // Cobra status packet
        (len == 32 && typ == 100) ||     // Phenix status packet
        (len == 46 && typ == 200)) {     // Helix status packet

      if (m_Buffer.count() >= 32) {
        int setPoint    = makeWord(m_Buffer[2], m_Buffer[3]);
        int temperature = makeWord(m_Buffer[4], m_Buffer[5]);
        int temperror   = makeWord(m_Buffer[6], m_Buffer[7]);
        int output      = m_Buffer[21];
        int runMode     = m_Buffer[8];
        int phaseID     = m_Buffer[9];
        int alarmCode   = m_Buffer[25];

        if ((runMode >= 0 && runMode <= 6) &&             // run mode 0..6
            (phaseID >= 0 && phaseID <= (typ<10?10:9)) && // Cryostream phaseID 0..10, others 0..9
            (alarmCode >= 0 && alarmCode <= 26) &&        // alarm code 0..26
            (temperature - setPoint == temperror)) {      // temperature error OK?
          if (m_Buffer.count() >= len) {
            switch(typ) {
            case 1:
            case 2:
              set_CryostreamDeviceType(CryostreamDevice);
              break;

            case 100:
              set_CryostreamDeviceType(PhenixDevice);
              break;

            case 150:
              set_CryostreamDeviceType(CobraDevice);
              break;

            case 200:
              set_CryostreamDeviceType(HelixDevice);
              break;

            default:
              set_CryostreamDeviceType(UnknownDevice);
            }

            QPidControllerPtr ctl(controller());

            if (ctl) {
              ctl->set_Temperature(K2degC(cK2K(temperature)));
              ctl->set_SetPoint(K2degC(cK2K(setPoint)));
              ctl->set_OutputLevel(output);
              ctl->set_Enabled(runMode==3);
            }

            m_Buffer.remove(0, len);
          } else {
            break;
          }
        } else {
          // Not a valid status packet - drop 1 byte and try again
          m_Buffer.remove(0,1);
        }
      }
    } else {
      m_Buffer.remove(0,1);
    }
  }
}

void QCryostreamDevice::writeSettings(QSettings *set, QString section)
{
  QPidDevice::writeSettings(set, section+"/cryostream");

  QcepProperty::writeSettings(this, &staticMetaObject, section+"/cryostream", set);
}

void QCryostreamDevice::readSettings(QSettings *set, QString section)
{
  QPidDevice::readSettings(set, section+"/cryostream");

  QcepProperty::readSettings(this, &staticMetaObject, section+"/cryostream", set);
}

void QCryostreamDevice::configurationDialog()
{
  if (m_DeviceDialog == NULL) {
    m_DeviceDialog = QCryostreamDeviceDialogPtr(new QCryostreamDeviceDialog(QCryostreamDevicePtr(this)));
  }

  if (m_DeviceDialog) {
    m_DeviceDialog->show();
    m_DeviceDialog->raise();
  }
}

void QCryostreamDevice::sendCommand(QString /*cmd*/)
{
}

void QCryostreamDevice::changeSetPoint(double setPoint)
{
  QPidControllerPtr ctl(controller());

  if (ctl) {
    sendCryoCommand(CSCOMMAND_RAMP, cryoRate(ctl->get_RampRate())+cryoTemperature(setPoint));
  }
}

void QCryostreamDevice::changeRampRate(double /*rate*/)
{
}

void QCryostreamDevice::changeProportional(double /*prop*/)
{
}

void QCryostreamDevice::changeIntegral(double /*integ*/)
{
}

void QCryostreamDevice::changeDerivative(double /*deriv*/)
{
}

void QCryostreamDevice::enable(bool on)
{
  if (on) {
    sendCryoCommand(CSCOMMAND_RESTART);
  } else {
    sendCryoCommand(CSCOMMAND_STOP);
  }
}

bool QCryostreamDevice::canAutoTune()
{
  return false;
}

void QCryostreamDevice::autoTune()
{
}

void QCryostreamDevice::sendCryoCommand(int cmd, QByteArray args)
{
  printMessage(tr("sendCryoCommand(%1,QByteArray(len=%2))").arg(cmd).arg(args.count()));

  if (get_DeviceType() == 0) {
    printMessage("Warning: Sending command to unknown device");
  }

  QByteArray msg;

  msg.append(2+args.count());
  msg.append(cmd);
  msg.append(args);

  if (commPort()->isWritable()) {
    commPort()->write(msg);
  } else {
    printMessage("Serial port is not writable");
  }
}

QByteArray QCryostreamDevice::cryoRate(double rate)
{
  QByteArray res;

  short rateint = (short)(rate*60);

  res.append((unsigned char) ((rateint>>8) & 0xff));
  res.append((unsigned char) (rateint & 0xff));

  return res;
}

QByteArray QCryostreamDevice::cryoTemperature(double temp)
{
  QByteArray res;

  short cKTemp = (short)(K2cK(degC2K(temp)));

  res.append((unsigned char) ((cKTemp>>8) & 0xff));
  res.append((unsigned char) (cKTemp & 0xff));

  return res;
}