OPN Framework |
Header file containing the API for the OPN framework.
Version: EGFS0038 (0.0.3.8)
This API controls the OPN 2001/2003 driver, a user-space driver in the form of a dynamically linked library. To include a framework in your Xcode project, choose Project > Add to Project and select the framwork directory. You must include header files in your code using the #include directive. If you are working in Objective-C, you may use the #import directive instead of the #include directive. #import <OPN/opn_interface.h>
The libopn_driver library utilizes the Carbon Event Manager to signal client code of three possible events: 1) the OPN has been removed, 2) the OPN has been inserted, or 3) the OPN has data. The particulars of each event (its class and kind, which together, compose its type) can be accessed via API functions defined in this file. However, it is the responsibility of any client code utilizing this library to implement event handler functions, install these functions, and run the application event loop. Examples of how to do this are illustrated in the project "opn_test." More information about the Carbon Event Manager, and how to use it, can be found in the Apple Developer documentation. See the Carbon Event Manager Programming Guide for details.
Note that this library is dependent upon the Carbon, CoreFoundation, and IOKit frameworks. These are part of any normal OS X installation, and though it's probably impossible for OS X to run without them, it's noted here for completeness. This library should run on both x86 and PPC flavors of OS X.
This driver should only be used with OPN2001 firmware version RBBV0120 and later, or OPN2003 firmware version RBFV0212 and later.
Disable the generation of the device-has-data event when data is available in the device. ( Not yet implemented as of version EGFS0038 on OPN2003 cdc driver mode. To use this function, OPN2003 have to be usb driver mode. )
Enable the generation of the device-has-data event when data is available in the device. ( Not yet implemented as of version EGFS0038 on OPN2003 cdc driver mode. To use this function, OPN2003 have to be usb driver mode. )
Expected size of the buffer holding the Device ID, including the trailing null character.
Expected size of the buffer holding the driver version, including the trailing null character.
Expected size of the buffer holding the Software Version, including the trailing null character.
Expected size of the buffer holding time data for getTimeCmd() and setTimeCmd().
Retrieves the data encoding of the barcodes read by the device.
Looks up and retrieves a symbology name from a symbology ID.
Retrieves the device ID of the device.
Retrieves a value used to signify the class of events generated by the library.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-has-data event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-insertion event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-removal event.
Retrieves a value used to signify the class of events generated by the library.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-has-data event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-insertion event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-removal event.
Retrieves the version of this library.
Retrieves the protocol version of the device.
Retrieves the connected device classs.
Retrieves the connected device name.
Retrieves the retry count for the interrogate command.
Retrieves a value indicating whether the barcodes read by the device have a timestamp appended to them, indicating when they were read.
Retrieves the software version of the device.
Retrieves the system status of the device.
Sets the retry count for the interrogate command.
Return value of a function that indicates there was a bad parameter to the function.
Return value of a function that indicates that the CRC check on written or read data failed.
Return value of a function that indicates there was a communication error.
Return value of a function that indicates that some error occurred.
Return value of a function that indicates that the command sent to the driver was not defined.
Return value of a function that indicates that the function encountered a value it did not expect.
Return value of a function that indicates the driver instance was in a state that didn't permit it to carry out the function.
Return value of a function that executes with no errors.
Retrieves a read barcode.
Indicates whether or not the device has barcode data.
Reads barcodes from the device.
Instantiates and initializes the libopn_driver library.
Cleans up and destroys the instance of the libopn_driver library.
Converts a 4-byte timestamp buffer into a formatted date/time string.
Erases stored barcodes from the device.
Retrieves the associated value of a parameter.
Gets the RTC (real-time clock) timestamp from the device.
Queries the device for its Device ID, Software Version, Protocol Version, and System Status.
Shuts down the device.
Restores the device to a default state.
Sets the associated value of a parameter.
Sets the RTC (real-time clock) time of the device.
Erases stored barcodes from the device.
Instantiates and initializes the libopn_driver library.
Cleans up and destroys the instance of the libopn_driver library.
Disable the generation of the device-has-data event when data is available in the device.( Not yet implemented as of version EGFS0038 on OPN2003 cdc driver mode. To use this function, OPN2003 have to be usb driver mode. )
Enable the generation of the device-has-data event when data is available in the device. ( Not yet implemented as of version EGFS0038 on OPN2003 cdc driver mode. To use this function, OPN2003 have to be usb driver mode. )
Retrieves the data encoding of the barcodes read by the device.
Retrieves a read barcode.
Looks up and retrieves a symbology name from a symbology ID.
Retrieves the device ID of the device.
Retrieves a value used to signify the class of events generated by the library.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-has-data event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-insertion event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-removal event.
Retrieves a value used to signify the class of events generated by the library.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-has-data event. ( Not yet implemented as of version EGFS0038 on OPN2003 cdc driver mode. To use this function, OPN2003 have to be usb driver mode. )
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-insertion event.
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-removal event.
Retrieves the version of this library.
Retrieves the associated value of a parameter.
Retrieves the protocol version of the device.
Retrieves the connected device classs.
Retrieves the connected device name.
Retrieves the retry count for the interrogate command.
Retrieves a value indicating whether the barcodes read by the device have a timestamp appended to them, indicating when they were read.
Retrieves the software version of the device.
Retrieves the system status of the device.
Gets the RTC (real-time clock) timestamp from the device.
Queries the device for its Device ID, Software Version, Protocol Version, and System Status.
Indicates whether or not the device has barcode data.
Shuts down the device.
Reads barcodes from the device.
Restores the device to a default state.
Sets the associated value of a parameter.
Sets the retry count for the interrogate command.
Sets the RTC (real-time clock) time of the device.
Converts a 4-byte timestamp buffer into a formatted date/time string.
clearDataCmd |
Erases stored barcodes from the device.
extern "C" SInt32 clearDataCmd( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
A status code. See the status code defines for the possible returned codes.
If you read the barcodes stored in the device, and don't call this function to clear them, then on the next read, the previously read barcodes will be read again, because they haven't been erased.
CreateOPNInterface |
Instantiates and initializes the libopn_driver library.
extern "C" OPNInterface CreateOPNInterface();
An opaque pointer of type OPNInterface, needed to call other functions.
This function must be called before all others, except for getEventClass, getEventKindInsert, getEventKindRemove, and getEventKindDataAvailable.
DestroyOPNInterface |
Cleans up and destroys the instance of the libopn_driver library.
extern "C" void DestroyOPNInterface( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
This function should be called when the interface to the device is no longer necessary. For example, in a client application's cleanup code.
disablePolling |
Disable the generation of the device-has-data event when data is available in the device.
extern "C" SInt32 disablePolling( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
GENERAL_ERROR on error, or STATUS_OK on success.
Calling this function stop the generation of the device-has-data event.
enablePolling |
Enable the generation of the device-has-data event when data is available in the device.
extern "C" SInt32 enablePolling( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
GENERAL_ERROR on error, or STATUS_OK on success.
Calling this function will poll the device intermittently for whether or not it has data. If it does, it will generate the device-has-data event, which must be handled by client code.
getASCIIMode |
Retrieves the data encoding of the barcodes read by the device.
extern "C" SInt32 getASCIIMode( OPNInterface interface, bool *AM);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
AMA pointer to a boolean variable that will contain, on return, true if the data encoding is ASCII, and false if it's binary.
BAD_PARAM if AM is NULL, or STATUS_OK on success.
readData must be called before this function returns any meaningful data.
getBarcode |
Retrieves a read barcode.
extern "C" SInt32 getBarcode( OPNInterface interface, char *BarcodeData, UInt32 BarcodeNumber, UInt32 *BarcodeDataLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
BarcodeDataA pointer to a buffer that will contain the data of the read barcode.
BarcodeNumberA number, within the domain of 0 <= n <= N (where N is the total number of read barcodes, got by readData), signifying the barcode to be returned in BarcodeData.
BarcodeDataLengthInput: a pointer to a variable holding the size of BarcodeData. Output: the pointer is updated to hold the number of bytes read into BarcodeData.
A status code. See the status code defines for the possible returned codes.
Probably best used in a loop designed to retrieve every read barcode.
Note that calling this function does not erase the retrieved barcode from the driver's internal storage of read barcodes.
The first byte of the returned barcode data is the barcode's length (the length doesn't include the first byte). The second byte is the barcode symbology, which can be passed to getCodeType to retrieve the symbology name. The last four bytes, if the RTC timestamp is set to be appended to each barcode the device reads, is the timestamp of when the barcode was read (which can be passed to timeStamp2String to return a formatted date/time string). All of the bytes between the barcode symbology byte, and (potentially) the RTC timestamp bytes, compose the actual barcode data.
getCodeType |
Looks up and retrieves a symbology name from a symbology ID.
extern "C" SInt32 getCodeType( OPNInterface interface, char *CodeName, UInt32 CodeNameLength, UInt8 CodeID);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
CodeNameA pointer to a buffer that will contain the symbology name.
CodeNameLengthThe size of the CodeName buffer.
CodeIDThe symbology ID used to look up the symbology name.
BAD_PARAM if CodeName is NULL; GENERAL_ERROR on an error; or STATUS_OK on success.
The driver must be loaded and CreateOPNInterface called before this function can be called.
getDeviceID |
Retrieves the device ID of the device.
extern "C" SInt32 getDeviceID( OPNInterface interface, char *DevID, UInt32 DevIDLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
DevIDA pointer to a buffer that will contain the data composing the device ID.
DevIDLengthThe size of the DevID buffer.
BAD_PARAM if DevID is NULL or DevIDLength is less than DEVICE_ID_SIZE; STATUS_OK on success.
One of the command functions must be called before this function returns any meaningful data.
getUSBEventClass |
Retrieves a value used to signify the class of events generated by the library.
extern "C" UInt32 getUSBEventClass();
An integer value signifying the event class for library-generated events.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event class returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the insertion, removal, or device-has-data events.
getUSBEventKindDataAvailable |
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-has-data event.
extern "C" UInt32 getUSBEventKindDataAvailable();
An integer value signifying the event kind for a library-generated device-has-data event.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event kind returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the device-has-data event.
getUSBEventKindInsert |
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-insertion event.
extern "C" UInt32 getUSBEventKindInsert();
An integer value signifying the event kind for a library-generated insertion event.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event kind returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the insertion event.
getUSBEventKindRemove |
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-removal event.
extern "C" UInt32 getUSBEventKindRemove();
An integer value signifying the event kind for a library-generated removal event.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event kind returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the removal event.
getCDCEventClass |
Retrieves a value used to signify the class of events generated by the library.
extern "C" UInt32 getCDCEventClass();
An integer value signifying the event class for library-generated events.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event class returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the insertion, removal, or device-has-data events.
getCDCEventKindDataAvailable |
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-has-data event.
extern "C" UInt32 getCDCEventKindDataAvailable();
An integer value signifying the event kind for a library-generated device-has-data event.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event kind returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the device-has-data event.
getCDCEventKindInsert |
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-insertion event.
extern "C" UInt32 getCDCEventKindInsert();
An integer value signifying the event kind for a library-generated insertion event.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event kind returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the insertion event.
getCDCEventKindRemove |
Retrieves a value used to specify what kind of event, within a class of events, a particular event is. In this case, a library-generated device-removal event.
extern "C" UInt32 getCDCEventKindRemove();
An integer value signifying the event kind for a library-generated removal event.
This function may be called before CreateOPNInterface.
An event type is made up of an event class and an event kind. Event types are essentially how events get matched to event handlers. The event kind returned by this function is defined by the library, meaning that this function must be utilized when installing and/or handling the removal event.
getLibraryVersion |
Retrieves the version of this library.
extern "C" SInt32 getLibraryVersion( OPNInterface interface, char *VersionString, UInt32 VersionStringLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
VersionStringA pointer to a buffer that will contain the driver version string.
VersionStringLengthThe size of the VersionString buffer.
BAD_PARAM if VersionString is NULL or VersionStringLength is less than LIBRARY_VERSION_SIZE; STATUS_OK on success.
The driver version string is 8 characters (e.g. RABS0030).
getConnectedDeviceClass |
Retrieves the connected device classs.
extern "C" SInt32 getConnectedDeviceClass( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
COMPOSITE_CLASS if composite device is connected; COMMUNICATION_CLASS if communication device is connected; COMMUNICATION_ERROR if no device is connected.
getConnectedDeviceName |
Retrieves the connected device name.
extern "C" SInt32 getConnectedDeviceName( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
OPN_2001 if OPN 2001 is connected; OPN_2003 if OPN 2003 device is connected; COMMUNICATION_ERROR if no device is connected.
getParamCmd |
Retrieves the associated value of a parameter.
extern "C" SInt32 getParamCmd( OPNInterface interface, UInt8 Param, char *ParamValue, UInt32 *ParamValueLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
ParamA value signifying the parameter to obtain the associated value for.
ParamValueA pointer to a buffer that will, on return, hold the associated value of the parameter.
ParamValueLengthInput: a pointer to a variable holding the size of ParamValue. Output: the pointer is updated to hold the number of bytes read into ParamValue.
A status code. See the status code defines for the possible returned codes.
getProtocolVersion |
Retrieves the protocol version of the device.
extern "C" SInt32 getProtocolVersion( OPNInterface interface, UInt32 *PV);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
PVA pointer to an integer variable that will contain, on return, the protocol version.
BAD_PARAM if PV is NULL, or STATUS_OK on success.
One of the command functions must be called before this function returns any meaningful data.
getRetryCount |
Retrieves the retry count for the interrogate command.
extern "C" SInt32 getRetryCount( OPNInterface interface, UInt32 *Retries);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
RetriesA pointer to an integer variable that will contain, on return, the retry count.
BAD_PARAM if Retries is NULL, or STATUS_OK on success.
The interrogate command will attempt to execute up to the number of times returned in Retries if it doesn't execute successfully before then.
getRTCMode |
Retrieves a value indicating whether the barcodes read by the device have a timestamp appended to them, indicating when they were read.
extern "C" SInt32 getRTCMode( OPNInterface interface, bool *RTC);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
RTCA pointer to a boolean variable that will contain, on return, true if the timestamp data is appended, and false if not.
BAD_PARAM if RTC is NULL, or STATUS_OK on success.
readData must be called before this function returns any meaningful data.
getSoftwareVersion |
Retrieves the software version of the device.
extern "C" SInt32 getSoftwareVersion( OPNInterface interface, char *SV, UInt32 SVLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
SVA pointer to a buffer that will contain the data composing the software version.
SVLengthThe size of the SV buffer.
BAD_PARAM if SV is NULL or SVLength is less than SOFTWARE_VERSION_SIZE; STATUS_OK on success.
One of the command functions must be called before this function returns any meaningful data.
getSystemStatus |
Retrieves the system status of the device.
extern "C" SInt32 getSystemStatus( OPNInterface interface, UInt32 *SysStat);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
SysStatA pointer to an integer variable that will contain, on return, the system status.
BAD_PARAM if SysStat is NULL, or STATUS_OK on success.
One of the command functions must be called before this function returns any meaningful data.
getTimeCmd |
Gets the RTC (real-time clock) timestamp from the device.
extern "C" SInt32 getTimeCmd( OPNInterface interface, UInt8 *TimeBuffer, UInt32 *BufferLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
TimeBufferA pointer to a byte buffer to hold the timestamp. The buffer should be of size TIME_BUFFER_SIZE.
BufferLengthInput: a pointer to a variable holding the size of TimeBuffer. Output: the pointer is updated to hold the number of bytes read into TimeBuffer.
A status code. See the status code defines for the possible returned codes.
TimeBuffer should be passed to the timeStamp2String function in order to convert the TimeBuffer into a human-readable date and time string.
interrogateCmd |
Queries the device for its Device ID, Software Version, Protocol Version, and System Status.
extern "C" SInt32 interrogateCmd( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
A status code. See the status code defines for the possible returned codes.
After this function has been called, the getDeviceID function, the getSoftwareVersion function, the getProtocolVersion function, and the getSystemStatus function will return appropriate values in their passed-in buffers.
isDataAvailable |
Indicates whether or not the device has barcode data.
extern "C" SInt32 isDataAvailable( OPNInterface interface, bool *DataAvailable);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
DataAvailableA pointer to a boolean that will, on return, be true if there is barcode data to be read, and false if there is not.
A status code. See the status code defines for the possible returned codes.
powerDownCmd |
Shuts down the device.
extern "C" SInt32 powerDownCmd( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
A status code. See the status code defines for the possible returned codes.
The usefulness or relevance of this function is dubious.
readData |
Reads barcodes from the device.
extern "C" SInt32 readData( OPNInterface interface, UInt32 *NumberOfCodes);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
NumberOfCodesA pointer to a value that will, on return, contain the number of barcodes that have been read from the device.
A status code. See the status code defines for the possible returned codes.
This function must be called to read barcodes from the device. However, the barcodes are only returned to client code via getBarcode.
Note that the driver's internal storage of read barcodes is erased on every successful call to this function. The barcodes are only erased from the device, however, when clearDataCmd is called.
setDefaultsCmd |
Restores the device to a default state.
extern "C" SInt32 setDefaultsCmd( OPNInterface interface);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
A status code. See the status code defines for the possible returned codes.
This function will reset any parameters that have been changed via setParamCmd.
setParamCmd |
Sets the associated value of a parameter.
extern "C" SInt32 setParamCmd( OPNInterface interface, UInt8 Param, char *ParamValue, UInt32 ParamValueLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
ParamA value signifying the parameter to set the associated value for.
ParamValueA pointer to a buffer that holds the new associated value of the parameter.
ParamValueLengthThe size of ParamValue.
A status code. See the status code defines for the possible returned codes.
setRetryCount |
Sets the retry count for the interrogate command.
extern "C" SInt32 setRetryCount( OPNInterface interface, UInt32 Retries);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
RetriesThe new value for the retry count.
BAD_PARAM if Retries is less than 0 or greater than 9, or STATUS_OK on success.
The interrogate command will attempt to execute up to the number of times specified in Retries if it doesn't execute successfully before then.
setTimeCmd |
Sets the RTC (real-time clock) time of the device.
extern "C" SInt32 setTimeCmd( OPNInterface interface, UInt8 *TimeBuffer, UInt32 BufferLength);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
TimeBufferA pointer to a byte buffer to holding the timestamp to set. The buffer should be of size TIME_BUFFER_SIZE.
BufferLengthThe size of TimeBuffer.
A status code. See the status code defines for the possible returned codes.
timeStamp2String |
Converts a 4-byte timestamp buffer into a formatted date/time string.
extern "C" SInt32 timeStamp2String( OPNInterface interface, char *TimeString, UInt32 TimeStringLength, UInt8 *TimeStamp);
interfaceThe OPNInterface opaque pointer returned by CreateOPNInterface().
TimeStringA pointer to a buffer to hold the formatted date/time string.
TimeStringLengthThe size of the TimeString buffer.
TimeStampA 4-byte buffer containing an RTC timestamp, such as the one returned via getTimeCmd.
A status code. See the status code defines for the possible returned codes.
Make sure the size of the TimeString buffer is big enough to fit any formatted date/time string. A size of 31 (NUL terminator included) ought to do.
Return value of a function that indicates there was a bad parameter to the function.
Return value of a function that indicates that the CRC check on written or read data failed.
Return value of a function that indicates there was a communication error.
Expected size of the buffer holding the Device ID, including the trailing null character.
Return value of a function that indicates that some error occurred.
Return value of a function that indicates that the command sent to the driver was not defined.
Expected size of the buffer holding the driver version, including the trailing null character.
Return value of a function that indicates that the function encountered a value it did not expect.
Return value of a function that indicates the driver instance was in a state that didn't permit it to carry out the function.
Expected size of the buffer holding the Software Version, including the trailing null character.
Return value of a function that executes with no errors.
Expected size of the buffer holding time data for getTimeCmd() and setTimeCmd().
Return value of a function that indicates composite device is connected.
Return value of a function that indicates communication device(CDC) is connected.
Return value of a function that indicates OPN2001 is connected.
Return value of a function that indicates OPN2003 is connected.
BAD_PARAM |
Return value of a function that indicates there was a bad parameter to the function.
#define BAD_PARAM -2
COMMAND_LRC_ERROR |
Return value of a function that indicates that the CRC check on written or read data failed.
#define COMMAND_LRC_ERROR -7
COMMUNICATIONS_ERROR |
Return value of a function that indicates there was a communication error.
#define COMMUNICATIONS_ERROR -1
DEVICE_ID_SIZE |
Expected size of the buffer holding the Device ID, including the trailing null character.
#define DEVICE_ID_SIZE 9
GENERAL_ERROR |
Return value of a function that indicates that some error occurred.
#define GENERAL_ERROR -9
INVALID_COMMAND_NUMBER |
Return value of a function that indicates that the command sent to the driver was not defined.
#define INVALID_COMMAND_NUMBER -4
LIBRARY_VERSION_SIZE |
Expected size of the buffer holding the driver version, including the trailing null character.
#define LIBRARY_VERSION_SIZE 9
RECEIVED_CHARACTER_ERROR |
Return value of a function that indicates that the function encountered a value it did not expect.
#define RECEIVED_CHARACTER_ERROR -8
SETUP_ERROR |
Return value of a function that indicates the driver instance was in a state that didn't permit it to carry out the function.
#define SETUP_ERROR -3
SOFTWARE_VERSION_SIZE |
Expected size of the buffer holding the Software Version, including the trailing null character.
#define SOFTWARE_VERSION_SIZE 9
STATUS_OK |
Return value of a function that executes with no errors.
#define STATUS_OK 0
TIME_BUFFER_SIZE |
Expected size of the buffer holding time data for getTimeCmd() and setTimeCmd().
#define TIME_BUFFER_SIZE 6
COMPOSITE_CLASS |
Return value of a function that indicates communication device(CDC) is connected.
#define COMPOSITE_CLASS 20
COMMUNICATION_CLASS |
Return value of a function that indicates communication device(CDC) is connected.
#define COMMUNICATION_CLASS 21
OPN_2001 |
Return value of a function that indicates OPN2001 is connected.
#define OPN_2001 2001
OPN_2003 |
Return value of a function that indicates OPN2003 is connected.
#define OPN_2003 2003
© 2011 Opticon Inc. Last Updated: Wednesday, June 9, 2011