ngcdcsSVS.hpp

Go to the documentation of this file.

#ifndef ngcdcsSVS_H
#define ngcdcsSVS_H
 
 
#ifndef __cplusplus
#error This is a C++ include file and cannot be used from plain C
#endif
 
#include <ngc/core/ngcbAddr.h>
#include <ngc/core/ngcbMOD.hpp>
#include <ngc/core/ngcdcsSENS.hpp>

#define ngcdcsSVS_SENS_TEMP     1  //< temperature sensor
#define ngcdcsSVS_SENS_RHUM     2  //< humidity sensor
#define ngcdcsSVS_SENS_PRESSURE 4  //< pressure sensor
#define ngcdcsSVS_SENS_PTEMP    8  //< pressure sensor temperature

#define ngcdcsSVS_SENS_ALL (ngcdcsSVS_SENS_TEMP|ngcdcsSVS_SENS_RHUM|ngcdcsSVS_SENS_PRESSURE|ngcdcsSVS_SENS_PTEMP)
 
/*
 * SVS I2C-control flags
 */
#define ngcdcsSVS_I2C_READ     0x0001  //< companion read
#define ngcdcsSVS_I2C_RESTART  0x0004  //< restart (bus held)
#define ngcdcsSVS_I2C_HOLD     0x0008  //< hold bus
#define ngcdcsSVS_I2C_BITMASK  0x0080  //< bitmask request
 
/*
 * Supervisor status word
 */
#define ngcdcsSVS_STAT_OK       0x0000  //< all in range
#define ngcdcsSVS_STAT_CML      0x0002  //< CML fault
#define ngcdcsSVS_STAT_TEMP     0x0004  //< temperature alarm
#define ngcdcsSVS_STAT_OC       0x0010  //< over-current alarm 
#define ngcdcsSVS_STAT_OV       0x0020  //< over-voltage alarm
#define ngcdcsSVS_STAT_OFF      0x0040  //< a voltage is off
#define ngcdcsSVS_STAT_MARGIN   0x0100  //< margin fault
#define ngcdcsSVS_STAT_PG       0x0800  //< power not good
#define ngcdcsSVS_STAT_MFR      0x1000  //< check MFR-specific
#define ngcdcsSVS_STAT_IOUT     0x4000  //< current fault or warning
#define ngcdcsSVS_STAT_VOUT     0x8000  //< voltage fault or warning
 
/*
 * Supervisor page fault status
 */
#define ngcdcsSVS_PSTAT_OK      0x00000000  //< all in range
#define ngcdcsSVS_PSTAT_OTW     0x00000001  //< over-temperature warning
#define ngcdcsSVS_PSTAT_OTF     0x00000002  //< over-temperature fault
#define ngcdcsSVS_PSTAT_OCW     0x00000010  //< over-current warning
#define ngcdcsSVS_PSTAT_OCF     0x00000020  //< over-current fault
#define ngcdcsSVS_PSTAT_OVW     0x00000100  //< over-voltage warning
#define ngcdcsSVS_PSTAT_OVF     0x00000200  //< over-voltage fault
#define ngcdcsSVS_PSTAT_UVW     0x00000400  //< under-voltage warning
#define ngcdcsSVS_PSTAT_UVF     0x00000800  //< under-voltage fault
#define ngcdcsSVS_PSTAT_PG      0x00001000  //< power not good
#define ngcdcsSVS_PSTAT_TON     0x00002000  //< TON max faults exceeded
#define ngcdcsSVS_PSTAT_MARGIN  0x00004000  //< supply close-loop margin fault
#define ngcdcsSVS_PSTAT_OFF     0x00080000  //< supply voltage off
 
#define ngcdcsSVS_NUM_PAGES     21      //< number of supervisor pages

struct ngcdcs_svs_i2c_t {
  int addr;  //< Device address
  int flags; //< Protocol control flags

  ngcdcs_svs_i2c_t() {addr = 0x0; flags = 0x0;}
};

struct ngcdcs_svs_info
{
public:
  char date[9];             //< Date
  char location[9];         //< Location
  char serialNumber[9];     //< Serial number
  char revision[3];         //< Hardware + firmware revision number
  unsigned short fwNumber;  //< Firmware version number

  ngcdcs_svs_info() {
    strcpy(date, "10101010");
    strcpy(location, "10101010");
    strcpy(serialNumber, "10101010");
    strcpy(revision, "00");
    fwNumber = (unsigned short)0x0;
  }
};
 

class ngcdcsSVS_PAGE
{
public:
  char name[32]; //< Name
  char unit[8];  //< Unit
  double scale;  //< Scale factor
  double fault1; //< Lower fault limit
  double warn1;  //< Lower warning limit
  double fault2; //< Upper fault limit
  double warn2;  //< Upper warning limit
  double pgOn;   //< power good on
  double pgOff;  //< power good on
  double value;  //< Value
  double peak;   //< Peak value
  double min;    //< Minimum value
  double avg;    //< Average value
  int enabled;   //< Enabled status (supply-voltages only)
  int status;    //< Fault status
  
  ngcdcsSVS_PAGE() {
    name[0] = '\0'; unit[0] = '\0';
    scale = 1.0;
    fault1 = 0.0; warn1 = 0.0; fault2 = 0.0; warn2 = 0.0;
    pgOn = 0.0; pgOff = 0.0;
    value = 0.0; peak = 0.0; min = 0.0; avg = 0.0;
    enabled = 1; status = ngcdcsSVS_STAT_OK;
  }

  virtual ~ngcdcsSVS_PAGE() {}     

  void Assign(const char *n, const char *u, double f) {
    str2str(name, n, sizeof(name) - 1);
    str2str(unit, u, sizeof(unit) - 1);
    scale = f;
  }
protected:
private:
};

class ngcdcsSVS: public ngcbMOD
{
public:
  explicit ngcdcsSVS(const ngcb_route_t &r);

  ngcdcsSVS(ngcbIFC *ifc, const ngcb_route_t &r);

  virtual ~ngcdcsSVS();     

  ngcdcsSHT31_TEMP temp;
  
  ngcdcsSHT31_RHUM rhum;

  ngcdcsMPL3115A2_PRESSURE pressure;

  ngcdcsMPL3115A2_TEMP ptemp;

  int sensEnabled;

  int sensPrefill;

  double sensSettleTime;

  int sensHeat;

  ngcdcs_svs_i2c_t i2c[3];

  ngcdcsSVS_PAGE *page;
  
  void Reset(); 

  int Enable(int check = 1);

  int Disable();

  int Selftest();

  int Action(const char *action, char *reply = NULL);

  void Dump(char *s, int idx);
  
  void Dump(char *s);
  
  int Info(ngcdcs_svs_info *info);

  int SoftReset();
  
  int Stop();
  
  int Restart();
  
  int PageEnable(int flag, int page = 255);
  
  int ClearFaults();
  
  int ClearFaultLog();
  
  int ForceFaultLog();
  
  int FaultLogDepth(int n);
  
  int FaultLogOverwrite(int flag);
  
  int ResetHistory();

  int Status(int *status);
  
  int Update(int sensor, int force = 0);

  int ResetSensors(int errFlag = 0); 

  int ResetRHum();

  int ResetTemp();

  int ResetPressure();

  int ResetPTemp();

  int SensorError(int sensor);

  int SensHeat(int flag);
  
  int SetupKey(const char *key, const int *idx, const char *value, 
           int *status = NULL);

  int StatusKey(const char *key, const int *idx, char *value, 
        int *status = NULL);
 
protected: 
 
private:
  int cvs1_;
  
  struct timeval timeReset_;

  int logDepth_;
  
  int logOverwrite_;
  
  void Init_();                

  void Log_(const char *msg);

  int UpdateSensors_(int sensor, int force);

  int ResetSensor1_();

  int ResetSensor2_();

  int Write_(int idx, const int *data, int size, int flags = 0x0);

  int Read_(int idx, int *data, int size, int flags = 0x0);

  int ReadReg_(int idx, int addr, int *data, int size, int restart = 0);
  
  int SelectPage_(int p);
  
  int Read_(double *value, int p, int cmd, int hold);

  int Read_();
  
  int Read_(int p, int hold = 0);
  
  int ReadLimits_(int p, int hold = 0);

  int ReadAll_();

  int Reset_(int p);

  int GetFaults_(int status);
  
  void ClrStatus_();

  int Page_(const char *name);

  int CRC_(const int *data, size_t size);
 
};
 
#endif