mitkSerialCommunication.h

Go to the documentation of this file.

/*============================================================================

The Medical Imaging Interaction Toolkit (MITK)

Copyright (c) German Cancer Research Center (DKFZ)
All rights reserved.

Use of this source code is governed by a 3-clause BSD license that can be
found in the LICENSE file.

============================================================================*/

#ifndef MITKSERIALCOMMUNICATION_H_HEADER_INCLUDED_
#define MITKSERIALCOMMUNICATION_H_HEADER_INCLUDED_

#include <MitkIGTExports.h>
#include "mitkCommon.h"
#include <itkObject.h>
#include <itkObjectFactory.h>

#ifdef WIN32
#include <windows.h>
#else // Posix
#include <termios.h>
#endif

namespace mitk
{
  class MITKIGT_EXPORT SerialCommunication : public itk::Object
  {
  public:
    mitkClassMacroItkParent(SerialCommunication, itk::Object);
    itkFactorylessNewMacro(Self);
    itkCloneMacro(Self);

    enum PortNumber
    {
      COM1 = 1,
      COM2 = 2,
      COM3 = 3,
      COM4 = 4,
      COM5 = 5,
      COM6 = 6,
      COM7 = 7,
      COM8 = 8,
      COM9 = 9,
      COM10 = 10,
      COM11 = 11,
      COM12 = 12,
      COM13 = 13
    };

    enum BaudRate
    {
      BaudRate9600    = 9600,
      BaudRate14400   = 14400,
      BaudRate19200   = 19200,
      BaudRate38400   = 38400,
      BaudRate57600   = 57600,
      BaudRate115200  = 115200, // Highest supported rate for NDI Aurora
      BaudRate230400  = 230400,
      BaudRate460800  = 460800,
      BaudRate500000  = 500000,
      BaudRate576000  = 576000,
      BaudRate921600  = 921600,
      BaudRate1000000 = 1000000,
      BaudRate1152000 = 1152000,
      // BaudRate1228739 = 1228739, // Highest supported rate for NDI Polaris According to handbook, unknown value to most compilers though
      BaudRate1500000 = 1500000,
      BaudRate2000000 = 2000000,
      BaudRate2500000 = 2500000,
      BaudRate3000000 = 3000000,
      BaudRate3500000 = 3500000,
      BaudRate4000000 = 4000000
    };

    enum DataBits
    {
      DataBits8 = 8,
      DataBits7 = 7
    };

    enum Parity
    {
      None = 'N',
      Odd  = 'O',
      Even = 'E'
    };

    enum StopBits
    {
      StopBits1 = 1,
      StopBits2 = 2
    };

    enum HardwareHandshake
    {
      HardwareHandshakeOn = 1,
      HardwareHandshakeOff = 0
    };

    bool IsConnected();
    int OpenConnection();
    void CloseConnection();

    int Receive(std::string& answer, unsigned int numberOfBytes, const char *eol=nullptr);

    int Send(const std::string& input, bool block = false);

    void SendBreak(unsigned int ms = 400);

    void ClearReceiveBuffer();

    void ClearSendBuffer();

    itkGetConstMacro(PortNumber, PortNumber);

    itkSetMacro(PortNumber, PortNumber);

    itkGetStringMacro(DeviceName);

    itkSetStringMacro(DeviceName);

    itkGetConstMacro(BaudRate, BaudRate);

    itkSetMacro(BaudRate, BaudRate);

    itkGetConstMacro(DataBits, DataBits);

    itkSetMacro(DataBits, DataBits);

    itkGetConstMacro(Parity, Parity);

    itkSetMacro(Parity, Parity);

    itkGetConstMacro(StopBits, StopBits);

    itkSetMacro(StopBits, StopBits);

    itkGetConstMacro(HardwareHandshake, HardwareHandshake);

    itkSetMacro(HardwareHandshake, HardwareHandshake);

    itkGetConstMacro(SendTimeout, unsigned int);

    itkSetMacro(SendTimeout, unsigned int);

    itkGetConstMacro(ReceiveTimeout, unsigned int);

    itkSetMacro(ReceiveTimeout, unsigned int);

  protected:
    SerialCommunication();
    ~SerialCommunication() override;

    int ApplyConfiguration();


    #ifdef WIN32

    int ApplyConfigurationWin();

    #else

    int ApplyConfigurationUnix();


    #endif


    std::string m_DeviceName; 
    PortNumber m_PortNumber;  
    BaudRate m_BaudRate;      
    DataBits m_DataBits;      
    Parity m_Parity;          
    StopBits m_StopBits;      
    HardwareHandshake m_HardwareHandshake;  
    unsigned int m_ReceiveTimeout; 
    unsigned int m_SendTimeout;    

    bool m_Connected;       

#ifdef WIN32
    HANDLE m_ComPortHandle;
    DWORD m_PreviousMask;
    COMMTIMEOUTS m_PreviousTimeout;
    DCB m_PreviousDeviceControlBlock;
#else
    int m_FileDescriptor;
#endif
  };
} // namespace mitk
#endif /* MITKSERIALCOMMUNICATION_H_HEADER_INCLUDED_ */