FrontLED.h

Go to the documentation of this file.

 
/*
 * Copyright (C) 2023 CrossControl AB
 *
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; with
 * version 2.1 of the License.
 */
/*
 *  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, float64_t *frequency, uint8_t *dutyCycle);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV FrontLED_setActive(FRONTLEDHANDLE, ComponentLocation location);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV FrontLED_getActive(FRONTLEDHANDLE, ComponentLocation *location);
 
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_getColorExt(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_setColorExt(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_getBootLEDConfigExt(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_setBootLEDConfigExt(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_getPostBootLEDConfigExt(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);
 
EXTERN_C
CCAUXDLL_API
eErr CCAUXDLL_CALLING_CONV FrontLED_setPostBootLEDConfigExt(FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue,
                                                            float32_t frequency, uint8_t dutyCycle);
 
#ifdef __cplusplus
} /* namespace CrossControl */
#endif
 
#ifdef PLATFORM_VI2
#pragma message "FrontLED is deprecated for CCpilot VI2"
#endif
 
#endif /* CC_FRONT_LED_H */