OceanDirectLighthouse 3.1.3
OceanDirect Lighthouse C++/C API
oceandirect::api::LHLedAPI Class Reference

#include <LHLedAPI.h>

Public Member Functions

virtual ~LHLedAPI ()=default
 
virtual lh_enable_state_t getLedState (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void setLedState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state)
 

Constructor & Destructor Documentation

◆ ~LHLedAPI()

virtual oceandirect::api::LHLedAPI::~LHLedAPI ( )
virtualdefault

Member Function Documentation

◆ getLedState()

virtual lh_enable_state_t oceandirect::api::LHLedAPI::getLedState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getLedState Return the LED state, "on" or "off".

See also
setLedState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
Returns
"on" if the LED is turned on, "off" if the LED is turned off or on error.

◆ setLedState()

virtual void oceandirect::api::LHLedAPI::setLedState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_enable_state_t state )
virtual

.setLedState Turn the LED on or off.

Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to turn the LED on, "off" to turn the LED off.

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