CCAux  2.12.0.0
CCAux API reference
FrontLED.h
Go to the documentation of this file.
1 /************************************************
2 *
3 * CROSSCONTROL AUX API
4 *
5 * FrontLED.h
6 *
7 * Version 2.12.0.0, 2017-12-21
8 *
9 * (c) CrossControl 2010-2017
10 *
11 
12  * File description:
13  * Front LED control
14  *
15  * CCpilot VC platform - Button backlight control.
16  * For VC, the API works the same way as for front LED control on other platforms, but without color support.
17  *
18  * Use the function GetFrontLED() to get a handle to pass on to the other functions.
19  * Use the method FrontLED_release(FRONTLEDHANDLE) to return the handle.
20  *
21  * Example Usage:
22  * @include frontled_example.cpp
23  *
24  ************************************************/
25 #ifndef CC_FRONT_LED_H
26 #define CC_FRONT_LED_H
27 
28 #include "CCAuxErrors.h"
29 #include "CCAuxTypes.h"
30 #include "CCPlatform.h"
31 
32 #ifdef __cplusplus
33 namespace CrossControl {
34 #endif
35 
36  typedef void* FRONTLEDHANDLE;
37 
51  EXTERN_C
52  CCAUXDLL_API
53  FRONTLEDHANDLE
54  CCAUXDLL_CALLING_CONV
55  GetFrontLED(void);
56 
67  EXTERN_C
68  CCAUXDLL_API
69  void
70  CCAUXDLL_CALLING_CONV
71  FrontLED_release(FRONTLEDHANDLE);
72 
87  EXTERN_C
88  CCAUXDLL_API
89  eErr
90  CCAUXDLL_CALLING_CONV
91  FrontLED_getSignal (FRONTLEDHANDLE, float64_t* frequency, uint8_t* dutyCycle);
92 
102  EXTERN_C
103  CCAUXDLL_API
104  eErr
105  CCAUXDLL_CALLING_CONV
106  FrontLED_getOnTime (FRONTLEDHANDLE, uint8_t* onTime);
107 
117  EXTERN_C
118  CCAUXDLL_API
119  eErr
120  CCAUXDLL_CALLING_CONV
121  FrontLED_getOffTime (FRONTLEDHANDLE, uint8_t* offTime);
122 
132  EXTERN_C
133  CCAUXDLL_API
134  eErr
135  CCAUXDLL_CALLING_CONV
136  FrontLED_getIdleTime (FRONTLEDHANDLE, uint8_t* idleTime);
137 
147  EXTERN_C
148  CCAUXDLL_API
149  eErr
150  CCAUXDLL_CALLING_CONV
151  FrontLED_getNrOfPulses (FRONTLEDHANDLE, uint8_t* nrOfPulses);
152 
168  EXTERN_C
169  CCAUXDLL_API
170  eErr
171  CCAUXDLL_CALLING_CONV
172  FrontLED_getColor(FRONTLEDHANDLE, uint8_t* red, uint8_t* green, uint8_t* blue);
173 
185  EXTERN_C
186  CCAUXDLL_API
187  eErr
188  CCAUXDLL_CALLING_CONV
189  FrontLED_getStandardColor(FRONTLEDHANDLE, CCAuxColor* color);
190 
201  EXTERN_C
202  CCAUXDLL_API
203  eErr
204  CCAUXDLL_CALLING_CONV
205  FrontLED_getEnabledDuringStartup(FRONTLEDHANDLE, CCStatus* status);
206 
229  EXTERN_C
230  CCAUXDLL_API
231  eErr
232  CCAUXDLL_CALLING_CONV
233  FrontLED_setSignal (FRONTLEDHANDLE, float64_t frequency, uint8_t dutyCycle);
234 
247  EXTERN_C
248  CCAUXDLL_API
249  eErr
250  CCAUXDLL_CALLING_CONV
251  FrontLED_setOnTime (FRONTLEDHANDLE, uint8_t onTime);
252 
265  EXTERN_C
266  CCAUXDLL_API
267  eErr
268  CCAUXDLL_CALLING_CONV
269  FrontLED_setOffTime (FRONTLEDHANDLE, uint8_t offTime);
270 
280  EXTERN_C
281  CCAUXDLL_API
282  eErr
283  CCAUXDLL_CALLING_CONV
284  FrontLED_setIdleTime (FRONTLEDHANDLE, uint8_t idleTime);
285 
295  EXTERN_C
296  CCAUXDLL_API
297  eErr
298  CCAUXDLL_CALLING_CONV
299  FrontLED_setNrOfPulses (FRONTLEDHANDLE, uint8_t nrOfPulses);
300 
316  EXTERN_C
317  CCAUXDLL_API
318  eErr
319  CCAUXDLL_CALLING_CONV
320  FrontLED_setColor(FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue);
321 
335  EXTERN_C
336  CCAUXDLL_API
337  eErr
338  CCAUXDLL_CALLING_CONV
339  FrontLED_setStandardColor(FRONTLEDHANDLE, CCAuxColor color);
340 
348  EXTERN_C
349  CCAUXDLL_API
350  eErr
351  CCAUXDLL_CALLING_CONV
352  FrontLED_setOff(FRONTLEDHANDLE);
353 
364  EXTERN_C
365  CCAUXDLL_API
366  eErr
367  CCAUXDLL_CALLING_CONV
368  FrontLED_setEnabledDuringStartup(FRONTLEDHANDLE, CCStatus status);
369 
370 
387  EXTERN_C
388  CCAUXDLL_API
389  eErr
390  CCAUXDLL_CALLING_CONV
391  FrontLED_getBootLEDConfig(FRONTLEDHANDLE, uint8_t* red, uint8_t* green, uint8_t* blue, float32_t* frequency, uint8_t* dutyCycle);
392 
409  EXTERN_C
410  CCAUXDLL_API
411  eErr
412  CCAUXDLL_CALLING_CONV
413  FrontLED_setBootLEDConfig(FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue, float32_t frequency, uint8_t dutyCycle);
414 
433  EXTERN_C
434  CCAUXDLL_API
435  eErr
436  CCAUXDLL_CALLING_CONV
437  FrontLED_getPostBootLEDConfig(FRONTLEDHANDLE, uint8_t* red, uint8_t* green, uint8_t* blue, float32_t* frequency, uint8_t* dutyCycle);
438 
457  EXTERN_C
458  CCAUXDLL_API
459  eErr
460  CCAUXDLL_CALLING_CONV
461  FrontLED_setPostBootLEDConfig(FRONTLEDHANDLE, uint8_t red, uint8_t green, uint8_t blue, float32_t frequency, uint8_t dutyCycle);
462 
463 
464 
465 #ifdef __cplusplus
466 } /* namespace CrossControl */
467 #endif
468 
469 #endif /* CC_FRONT_LED_H */
470 
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_setOff(FRONTLEDHANDLE)
eErr
Definition: CCAuxTypes.h:154
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getOffTime(FRONTLEDHANDLE, uint8_t *offTime)
double float64_t
Definition: CCAuxTypes.h:26
CCStatus
Definition: CCAuxTypes.h:145
float float32_t
Definition: CCAuxTypes.h:25
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getEnabledDuringStartup(FRONTLEDHANDLE, CCStatus *status)
Definition: About.h:30
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getOnTime(FRONTLEDHANDLE, uint8_t *onTime)
EXTERN_C CCAUXDLL_API void CCAUXDLL_CALLING_CONV FrontLED_release(FRONTLEDHANDLE)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getColor(FRONTLEDHANDLE, uint8_t *red, uint8_t *green, uint8_t *blue)
CCAuxColor
Definition: CCAuxTypes.h:430
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_setStandardColor(FRONTLEDHANDLE, CCAuxColor color)
EXTERN_C CCAUXDLL_API FRONTLEDHANDLE CCAUXDLL_CALLING_CONV GetFrontLED(void)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getIdleTime(FRONTLEDHANDLE, uint8_t *idleTime)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_setOffTime(FRONTLEDHANDLE, uint8_t offTime)
void * FRONTLEDHANDLE
Definition: FrontLED.h:36
unsigned char uint8_t
Definition: CCAuxTypes.h:47
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_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_setNrOfPulses(FRONTLEDHANDLE, uint8_t nrOfPulses)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_setIdleTime(FRONTLEDHANDLE, uint8_t idleTime)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getStandardColor(FRONTLEDHANDLE, CCAuxColor *color)
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_setSignal(FRONTLEDHANDLE, float64_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_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_setOnTime(FRONTLEDHANDLE, uint8_t onTime)
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_setEnabledDuringStartup(FRONTLEDHANDLE, CCStatus status)
EXTERN_C CCAUXDLL_API eErr CCAUXDLL_CALLING_CONV FrontLED_getNrOfPulses(FRONTLEDHANDLE, uint8_t *nrOfPulses)