lib/LSerie.cpp

#include <windows.h>
#include <stdio.h>
#include "winuser.h"
#include "LSerie.h"
//#include "plugin.h"
#include <setupapi.h>

// Construction/Destruction

LSerie::LSerie()
{
        hcom = 0;       //Fichier de sortie sur le port COM             | The file stream use for acces to the serial port.
        bufferSize = 8192;      // Buffer d'entrée sortie.
  currentPort = -1;
}

LSerie::~LSerie()
{
  closeCom();
}

bool LSerie::CheckPort(unsigned int num)
{ 
  // Create a device information set that will be the container for 
  // the device interfaces.
  GUID *guidDev = (GUID*) &GUID_CLASS_COMPORT;
  HDEVINFO hDevInfo = INVALID_HANDLE_VALUE;
  SP_DEVICE_INTERFACE_DETAIL_DATA *pDetData = NULL;
  SP_DEVICE_INTERFACE_DATA ifcData;
  BOOL bOk = true;

  hDevInfo = SetupDiGetClassDevs( guidDev,NULL,NULL,DIGCF_PRESENT | DIGCF_DEVICEINTERFACE);

  if(hDevInfo == INVALID_HANDLE_VALUE) 
  {
    return false;
  }

  DWORD dwDetDataSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA) + 256;
  pDetData = (SP_DEVICE_INTERFACE_DETAIL_DATA*) new char[dwDetDataSize];
  ifcData.cbSize = sizeof(SP_DEVICE_INTERFACE_DATA);
  pDetData->cbSize = sizeof(SP_DEVICE_INTERFACE_DETAIL_DATA);

  bOk = SetupDiEnumDeviceInterfaces(hDevInfo,NULL, guidDev, num, &ifcData);
  if (!bOk) 
  {
    return false;
  }

  // Got a device. Get the details.
  SP_DEVINFO_DATA devdata = {sizeof(SP_DEVINFO_DATA)};
  bOk = SetupDiGetDeviceInterfaceDetail(hDevInfo,&ifcData, pDetData, dwDetDataSize, NULL, &devdata);
  if (!bOk) 
  {
    return false;
  }

  std::string strDevPath(pDetData->DevicePath);
  // Got a path to the device. Try to get some more info.
  TCHAR fname[256];
  TCHAR desc[256];
  TCHAR szPortName[MAX_PATH];
  bool bUsbDevice = FALSE;
  TCHAR locinfo[256];

  bOk = SetupDiGetDeviceRegistryProperty(hDevInfo, &devdata, SPDRP_FRIENDLYNAME, NULL,(PBYTE)fname, sizeof(fname), NULL);

  bOk = bOk && SetupDiGetDeviceRegistryProperty(hDevInfo, &devdata, SPDRP_DEVICEDESC, NULL,(PBYTE)desc, sizeof(desc), NULL);

  SetupDiGetDeviceRegistryProperty(hDevInfo, &devdata, SPDRP_LOCATION_INFORMATION, NULL,(PBYTE)locinfo, sizeof(locinfo), NULL);

  HKEY hKey = SetupDiOpenDevRegKey(hDevInfo, &devdata, DICS_FLAG_GLOBAL,0,DIREG_DEV,KEY_READ);

  DWORD dwType = REG_SZ;
  DWORD dwReqSize = sizeof(szPortName);
  long lRet = RegQueryValueEx(hKey,"PortName", 0, &dwType, (LPBYTE)&szPortName, &dwReqSize);
    
  if (pDetData != NULL)
  {
    delete [] (char*)pDetData;
  }
  if (hDevInfo != INVALID_HANDLE_VALUE)
  {
    SetupDiDestroyDeviceInfoList(hDevInfo);
  }

  if(hKey && bOk)
  {
    return true;
  }
  return false;
}

bool LSerie::open(int numPort, long speedInBaud)
{
        return open(numPort, speedInBaud, 8, 0, 1);
}


/************************************************************************************
**** Fonction: Open
**** Derniére modif: 21/05/2005
**** Développeur: Alexandre Fonton
**** Rôle: Ouvre le port RS232 choisi. 
**** Recoit: 
**** Renvoie: Faux si l'ouverture du port a échoué, sinon Vrai.
*************************************************************************************/

bool LSerie::open(int numPort, long speedInBaud, int nbBit, int parity, float nbStopBit)
{       
  char buf[13];
  buf[0]=0;

        //--- Vérification des paramétres passés à la fonction:
        if(numPort<1 || numPort>256)            // Vérification que le numéro de port est compri entre 1 et 9.
                return false;

        if(speedInBaud<1)               // Vérification de la vitesse de communication
                return false;

        if(nbBit<5 || nbBit > 9)
                return false;

        if(parity<0 || parity > 2)
                return false;

        if(nbStopBit<1 || nbStopBit > 2)
                return false;

        //--- Création d'une chaine de caractère contenant le nom du port série, ex : COM1.

  sprintf(buf, "\\\\.\\COM%i", numPort);

        //--- Ouverture du port série en lecture / écriture.v

  hcom=CreateFile(buf, GENERIC_READ|GENERIC_WRITE, 0, 0, OPEN_EXISTING , FILE_FLAG_WRITE_THROUGH, 0);
        if (hcom==0 || hcom==INVALID_HANDLE_VALUE)
  {
    //std::string err = getErrorMsg();
                return false;
  }

  //--- Définit la durée du TimeOut pour la reception.
  setTimeOut(DISCONNECTION_WIN_TIME);

        //--- Dimensionne les buffers d'entrée et sortie.
        if ( !SetupComm(hcom, bufferSize, bufferSize) )     
            return false;

        //--- Récupére l'objet de configuration du format des bytes.
    if ( !GetCommState(hcom, &dcb))
                return false;

        //Vitesse de communication
        dcb.BaudRate = speedInBaud;

        //Nombre de bit par byte:
        dcb.ByteSize = nbBit;
        
        //Nombre de bit de stop: 1, 1.5 ou 2
        if(nbStopBit == 1)
                dcb.StopBits = ONESTOPBIT;
        if(nbStopBit == 1.5)
                dcb.StopBits = ONE5STOPBITS;
        if(nbStopBit == 2)
                dcb.StopBits = TWOSTOPBITS;
        
        //Vérification de la parité: 0 pas de vérif, 1 pair, 2 impaire.
        if(parity == 0)
                dcb.Parity = NOPARITY;
        if(parity == 1)
                dcb.Parity = ODDPARITY;
        if(parity == 2)
                dcb.Parity = EVENPARITY;
        
        // ajoute le handle pour scol
        comport = hcom;

  currentPort = numPort;

        //--- Stocke l'objet de configuration du format des bytes.
          if (!SetCommState(hcom, &dcb))
                return false;
          else
                return true;
}


/************************************************************************************
**** Fonction: CloseCom
**** Derniére mofif: 01/07/2004
**** Développeur: Alexandre Fonton
**** Rôle: Ferme le port RS232 actuellement ouvert.
**** Recoit: Rien
**** Renvoie: Rien
*************************************************************************************/

void LSerie::closeCom()
{
  if(hcom)
  {
          CloseHandle(hcom);
          hcom = 0;
  }
}

/************************************************************************************
**** Fonction: SetTimeout
**** Derniére mofif: 01/07/2004
**** Développeur: Alexandre Fonton
**** Rôle: Définit la durée maximum d'attente d'une information (TimeOut).
**** Recoit: Temps d'attente en ms.
**** Renvoie: Faux si l'opération a échoué, sinon Vrai.
*************************************************************************************/

bool LSerie::setTimeOut(DWORD ms)
{
        //--- Vérification des paramétres passés à la fonction:
        if( ms<0)
                return false;

        ct.ReadIntervalTimeout = 0;
        ct.ReadTotalTimeoutMultiplier = 0;      // pas de multipicateur de timeout en fonction du nombre de caractères demandés.
        ct.ReadTotalTimeoutConstant = ms;
        ct.WriteTotalTimeoutMultiplier = 0;
        ct.WriteTotalTimeoutConstant = ms;
        if ( !SetCommTimeouts(hcom, &ct) )      //Configuration du Time Out
                return false;
        return false;
        //MSDN: The SetCommTimeouts function sets the time-out parameters for all read and write operations on a specified communications device.
}

/**********************************************************************
**** Fonction: SetBaud
**** Derniére mofif: 01/07/2004
**** Développeur: Alexandre Fonton
**** Rôle: Définit la vitesse de communication (ex:9600 baud).
**** Recoit: Vitesse de communication en baud.
**** Renvoie: Faux si l'opération a échoué, sinon Vrai.
***********************************************************************/

