#include <LHSerialPortAPI.h>
◆ ~LHSerialPortAPI()
virtual oceandirect::api::LHSerialPortAPI::~LHSerialPortAPI |
( |
| ) |
|
|
virtualdefault |
◆ getBaudRate()
.getBaudRate Return the current baud rate of the serial port.
- See also
- setBaudRate()
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
- Returns
- the current baud rate or 0 on error.
◆ getSerialCommThresholdMode()
.getSerialCommThresholdMode 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 | see LHErrorCode. |
- Returns
- The threshold mode either 0x10 or 0x20.
◆ saveSettingsToFlash()
.saveSettingsToFlash Save the current serial port settings to persistent memory.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
◆ setBaudRate()
.setBaudRate Set the current baud rate of the serial port.
- Parameters
-
deviceID | the identifier of the device as returned by getDeviceIDs. |
errorCode | see LHErrorCode. |
baudRate | the desired baud rate. An invalid argument error code will be returned if this is not one of: lh_baud_rate_t::B300 lh_baud_rate_t::B600 lh_baud_rate_t::B1200 lh_baud_rate_t::B2400 lh_baud_rate_t::B9600 lh_baud_rate_t::B14400 lh_baud_rate_t::B19200 lh_baud_rate_t::B38400 lh_baud_rate_t::B57600 lh_baud_rate_t::B115200 |
◆ setSerialCommThresholdMode()
.setSerialCommThresholdMode 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. |
errorCode | see LHErrorCode. |
thresholdMode | The threshold mode either 0x10 or 0x20. |
The documentation for this class was generated from the following file: