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

#include <LHLampAPI.h>

Public Member Functions

virtual ~LHLampAPI ()=default
 
virtual lh_enable_state_t getLampState (lh_device_id_t deviceID, lh_error_code_t *errorCode)
 
virtual void setLampState (lh_device_id_t deviceID, lh_error_code_t *errorCode, lh_enable_state_t state)
 

Constructor & Destructor Documentation

◆ ~LHLampAPI()

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

Member Function Documentation

◆ getLampState()

virtual lh_enable_state_t oceandirect::api::LHLampAPI::getLampState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode )
virtual

.getLampState Return the lamp enable pin state.

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

◆ setLampState()

virtual void oceandirect::api::LHLampAPI::setLampState ( lh_device_id_t deviceID,
lh_error_code_t * errorCode,
lh_enable_state_t state )
virtual

.setLampState Set the lamp enable pin to turn the connected light source on or off.

See also
getLampState()
Parameters
deviceIDthe identifier of the device as returned by getDeviceIDs.
errorCodesee LHErrorCode.
state"on" to turn the light source on, "off" to turn the light source off.

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