Functions
EXTERN_C CCAUXDLL_API FRONTLEDHANDLE CCAUXDLL_CALLING_CONV	GetFrontLED (void)

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV	FrontLED_release (FRONTLEDHANDLE)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getSignal (FRONTLEDHANDLE, float64_t frequency, uint8_t dutyCycle)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getOnTime (FRONTLEDHANDLE, uint8_t *onTime)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getOffTime (FRONTLEDHANDLE, uint8_t *offTime)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getIdleTime (FRONTLEDHANDLE, uint8_t *idleTime)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getNrOfPulses (FRONTLEDHANDLE, uint8_t *nrOfPulses)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getColor (FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t *blue)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getStandardColor (FRONTLEDHANDLE, CCAuxColor *color)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getEnabledDuringStartup (FRONTLEDHANDLE, CCStatus *status)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setSignal (FRONTLEDHANDLE, float64_t frequency, uint8_t dutyCycle)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setOnTime (FRONTLEDHANDLE, uint8_t onTime)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setOffTime (FRONTLEDHANDLE, uint8_t offTime)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setIdleTime (FRONTLEDHANDLE, uint8_t idleTime)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setNrOfPulses (FRONTLEDHANDLE, uint8_t nrOfPulses)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setColor (FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setStandardColor (FRONTLEDHANDLE, CCAuxColor color)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setOff (FRONTLEDHANDLE)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setEnabledDuringStartup (FRONTLEDHANDLE, CCStatus status)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getBootLEDConfig (FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue, float32_t frequency, uint8_t *dutyCycle)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setBootLEDConfig (FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue, float32_t frequency, uint8_t dutyCycle)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_getPostBootLEDConfig (FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue, float32_t frequency, uint8_t *dutyCycle)

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV	FrontLED_setPostBootLEDConfig (FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue, float32_t frequency, uint8_t dutyCycle)

Detailed Description

Functions in the FrontLED class

Function Documentation

◆ FrontLED_getBootLEDConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getBootLEDConfig	(	FRONTLEDHANDLE	,
		uint8_t *	red,
		uint8_t *	green,
		uint8_t *	blue,
		float32_t *	frequency,
		uint8_t *	dutyCycle
	)

Get LED configuration during system boot. The behavior of the LED in terms of color (intensity) and blink frequency may be configured during system boot. Note that FrontLED_setEnabledDuringStartup overrides these settings, it has to be enabled for these settings to apply. Also note that the frequency limitations mentioned in the description of FrontLED_setSignal also apply here.

Supported Platform(s): VS, VI2

Parameters

red	Red color intensity 0-0x0F.
green	Green color intensity 0-0x0F.
blue	Blue color intensity 0-0x0F.
frequency	LED blink frequency (0.2-50 Hz).
dutyCycle	LED on duty cycle (0-100%).

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getColor()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getColor	(	FRONTLEDHANDLE	,
		uint8_t *	red,
		uint8_t *	green,
		uint8_t *	blue
	)

Get front LED color mix.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

On the VC, VA platforms - the blue parameter gets the button backlight intensity (0-15)

Parameters

red	Red color intensity 0-0x0F.
green	Green color intensity 0-0x0F.
blue	Blue color intensity 0-0x0F.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = FrontLED_getColor(pFrontLED, &red, &green, &blue);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function getColor: " << GetErrorStringA(err) << endl;
  }

◆ FrontLED_getEnabledDuringStartup()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getEnabledDuringStartup	(	FRONTLEDHANDLE	,
		CCStatus *	status
	)

Is the front LED enabled during startup? If enabled, the LED will blink yellow to indicate startup progress. It will turn green once the OS has started.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

status LED Enabled or Disabled during startup.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getIdleTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getIdleTime	(	FRONTLEDHANDLE	,
		uint8_t *	idleTime
	)

Get front LED idle time.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

idleTime Time in 100ms increments.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getNrOfPulses()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getNrOfPulses	(	FRONTLEDHANDLE	,
		uint8_t *	nrOfPulses
	)

Get number of pulses during a blink sequence.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

nrOfPulses Number of pulses.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getOffTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getOffTime	(	FRONTLEDHANDLE	,
		uint8_t *	offTime
	)

Get front LED off time.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

offTime Time in 10ms increments.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getOnTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getOnTime	(	FRONTLEDHANDLE	,
		uint8_t *	onTime
	)

Get front LED on time.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

onTime Time in 10ms increments. 0 = off

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getPostBootLEDConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getPostBootLEDConfig	(	FRONTLEDHANDLE	,
		uint8_t *	red,
		uint8_t *	green,
		uint8_t *	blue,
		float32_t *	frequency,
		uint8_t *	dutyCycle
	)

Get LED configuration after system boot. The behavior of the LED in terms of color (intensity) and blink frequency may be configured. The system will set the LED to this state when the operating system has booted. The LED settings may after this time, at any time, be overridden by other FrontLED functions. Note that FrontLED_setEnabledDuringStartup overrides these settings, it has to be enabled for these settings to apply. Also note that the frequency limitations mentioned in the description of FrontLED_setSignal also apply here.

Supported Platform(s): VS, VI2

Parameters

red	Red color intensity 0-0x0F.
green	Green color intensity 0-0x0F.
blue	Blue color intensity 0-0x0F.
frequency	LED blink frequency (0.2-50 Hz).
dutyCycle	LED on duty cycle (0-100%).

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_getSignal()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getSignal	(	FRONTLEDHANDLE	,
		float64_t *	frequency,
		uint8_t *	dutyCycle
	)

Get front LED signal. Note, the values may vary from previously set values with setSignal. This is due to precision-loss in approximations.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

frequency	LED blink frequency (0.2-50 Hz).
dutyCycle	LED on duty cycle (0-100%).

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = FrontLED_getSignal(pFrontLED, &freq, &dutycycle);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function getSignal: " << GetErrorStringA(err) << endl;
  }

◆ FrontLED_getStandardColor()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_getStandardColor	(	FRONTLEDHANDLE	,
		CCAuxColor *	color
	)

Get front LED color from a set of standard colors. If the color is not one of the predefined colors, UNDEFINED_COLOR will be returned. It is not recommended to use this function on the VC or VA platforms.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

color Color from CCAuxColor enum.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_release()

EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV CrossControl::FrontLED_release ( FRONTLEDHANDLE )

Delete the FrontLED object.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Returns: -

Example Usage:

  FRONTLEDHANDLE pFrontLED = ::GetFrontLED();
  assert(pFrontLED);
  led_example(pFrontLED);
  FrontLED_release(pFrontLED);

◆ FrontLED_setBootLEDConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setBootLEDConfig	(	FRONTLEDHANDLE	,
		uint8_t	red,
		uint8_t	green,
		uint8_t	blue,
		float32_t	frequency,
		uint8_t	dutyCycle
	)

Set LED configuration during system boot. The behavior of the LED in terms of color (intensity) and blink frequency may be configured during system boot. Note that FrontLED_setEnabledDuringStartup overrides these settings, it has to be enabled for these settings to apply. Also note that the frequency limitations mentioned in the description of FrontLED_setSignal also apply here.

Supported Platform(s): VS, VI2

Parameters

red	Red color intensity 0-0x0F.
green	Green color intensity 0-0x0F.
blue	Blue color intensity 0-0x0F.
frequency	LED blink frequency (0.2-50 Hz).
dutyCycle	LED on duty cycle (0-100%).

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_setColor()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setColor	(	FRONTLEDHANDLE	,
		uint8_t	red,
		uint8_t	green,
		uint8_t	blue
	)

Set front LED color mix.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

On the VC, VA platforms - use the blue parameter to set the button backlight intensity (0-15)

Parameters

red	Red color intensity 0-0x0F.
green	Green color intensity 0-0x0F.
blue	Blue color intensity 0-0x0F.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = FrontLED_setColor(pFrontLED, red, green, blue);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function setColor: " << GetErrorStringA(err) << endl;
  }

◆ FrontLED_setEnabledDuringStartup()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setEnabledDuringStartup	(	FRONTLEDHANDLE	,
		CCStatus	status
	)

Should the front LED be enabled during startup? If enabled, the LED will blink yellow to indicate startup progress. It will turn green once the OS has started.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

status Enable or Disable the LED during startup.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_setIdleTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setIdleTime	(	FRONTLEDHANDLE	,
		uint8_t	idleTime
	)

Get front LED idle time.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

idleTime Time in 100ms.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_setNrOfPulses()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setNrOfPulses	(	FRONTLEDHANDLE	,
		uint8_t	nrOfPulses
	)

Set front LED number of pulses during a blink sequence.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

nrOfPulses Number of pulses.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_setOff()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setOff ( FRONTLEDHANDLE )

Set front LED off.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_setOffTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setOffTime	(	FRONTLEDHANDLE	,
		uint8_t	offTime
	)

Set front LED off time.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

offTime Time in 10ms increments.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = FrontLED_setOffTime(pFrontLED, 25);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function setOfftime: " << GetErrorStringA(err) << endl;
  }

◆ FrontLED_setOnTime()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setOnTime	(	FRONTLEDHANDLE	,
		uint8_t	onTime
	)

Set front LED on time.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

onTime Time in 10ms increments. 0 = off

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = FrontLED_setOnTime(pFrontLED, 25);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function setOnTime: " << GetErrorStringA(err) << endl;
  }

◆ FrontLED_setPostBootLEDConfig()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setPostBootLEDConfig	(	FRONTLEDHANDLE	,
		uint8_t	red,
		uint8_t	green,
		uint8_t	blue,
		float32_t	frequency,
		uint8_t	dutyCycle
	)

Set LED configuration after system boot. The behavior of the LED in terms of color (intensity) and blink frequency may be configured. The system will set the LED to this state when the operating system has booted. The LED settings may after this time, at any time, be overridden by other FrontLED functions. Note that FrontLED_setEnabledDuringStartup overrides these settings, it has to be enabled for these settings to apply. Also note that the frequency limitations mentioned in the description of FrontLED_setSignal also apply here.

Supported Platform(s): VS, VI2

Parameters

red	Red color intensity 0-0x0F.
green	Green color intensity 0-0x0F.
blue	Blue color intensity 0-0x0F.
frequency	LED blink frequency (0.2-50 Hz).
dutyCycle	LED on duty cycle (0-100%).

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

◆ FrontLED_setSignal()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setSignal	(	FRONTLEDHANDLE	,
		float64_t	frequency,
		uint8_t	dutyCycle
	)

Set front LED signal.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

frequency	LED blink frequency (0.2-50 Hz).
dutyCycle	LED on duty cycle (0-100%).

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Note: The hardware cannot be set to have an on or off time of the LED that's longer than 2.55s (255*10ms) Hence there are limitations in this function when using frequencies slower than 0.39Hz. At 0.38Hz, the valid duty cycle range is [3 - 97]. At 0.30Hz, the valid duty cycle range is [24 - 76]. At 0.20Hz, the valid duty cycle range is [49 - 51]. At 0.19Hz and slower, the behavior is undefined for all duty cycles, so this is not allowed to be set. Additionally, the hardware cannot be set to have an on or off time of the LED that's shorter than 10ms. Hence, there are limitations in this function when using high frequencies. At 50 Hz, the valid duty cycle range is [50]. At 30 Hz, the valid duty cycle range is [30-70]. At 10 Hz, the valid duty cycle range is [10-90]. At 2 Hz, the valid duty cycle range is [2-98]. The behavior is undefined outside these ranges but setting 0% or 100% duty cycle will always work, regardless of the frequency. If you need to blink in an unsupported range, it can be done with a software timer instead.

Example Usage:

  err = FrontLED_setSignal(pFrontLED, freq, dutycycle);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function setSignal: " << GetErrorStringA(err) << endl;
  }

◆ FrontLED_setStandardColor()

EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV CrossControl::FrontLED_setStandardColor	(	FRONTLEDHANDLE	,
		CCAuxColor	color
	)

Set one of the front LED standard colors. It is not recommended to use this function on the VC/VA/VI2 platform.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Parameters

color Color from CCAuxColor enum.

Returns: error status. 0 = ERR_SUCCESS, otherwise error code. See the enum eErr for details.

Example Usage:

  err = FrontLED_setStandardColor(pFrontLED, RED);
  if (err != ERR_SUCCESS)
  {
    cout << "Error(" << err << ") in function setStandardColor: " << GetErrorStringA(err) << endl;
  }

◆ GetFrontLED()

EXTERN_C CCAUXDLL_API FRONTLEDHANDLE CCAUXDLL_CALLING_CONV CrossControl::GetFrontLED ( void )

Factory function that creates instances of the FrontLED object.

Supported Platform(s): XL, XM, XM9, XS, XA, VC, VA, VS, VI2

Returns: FRONTLEDHANDLE to an allocated FrontLED object. The returned handle needs to be deallocated using the FrontLED_release(FRONTLEDHANDLE) method when it's no longer needed. Returns NULL if it fails to allocate memory.

Example Usage:

  FRONTLEDHANDLE pFrontLED = ::GetFrontLED();
  assert(pFrontLED);
  led_example(pFrontLED);
  FrontLED_release(pFrontLED);