bool LSerie::setSpeed(DWORD baudrate)
{
        //--- Vérification des paramétres passés à la fonction:
        if( baudrate<1)
                return false;


        if (!GetCommState(hcom, &dcb))
                return FALSE;

        dcb.BaudRate = baudrate;

        if (!SetCommState(hcom, &dcb))
                return FALSE;
        else 
                return TRUE;


        

        //MSDN: The SetCommState function configures a communications device according to the specifications in a device-control block (a DCB structure). The function reinitializes all hardware and control settings, but it does not empty output or input queues.
}



/**********************************************************************
**** Fonction: SendData(string)
**** Derniére mofif: 22/05/2005
**** Développeur: Alexandre Fonton
**** Rôle: Envoie une chaine de caractères contenu dans un type "string" sur le port RS232 actuellement ouvert.
**** Recoit: Un pointeur sur une chaine de caractéres.
**** Renvoie: -1 si l'opération a échoué, sinon le nombre de caractères envoyés.
***********************************************************************/

int  LSerie::sendData(string* data)
{
        //--- Vérification des paramétres passés à la fonction:
        if( data == NULL )
                return false;

        return sendData((DWORD)data->size(), (LPBYTE)data->data());
}



/**********************************************************************
**** Fonction: SendData(DWORD lg, LPBYTE data)
**** Derniére mofif: 01/07/2004
**** Développeur: Alexandre Fonton
**** Rôle: Envoie une série d'octets sur le port RS232 actuellement ouvert.
**** Recoit: Un pointeur sur une chaine de caractéres (data) et sa taille (lg).
**** Renvoie: -1 si l'opération a échoué, sinon le nombre de caractères envoyés.
***********************************************************************/
int LSerie::sendData(DWORD lg, LPBYTE data)
{
        DWORD result=0;

        //--- Vérification des paramétres passés à la fonction:
        if( lg<0 || data==NULL)
                return false;


        if ( !WriteFile(hcom, data, lg, &result, 0) )
                return -1;
        else
                return (int)result;

        //MSDN:  The WriteFile function writes data to a file and is designed for both synchronous
        //              and asynchronous operation. The function starts writing data to the file at the 
        //              position indicated by the file pointer. After the write operation has been completed
        //              , the file pointer is adjusted by the number of bytes actually written, except when
        //              the file is opened with FILE_FLAG_OVERLAPPED. If the file handle was created for 
        //              overlapped input and output (I/O), the application must adjust the position of the
        //              file pointer after the write operation is finished.
    //       This function is designed for both synchronous and asynchronous operation. 
        //              The WriteFileEx function is designed solely for asynchronous operation. 
        //              It lets an application perform other processing during a file write operation.

}







/**********************************************************************
**** Fonction: ReceiveData(string* data)
**** Derniére mofif: 22/05/2005
**** Développeur: Alexandre Fonton
**** Rôle: Lecture du buffer de reception du port RS232 actuellement ouvert.
**** Recoit: Un pointeur sur une string.
**** Renvoie: -1 si l'opération a échoué, sinon le nombre de caractères recu.
***********************************************************************/
int LSerie::receiveData(string* data)
{       char buffer[1025];
        int nbChar=0;

        //--- Vérification des paramétres passés à la fonction:
        if( data==NULL)
                return false;

        nbChar = receiveData(1024, (LPBYTE)buffer);
        buffer[nbChar] = 0; // caractère de fin de chaine.
        data->assign(buffer);
        return nbChar;
}


/**********************************************************************
**** Fonction: ReceiveData
**** Derniére mofif: 01/07/2004
**** Développeur: Alexandre Fonton
**** Rôle: Lecture du buffer de reception du port RS232 actuellement ouvert.
**** Recoit: Un pointeur sur une chaine de caractéres (data) et sa taille maximale possible (lg).
**** Renvoie: -1 si l'opération a échoué, sinon le nombre de caractères recu.
***********************************************************************/
int LSerie::receiveData(DWORD lg, LPBYTE data)
{
        DWORD result=0;

        //--- Vérification des paramétres passés à la fonction:
        if( lg<0 || data==NULL)
                return false;

  if (ReadFile(hcom, data, lg, &result, 0))
  {
    return (int)result;
  }
  else
  {
    return -1;
  }

        //MSDN:   The ReadFile function reads data from a file, starting at the position indicated 
        //               by the file pointer. After the read operation has been completed, the file pointer
        //               is adjusted by the number of bytes actually read, unless the file handle is 
        //               created with the overlapped attribute. If the file handle is created for 
        //               overlapped input and output (I/O), the application must adjust the position of 
        //               the file pointer after the read operation.
        //        This function is designed for both synchronous and asynchronous operation. 
        //               The ReadFileEx function is designed solely for asynchronous operation. It lets 
        //               an application perform other processing during a file read operation.

}


/**************************** SetRts(val) **************************************************
**** Positionne RTS au niveau val (0 ou 1)   */
bool LSerie::setRts(bool val)                           
{ 
        if(val)
          { 
                  if(EscapeCommFunction(hcom, SETRTS) == TRUE )
                          return true;
          }
        else
          { 
                  if(EscapeCommFunction(hcom, CLRRTS) == TRUE )
                          return true;
          }

   return false;
}


/**************************** SetTxd(val) **************************************************
**** Positionne Txd au niveau val (0 ou 1)   */
bool LSerie::setTxd(bool val)                           
{ 
        if(val)
          { 
                  if( EscapeCommFunction(hcom, SETBREAK) == TRUE )
                          return true;
          }
        else
          { 
                  if( EscapeCommFunction(hcom, CLRBREAK) == TRUE )
                          return true;
          }
   return false;
}


        
/**************************** SetDtr(val) **************************************************
**** Positionne DTR au niveau val (0 ou 1)   */
bool LSerie::setDtr(bool val)                                           
{ 
        if(val)
          {
                  if( EscapeCommFunction(hcom, SETDTR) == TRUE )
                          return true;
          }
        else
          { 
                  if( EscapeCommFunction(hcom, CLRDTR) == TRUE )
                          return false;
          }
    return false;
}



/********************** GetCts() ***********************/
bool LSerie::getCts()                                           
{ 
        DWORD result;
                GetCommModemStatus(hcom, &result);
                if(result & MS_CTS_ON)
                        return true;
                else
                        return false;
}

/********************** GetDtr() ***********************/
bool LSerie::getDtr()                                           
{ 
  DWORD result;
                GetCommModemStatus(hcom, &result);
                if(result & MS_DSR_ON)
                        return true;
                else
                        return false;
}

/********************** GetRi() ***********************/
bool LSerie::getRi()                                            
{ 
  DWORD result;
                GetCommModemStatus(hcom, &result);
                if(result & MS_RING_ON)
                        return true;
                else
                        return false;
}


/********************** GetCd() ***********************/
bool LSerie::getCd()                                            
{ int err=0;
  DWORD result;
                err = GetCommModemStatus(hcom, &result);
                if(result & MS_RLSD_ON)
                        return true;
                else
                        return false;
}




string LSerie::getErrorMsg()
{
        LPVOID lpMsgBuf;
        string sErreur = "";

        if ( FormatMessage( FORMAT_MESSAGE_ALLOCATE_BUFFER | FORMAT_MESSAGE_FROM_SYSTEM | FORMAT_MESSAGE_IGNORE_INSERTS,
                                                        NULL, GetLastError(),
                                                        MAKELANGID(LANG_NEUTRAL, SUBLANG_DEFAULT), // Default language
                                                        (LPTSTR) &lpMsgBuf, 0, NULL ))
        {
                sErreur.assign((LPCTSTR)lpMsgBuf);
        }

        return sErreur;
}


bool LSerie::isConnect()
{
        if(!getRi() && !getCd() && !getCd() && !getDtr() && !getCts())
    return false;
  return true;
}

std::list<unsigned int> LSerie::enumAvailablePorts()
{
  std::list<unsigned int> portList;
  const HKEY HK = HKEY_LOCAL_MACHINE;
  const char* key = "HARDWARE\\DEVICEMAP\\SERIALCOMM";

  HKEY regData;
  RegOpenKeyEx(HK, key, 0, KEY_ALL_ACCESS, &regData);

  char* valName = new char[1024];
        char* value = new char[25];
        unsigned long NName = 1024;
        unsigned long NVal = 25;

        int n = 0;
  long Ret;

  while ((RegEnumValue(regData, n, (char *)valName, &NName, 0, 0, (unsigned char *)value, &NVal)) == ERROR_SUCCESS)
        {
    std::string temp = value;
    unsigned int iPort = 0;
    temp = temp.substr(3);
    
    valueOf(temp, iPort);
    portList.push_back(iPort);

    NName = 1024;
    NVal = 25;

    n++;
        }
  
  RegCloseKey(regData);
  delete(valName);
  delete(value);
  return portList;
}