ControlAPI::ExoLightCommand_SetStrobeLighting Class Reference

Command to set the lighting (strobe mode) of a ExoLight device. More...

Inheritance diagram for ControlAPI::ExoLightCommand_SetStrobeLighting:

Public Attributes
int	strobeCurrentMilliAmps = 100
	DC Amperage to drive the led (milliamps) More...

int	strobePulseWidthMicroSec = 6
	pulse width micro seconds More...

int	strobeTriggerPeriodMicroSec = 1000
	trigger period in micro seconds More...

int	strobeTriggerDelayMicroSec = 6
	strobe trigger delay in microsecs More...

Public Attributes inherited from ControlAPI::ExoLightCommand_SetLighting
bool	outputEnabled = true

Public Attributes inherited from ControlAPI::DeviceCommandPackage
bool	continuous = false
	set to true if command is a continous (async/time consuming) command or if it is desired that the command run indefinitely. (tracking command etc) set to false if the command should terminate once a target is reached.

Public Attributes inherited from ControlAPI::ApiCommandPackage
std::string	alias
	user definable unique alias for this command package

Additional Inherited Members
Public Member Functions inherited from ControlAPI::DeviceCommandPackage
virtual std::string	className () override

virtual std::shared_ptr< DeviceCommandPackage >	createSharedPtr ()

virtual void	cloneFrom (DeviceCommandPackage *other)
	clone from another device package - should be implemented for custom types. More...

virtual DeviceCommandPackage *	prepareUpdatePackage ()
	Creates/Returns the DeviceCommandPackage to be used for updates to a running command. Update package will be a shallow copy of this package. It is expected that markUpdatePackageReady() be called after update package is altered. More...

void	markUpdatePackageReady ()
	signal the update package is ready to be used in running commands. prepareUpdatePackage() should be called first.

Static Public Member Functions inherited from ControlAPI::DeviceCommandPackage
static std::string	staticClassName ()

Static Public Member Functions inherited from ControlAPI::ApiCommandPackage
static std::string	staticClassName ()

Command to set the lighting (strobe mode) of a ExoLight device.

int ControlAPI::ExoLightCommand_SetStrobeLighting::strobeCurrentMilliAmps = 100

DC Amperage to drive the led (milliamps)

int ControlAPI::ExoLightCommand_SetStrobeLighting::strobePulseWidthMicroSec = 6

pulse width micro seconds

int ControlAPI::ExoLightCommand_SetStrobeLighting::strobeTriggerDelayMicroSec = 6

strobe trigger delay in microsecs

int ControlAPI::ExoLightCommand_SetStrobeLighting::strobeTriggerPeriodMicroSec = 1000

trigger period in micro seconds

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