|
int | accessEthRead (long deviceID, int *errorCode, unsigned char *buffer, unsigned int bufferLength) |
|
int | accessEthWrite (long deviceID, int *errorCode, unsigned char *buffer, unsigned int bufferLength) |
|
int | accessUsbRead (long deviceID, int *errorCode, unsigned char *buffer, unsigned int bufferLength, unsigned char endpoint) |
|
int | accessUsbWrite (long deviceID, int *errorCode, unsigned char *buffer, unsigned int bufferLength, unsigned char endpoint) |
|
std::string | getStringDescriptor (long deviceID, int *errorCode, int index) |
|
|
static RawBusAPI * | getInstance () |
|
static void | shutdown () |
|
◆ accessEthRead()
int oceandirect::api::RawBusAPI::accessEthRead |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned char * |
buffer, |
|
|
unsigned int |
bufferLength |
|
) |
| |
Read raw bytes from the Ethernet port.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
buffer | the buffer to receive the bytes read from Ethernet. |
bufferLength | the length of the buffer. |
- Returns
- the number of bytes read into the buffer.
◆ accessEthWrite()
int oceandirect::api::RawBusAPI::accessEthWrite |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned char * |
buffer, |
|
|
unsigned int |
bufferLength |
|
) |
| |
Write raw bytes to the Ethernet port.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
buffer | the buffer containing the bytes to write to Ethernet. |
bufferLength | the length of the buffer. |
- Returns
- the number of bytes written to the Ethernet port.
◆ accessUsbRead()
int oceandirect::api::RawBusAPI::accessUsbRead |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned char * |
buffer, |
|
|
unsigned int |
bufferLength, |
|
|
unsigned char |
endpoint |
|
) |
| |
Read raw bytes from the USB port on a specfied endpoint.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
buffer | the buffer to receive the bytes read from USB. |
bufferLength | the length of the buffer. |
endpoint | the USB endpoint to read the raw bytes from. |
- Returns
- the number of bytes read into the buffer.
◆ accessUsbWrite()
int oceandirect::api::RawBusAPI::accessUsbWrite |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
unsigned char * |
buffer, |
|
|
unsigned int |
bufferLength, |
|
|
unsigned char |
endpoint |
|
) |
| |
Write raw bytes to the USB port on a specfied endpoint.
- Parameters
-
deviceID | the ID of the device returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE if the device does not exist; ERROR_FEATURE_NOT_FOUND the feature is not enabled on the specified device; ERROR_TRANSFER_ERROR the device protocol for the feature could not be found. |
buffer | the buffer containing the bytes to write to USB. |
bufferLength | the length of the buffer. |
endpoint | the USB endpoint to write the raw bytes to. |
- Returns
- the number of bytes written to the endpoint.
The documentation for this class was generated from the following file: