◆ getBaudRate()
virtual int oceandirect::api::SerialPortAPI::getBaudRate |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Get the baud rate of the serial port.
- See also
- setBaudRate()
- 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. |
- Returns
- the baud rate of the serial port.
◆ getSerialCommThresholdMode()
virtual std::uint8_t oceandirect::api::SerialPortAPI::getSerialCommThresholdMode |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Get the threshold mode of serial communication. The valid supported values are 0x10(RS-232) and 0x20(UART).
- See also
- setSerialCommThresholdMode()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE the specified device ID could not be found; ERROR_TRANSFER_ERROR if an error transferring the command to the device occurred; ERROR_COMMAND_NOT_SUPPORTED if this operation is not supported by the device. |
- Returns
- The threshold mode either 0x10 or 0x20.
◆ saveSettingsToFlash()
virtual void oceandirect::api::SerialPortAPI::saveSettingsToFlash |
( |
long |
deviceID, |
|
|
int * |
errorCode |
|
) |
| |
|
virtual |
Save settings to flash memory.
- 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. |
◆ setBaudRate()
virtual void oceandirect::api::SerialPortAPI::setBaudRate |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
int |
baudRate |
|
) |
| |
|
virtual |
Set the baud rate of the serial port.
- See also
- getBaudRate()
- 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. |
baudRate | the desired baud rate of the serial port. |
◆ setSerialCommThresholdMode()
virtual void oceandirect::api::SerialPortAPI::setSerialCommThresholdMode |
( |
long |
deviceID, |
|
|
int * |
errorCode, |
|
|
std::uint8_t |
thresholdMode |
|
) |
| |
|
virtual |
Set the threshold mode of serial communication. The valid supported values are 0x10(RS-232) and 0x20(UART).
- See also
- getSerialCommThresholdMode()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
thresholdMode | The threshold mode either 0x10 or 0x20. |
errorCode | a code indicating the result of the operation: ERROR_SUCCESS on success; ERROR_NO_DEVICE the specified device ID could not be found; ERROR_TRANSFER_ERROR if an error transferring the command to the device occurred; ERROR_COMMAND_NOT_SUPPORTED if this operation is not supported by the device. |
The documentation for this class was generated from the following file: