FrontLED.h

Go to the documentation of this file.

/************************************************
*
*  CROSSCONTROL AUX API
*
*  FrontLED.h
*
*  Version 2.8.3.0, 2016-04-06
*
*  (c) maximatecc 2013
*

 *  File description: 
 *  Front LED control
 * 
 *  CCpilot VC platform - Button backlight control.
 *  For VC, the API works the same way as for front LED control on other platforms, but without color support.
 *
 *  Use the function GetFrontLED() to get a handle to pass on to the other functions. 
 *  Use the method FrontLED_release(FRONTLEDHANDLE) to return the handle.
 *
 *  Example Usage:
 *  @include frontled_example.cpp
 *
 ************************************************/
#ifndef CC_FRONT_LED_H 
#define CC_FRONT_LED_H

#include "CCAuxErrors.h"
#include "CCAuxTypes.h"
#include "CCPlatform.h"

#ifdef __cplusplus
namespace CrossControl {
#endif

  typedef void* FRONTLEDHANDLE;

  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, double* frequency, unsigned char* dutyCycle);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_getOnTime (FRONTLEDHANDLE, unsigned char* onTime);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_getOffTime (FRONTLEDHANDLE, unsigned char* offTime);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_getIdleTime (FRONTLEDHANDLE, unsigned char* idleTime);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_getNrOfPulses (FRONTLEDHANDLE, unsigned char* nrOfPulses);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_getColor(FRONTLEDHANDLE, unsigned char* red, unsigned char* green, unsigned char* 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, double frequency, unsigned char dutyCycle);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_setOnTime (FRONTLEDHANDLE, unsigned char onTime);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_setOffTime (FRONTLEDHANDLE, unsigned char offTime);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_setIdleTime (FRONTLEDHANDLE, unsigned char idleTime);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_setNrOfPulses (FRONTLEDHANDLE, unsigned char nrOfPulses);

  EXTERN_C
    CCAUXDLL_API
    eErr
    CCAUXDLL_CALLING_CONV
    FrontLED_setColor(FRONTLEDHANDLE, unsigned char red, unsigned char green, unsigned char 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);

#ifdef __cplusplus
} /* namespace CrossControl */
#endif

#endif /* CC_FRONT_LED_H */