ClSerial.h

Go to the documentation of this file.

//-----------------------------------------------------------------------------
//  (c) 2008 by Basler Vision Technologies
//  Section: Vision Components
//  Project: GenApi
//  Author:  Fritz Dierks
//  $Header$
//
//  License: This file is published under the license of the EMVA GenICam  Standard Group. 
//  A text file describing the legal terms is included in  your installation as 'GenICam_license.pdf'. 
//  If for some reason you are missing  this file please contact the EMVA or visit the website
//  (http://www.genicam.org) for a full copy.
// 
//  THIS SOFTWARE IS PROVIDED BY THE EMVA GENICAM STANDARD GROUP "AS IS"
//  AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,  
//  THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR  
//  PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE EMVA GENICAM STANDARD  GROUP 
//  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,  SPECIAL, 
//  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT  LIMITED TO, 
//  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,  DATA, OR PROFITS; 
//  OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY  THEORY OF LIABILITY, 
//  WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT  (INCLUDING NEGLIGENCE OR OTHERWISE) 
//  ARISING IN ANY WAY OUT OF THE USE  OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
//  POSSIBILITY OF SUCH DAMAGE.
//-----------------------------------------------------------------------------
#ifndef CLPROTOCOL_CLSERIAL_H
#define CLPROTOCOL_CLSERIAL_H

#include <CLProtocol/ClSerialTypes.h>

//==============================================================================
//  Macros 
//==============================================================================

#if (defined(__cplusplus) || defined(__cplusplus__))
    #define USER_EXTERN_C extern "C"
#else
    #define USER_EXTERN_C
#endif

#ifdef CLSERIAL_EXPORTS
    #if defined(_WIN32)
        #define CLSERIALEXPORT USER_EXTERN_C __declspec(dllexport)
    #else
        #define CLSERIALEXPORT USER_EXTERN_C __attribute__((visibility("default")))
    #endif
#else
    #if defined(_WIN32)
        #define CLSERIALEXPORT USER_EXTERN_C __declspec(dllimport)
    #else
        #define CLSERIALEXPORT USER_EXTERN_C __attribute__((visibility("default")))
    #endif
#endif

#ifndef CLSERIALCC
    // Note that the CLAllSerial.dll uses __stdcall instead of __cdecl
    #if defined(_WIN32)
        #define CLSERIALCC __cdecl
    #else
        #if !defined(__x86_64) && !defined(__arm__) && !defined(__aarch64__) && !defined(VXWORKS)
            #define  CLSERIALCC __attribute__((cdecl))
        #else
            #define  CLSERIALCC  /* use default calling convention */
        #endif
    #endif
#endif

//==============================================================================
//  exported functions
//==============================================================================




CLSERIALEXPORT CLINT32 CLSERIALCC
clGetManufacturerInfo(
    CLINT8* ManufacturerName,           
    CLUINT32* bufferSize,               
    CLUINT32* version                 
    );

CLSERIALEXPORT CLINT32 CLSERIALCC 
clSerialInit(
    CLUINT32 serialIndex,   
    hSerRef* serialRefPtr   
    );                      

CLSERIALEXPORT CLINT32 CLSERIALCC
clSerialRead(
    hSerRef serialRef,  
    CLINT8* buffer,     
    CLUINT32* bufferSize,   
    CLUINT32  serialTimeOut 
    );

CLSERIALEXPORT CLINT32 CLSERIALCC
clSerialWrite(
    hSerRef serialRef,  
    CLINT8* buffer,     
    CLUINT32* bufferSize,  
    CLUINT32 serialTimeOut 
    );

CLSERIALEXPORT void CLSERIALCC 
clSerialClose(
    hSerRef serialRef 
    );


CLSERIALEXPORT CLINT32 CLSERIALCC 
clGetNumSerialPorts(
    CLUINT32* numSerialPorts    
    );                          

/*
\brief This function returns a manufacturer-specific identifier for each serial port in your system.
\return At completion, this function returns one of the following status codes:
    CL_ERR_NO_ERR
    CL_BUFFER_TOO_SMALL
    CL_ERR_FUNCTION_NOT_FOUND
    CL_ERR_INVALID_INDEX
*/
CLSERIALEXPORT CLINT32 CLSERIALCC 
clGetSerialPortIdentifier(
    CLUINT32 serialIndex,   
    CLINT8* PortID,     
    CLUINT32 *bufferSize  
    );                    

CLSERIALEXPORT CLINT32 CLSERIALCC 
clGetNumBytesAvail( 
    hSerRef serialRef,  
    CLUINT32 *numBytes    
    );

CLSERIALEXPORT CLINT32 CLSERIALCC 
clFlushPort( 
    hSerRef serialRef 
    );

CLSERIALEXPORT CLINT32 CLSERIALCC
clGetSupportedBaudRates(
    hSerRef serialRef,  
    CLUINT32 *baudRates 
    );                  

CLSERIALEXPORT CLINT32 CLSERIALCC 
clSetBaudRate( 
    hSerRef serialRef,  
    CLUINT32 baudRate   
    );                  

CLSERIALEXPORT CLINT32 CLSERIALCC 
clGetErrorText( 
    CLINT32 errorCode,  
    CLINT8* errorText,  
    CLUINT32* errorTextSize 
    );                      

 // CLSerialInterface // PublicInterfaces


//==============================================================================
//  helper functions
//==============================================================================


#endif // CLPROTOCOL_CLSERIAL_H