Exported C functions for camera link protocol drivers. More...
Include dependency graph for CLProtocol.h:
This graph shows which files directly or indirectly include this file:
Go to the source code of this file.
Classes | |
| struct | clpLogCallback_t |
Macros | |
| #define | CLPROTOCOL __attribute__((cdecl)) |
| #define | CLPROTOCOL_DECL __attribute__((visibility("default"))) |
| #define | CLPROTOCOLEXPORT USER_EXTERN_C __attribute__((visibility("default"))) |
| #define | USER_EXTERN_C |
| #define | USER_EXTERN_C_END |
| #define | USER_EXTERN_C_START |
Typedefs | |
| typedef void(CLPROTOCOL * | clp_logger_t) (CLINT32 level, const char *stringFormat, va_list argptr) |
| typedef USER_EXTERN_C_START struct clpLogCallback_t | clpLogCallback_t |
Enumerations | |
| enum | CLP_LOG_LEVEL_VALUE { CLP_LOG_FATAL = 0, CLP_LOG_ALERT = 100, CLP_LOG_CRIT = 200, CLP_LOG_ERROR = 300, CLP_LOG_WARN = 400, CLP_LOG_NOTICE = 500, CLP_LOG_INFO = 600, CLP_LOG_DEBUG = 700, CLP_LOG_NOTSET = 800 } |
| enum | CLP_PARAMS { CLP_LOG_LEVEL = 1, CLP_LOG_CALLBACK = 2, CLP_STOP_PROBE_DEVICE = 3, CLP_DEVICE_BAUDERATE = -1, CLP_DEVICE_SUPPORTED_BAUDERATES = -2 } |
| Types of parameters to be accessed by clpGetParam/clpSetParam. More... | |
Functions | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpInitLib (clp_logger_t logger, CLP_LOG_LEVEL_VALUE logLevel) |
| This function is call to initialize the library after it is loaded. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpCloseLib (void) |
| This function is call to close the library before unloading. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetShortDeviceIDTemplates (CLINT8 *pShortDeviceTemplates, CLUINT32 *pBufferSize) |
| This function returns a list of short device templates coded into a single string. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpProbeDevice (ISerial *pSerial, const CLINT8 *pDeviceIDTemplate, CLINT8 *pDeviceID, CLUINT32 *pBufferSize, CLUINT32 *pCookie, const CLUINT32 TimeOut) |
| Connects and identifies the device and returns a DeviceID. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetXMLIDs (ISerial *pSerial, const CLUINT32 Cookie, CLINT8 *pXMLIDs, CLUINT32 *pBufferSize, const CLUINT32 TimeOut) |
| This function returns a list of XML IDs coded into a single string. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetXMLDescription (ISerial *pSerial, const CLUINT32 Cookie, const CLINT8 *pXMLID, CLINT8 *pXMLBuffer, CLUINT32 *pBufferSize, const CLUINT32 TimeOut) |
| This function retrieves an XML file from the camera if possible. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpReadRegister (ISerial *pSerial, const CLUINT32 Cookie, const CLINT64 Address, CLINT8 *pBuffer, const CLINT64 BufferSize, const CLUINT32 TimeOut) |
| This function reads numBytes from the serial device referred to by serialRef. clSerialRead will return when numBytes are available at the serial port or when the serialTimeout period has passed. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpWriteRegister (ISerial *pSerial, const CLUINT32 Cookie, const CLINT64 Address, const CLINT8 *pBuffer, const CLINT64 BufferSize, const CLUINT32 TimeOut) |
| This function writes numBytes to the serial device referred to by serialRef. clSerialRead will return when numBytes are available at the serial port or when the serialTimeout period has passed. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpContinueWriteRegister (ISerial *pSerial, const CLUINT32 Cookie, const BOOL8 ContinueWaiting, const CLUINT32 TimeOut) |
| Calling This function is called after a write function returned CL_ERR_PENDING_WRITE. It either issues another wait for write cycle or cancels the write action. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetErrorText (CLINT32 errorCode, CLINT8 *errorText, CLUINT32 *errorTextSize, const CLUINT32 Cookie=0) |
| This function converts an error code to error text for display in a dialog box or in a standard I/O window. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpDisconnect (const CLUINT32 Cookie) |
| This function disconnects the DLL from the device. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetCLProtocolVersion (CLUINT32 *pVersionMajor, CLUINT32 *pVersionMinor) |
| This function returns the version of the CLProtocol interface version. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetParam (ISerial *pSerial, CLP_PARAMS param, const CLUINT32 Cookie, CLINT8 *pBuffer, const CLINT64 BufferSize, const CLUINT32 TimeOut) |
| This function is call to read a CLProtocol parameter value. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpSetParam (ISerial *pSerial, CLP_PARAMS param, const CLUINT32 Cookie, const CLINT8 *pBuffer, const CLINT64 BufferSize, const CLUINT32 TimeOut) |
| This function is call to change a CLProtocol parameter value. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpIsParamSupported (CLP_PARAMS param) |
| This function is call know if a parameter is supported by a CLProtocol. More... | |
| CLPROTOCOLEXPORT CLINT32 CLPROTOCOL | clpGetEventData (const CLUINT32 Cookie, CLINT8 *pBuffer, CLUINT32 *pBufferSize) |
| This function is call to get a possible event by a CLProtocol. More... | |
Detailed Description
Exported C functions for camera link protocol drivers.
Definition in file CLProtocol.h.
Macro Definition Documentation
◆ CLPROTOCOL
| #define CLPROTOCOL __attribute__((cdecl)) |
Definition at line 73 of file CLProtocol.h.
◆ CLPROTOCOL_DECL
| #define CLPROTOCOL_DECL __attribute__((visibility("default"))) |
Definition at line 64 of file CLProtocol.h.
◆ CLPROTOCOLEXPORT
| #define CLPROTOCOLEXPORT USER_EXTERN_C __attribute__((visibility("default"))) |
Definition at line 63 of file CLProtocol.h.
◆ USER_EXTERN_C
| #define USER_EXTERN_C |
Definition at line 45 of file CLProtocol.h.
◆ USER_EXTERN_C_END
| #define USER_EXTERN_C_END |
Definition at line 47 of file CLProtocol.h.
◆ USER_EXTERN_C_START
| #define USER_EXTERN_C_START |
Definition at line 46 of file CLProtocol.h.
Typedef Documentation
◆ clp_logger_t
| typedef void(CLPROTOCOL * clp_logger_t) (CLINT32 level, const char *stringFormat, va_list argptr) |
Definition at line 84 of file CLProtocol.h.
◆ clpLogCallback_t
| typedef USER_EXTERN_C_START struct clpLogCallback_t clpLogCallback_t |
Enumeration Type Documentation
◆ CLP_LOG_LEVEL_VALUE
| enum CLP_LOG_LEVEL_VALUE |
| Enumerator | |
|---|---|
| CLP_LOG_FATAL | |
| CLP_LOG_ALERT | |
| CLP_LOG_CRIT | |
| CLP_LOG_ERROR | |
| CLP_LOG_WARN | |
| CLP_LOG_NOTICE | |
| CLP_LOG_INFO | |
| CLP_LOG_DEBUG | |
| CLP_LOG_NOTSET | |
Definition at line 116 of file CLProtocol.h.
◆ CLP_PARAMS
| enum CLP_PARAMS |
Types of parameters to be accessed by clpGetParam/clpSetParam.
| Enumerator | |
|---|---|
| CLP_LOG_LEVEL | |
| CLP_LOG_CALLBACK | A 32-bit value that contains the current log level. This parameter expects a value represented by the CLP_LOG_LEVEL_VALUE constants. |
| CLP_STOP_PROBE_DEVICE | A 32-bit value that contains a clpLogCallback_t pointer to the logger function. |
| CLP_DEVICE_BAUDERATE | A 32-bit value that contains a signal to stop all running ProbeDevice. |
| CLP_DEVICE_SUPPORTED_BAUDERATES | A 32-bit value that contains the baudrate used to communicate with the device. This parameter expects a value represented by the CL_BAUDRATE_XXX constants. |
Definition at line 94 of file CLProtocol.h.