AvrIO  1.4.5
Bibliothèque C modulaire pour ATMEL AVR
ledrgb.h
1 
21 #ifndef _AVRIO_LEDRGB_H_
22 #define _AVRIO_LEDRGB_H_
23 
24 #include <avrio/defs.h>
25 #include <avrio/rgb.h>
26 
27 __BEGIN_C_DECLS
28 /* ========================================================================== */
29 #include "avrio-config.h"
30 #if defined(AVRIO_LEDRGB_ENABLE)
31 #include "avrio-board-ledrgb.h"
32 #endif
33 
34 #if defined(AVRIO_LEDRGB_ENABLE) || defined(__DOXYGEN__)
35 
53 /* constants ================================================================ */
58 typedef enum {
59  MODE_OFF = 0,
60  MODE_ON = 1,
63  } eLedRgbMode;
64 
65 /* internal public functions ================================================ */
74 int8_t iLedRgbInit (void);
75 
84 void vLedRgbSetColor (xLedRgbMask xLed, uint32_t ulColor);
85 
94 void vLedRgbSetMode (xLedRgbMask xLed, eLedRgbMode eMode);
95 
103 void vLedRgbSetGlobalDimming (uint8_t ucDimming);
104 
114 void vLedRgbSetGlobalBlinking (uint16_t usPeriod, uint8_t ucDutyCycle);
115 
125 
126 void vLedRgbClearError (void);
127 
128 #if defined(__DOXYGEN__)
129 /*
130  * __DOXYGEN__ defined
131  * Partie documentation ne devant pas être compilée.
132  * =============================================================================
133  */
134 
135 /* types ==================================================================== */
145 typedef uint16_t xLedRgbMask;
146 
153 #define LEDRGB_ALL_LEDS
154 
161 #define LEDRGB_NO_LED
162 
167 #endif /* __DOXYGEN__ defined */
168 
169 #endif /* AVRIO_LEDRGB_ENABLE defined */
170 __END_C_DECLS
171 /* ========================================================================== */
172 #endif /* _AVRIO_LEDRGB_H_ not defined */
xLedRgbMask xLedRgbError(void)
Renvoie les erreurs des leds.
uint16_t xLedRgbMask
Type utilisé pour les masques de LED RGB.
Definition: ledrgb.h:145
void vLedRgbSetGlobalDimming(uint8_t ucDimming)
Modifie la luminosité globale de toutes les leds configurées en mode MODE_BLINK.
void vLedRgbSetColor(xLedRgbMask xLed, uint32_t ulColor)
Modifie la couleur d&#39;une ou plusieurs leds.
int8_t iLedRgbInit(void)
Initialise le module.
Led avec variation d&#39;intensité
Definition: ledrgb.h:61
void vLedRgbSetMode(xLedRgbMask xLed, eLedRgbMode eMode)
Modifie le mode d&#39;allumage d&#39;une ou plusieurs leds.
Led allumée sans variation d&#39;intensité
Definition: ledrgb.h:60
eLedRgbMode
Definition: ledrgb.h:58
void vLedRgbSetGlobalBlinking(uint16_t usPeriod, uint8_t ucDutyCycle)
Fait clignoter toutes les leds configurées en mode MODE_BLINK.
Led éteinte.
Definition: ledrgb.h:59
Led avec variation d&#39;intensité et clignotement.
Definition: ledrgb.h:62