NetOceanDirectLighthouse 3.1.3
OceanDirect Lighthouse .NET API
NetLighthouse::NetLighthouseSerialPort Class Reference

#include <NetLighthouseSerialPort.h>

Inherits ManagedObject.

Public Member Functions

virtual ~NetLighthouseSerialPort ()
 
virtual net_lh_baud_rate_t getBaudRate (unsigned int deviceID, int %errorCode)
 
virtual unsigned char getSerialCommThresholdMode (unsigned int deviceID, int% errorCode)
 
virtual void saveSettingsToFlash (unsigned int deviceID, int %errorCode)
 
virtual void setBaudRate (unsigned int deviceID, int% errorCode, net_lh_baud_rate_t baudRate)
 
virtual void setSerialCommThresholdMode (unsigned int deviceID, int% errorCode, unsigned char thresholdMode)
 

Static Public Member Functions

static NetLighthouseSerialPort getInstance ()
 

Protected Member Functions

 NetLighthouseSerialPort ()
 

Static Protected Attributes

static NetLighthouseSerialPort serial
 

Constructor & Destructor Documentation

◆ NetLighthouseSerialPort()

NetLighthouseSerialPort::NetLighthouseSerialPort ( )
protected

◆ ~NetLighthouseSerialPort()

virtual NetLighthouse::NetLighthouseSerialPort::~NetLighthouseSerialPort ( )
inlinevirtual

Member Function Documentation

◆ getBaudRate()

net_lh_baud_rate_t NetLighthouseSerialPort::getBaudRate ( unsigned int deviceID,
int % errorCode )
virtual

.getBaudRate Return the current baud rate of the serial port.

See also
setBaudRate()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
the current baud rate or 0 on error.

◆ getInstance()

NetLighthouseSerialPort NetLighthouseSerialPort::getInstance ( )
static

◆ getSerialCommThresholdMode()

unsigned char NetLighthouseSerialPort::getSerialCommThresholdMode ( unsigned int deviceID,
int% errorCode )
virtual

.getSerialCommThresholdMode Get the threshold mode of serial communication. The valid supported values are 0x10(RS-232) and 0x20(UART).

See also
setSerialCommThresholdMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
The threshold mode either 0x10 or 0x20.

◆ saveSettingsToFlash()

void NetLighthouseSerialPort::saveSettingsToFlash ( unsigned int deviceID,
int % errorCode )
virtual

.saveSettingsToFlash Save the current serial port settings to persistent memory.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.

◆ setBaudRate()

void NetLighthouseSerialPort::setBaudRate ( unsigned int deviceID,
int% errorCode,
net_lh_baud_rate_t baudRate )
virtual

.setBaudRate Set the current baud rate of the serial port.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
baudRatethe 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()

void NetLighthouseSerialPort::setSerialCommThresholdMode ( unsigned int deviceID,
int% errorCode,
unsigned char thresholdMode )
virtual

.setSerialCommThresholdMode Set the threshold mode of serial communication. The valid supported values are 0x10(RS-232) and 0x20(UART).

See also
getSerialCommThresholdMode()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
thresholdModeThe threshold mode either 0x10 or 0x20.

Member Data Documentation

◆ serial

NetLighthouseSerialPort NetLighthouse::NetLighthouseSerialPort::serial
staticprotected

The documentation for this class was generated from the following files: