Methods

#Methods

##attach()
Arguments: pin number (byte/uint8_t)
returns: nothing (void)

Description:
initialize the Pin to which the LED is attached, as well as all internal variables.
Initialise le pin auquel la LED est assigné, ainsi que les variables internes.

##readPin()
arguments: none
returns: pin number (byte/uint8_t)

Description:
returns pin number to which LED is attached.
retourne le numéro de pin auquel la LED est assignée.

##update()
arguments: none
returns: nothing (void)

**IMPORTANT: To be called at each cycle in the main loop of the Arduino program **

Description:
Depending on the setpoint of the LED and of its timers (on time, blink time) values,
sets the LED to LOW (off) or HIGH (on) state.

Works with the millis() timebase, expressed in milliseconds.
millis() is initialized at Arduino startup.
As this is an "unsigned long" (32 bits) variable type, this allows to get an
absolute timebase lasting about 50 days, which is sufficient for non permanent
applications.

En fonction de la consigne assignée à chaque LED et des valeurs des timers associés (durée d'allumage, fréquence de clignotement), positionne chaque LED à l'état bas (LOW / éteint) ou haut (HIGH / allumé).

Fonctionne sur la base de temps millis() exprimée en millisecondes.
millis() s'initialise à zéro au démarrage de l'Arduino.
S'agissant d'une variable de type "unsigned long" (32 bits), permet de disposer d'une
base de temps absolu d'environ 50 jours, ce qui est suffisant pour les applications
non permanentes.

see: https://www.arduino.cc/en/Reference/Millis

##off()
arguments: none
returns: nothing (void)

Description:
turn off LED.
éteint la LED.

##on()
arguments: none
returns: nothing (void)

Description:
turn on LED. Light up!
allume la LED.

##setPermanent()
arguments: none
returns: nothing (void)

Description:
Set the LED setpoint to be permanent (no time out) - overrides setTimer.
Consigne allumage permanent (pas de temporisation) - invalide setTimer.

##setTimer(unsigned long timer)
arguments: timer value in ms (unsigned long)
returns: nothing (void)

Description:
Set timer, expressed in ms - overrides setPermanent.
Initialise la temporisation (en ms) - invalide setPermanent.

##setFixed()
arguments: none
returns: nothing (void)

Description:
Set fixed lighting - overrides setBlink and other effects.
Consigne allumage fixe - invalide setBlink et autres effets.

##setBlink(uint16_t blinkTime)
arguments: blinking period in ms (unsigned int/uint16_t)
returns: nothing (void)

Description:
Set blink period, expressed in ms
LED in ON during "BlinkTime", then OFF during "BlinkTime", etc. - overrides setFixed
will start blinking using the current setpoint (starting cycle OFF if setpoint is OFF and vice versa)
Initialise la période de clignotement (en ms)
la LED est allumée pendant "BlinkTime", puis éteinte pendant "BlinkTime", etc. - invalide setFixed.
commencera à clignoter en utilisant la consigne courante (cycle commençant éteint si la consigne est à OFF et vice versa)

##memSetpoint()
arguments: none
returns: nothing (void)

Description:
memorize current setpoint.
mémorise la consigne courante.

##memOn()
arguments: none
returns: nothing (void)

Description:
memorize setpoint ON, fixed, permanent.
mémorise l'état allumé, fixe et permanent.

##memOff()
arguments: none
returns: nothing (void)

Description:
memorize setpoint OFF, fixed, permanent.
mémorise l'état éteint, fixe et permanent.

##restoreSetpoint()
arguments: none
returns: nothing (void)

Description:
restore memorized setpoint.
rétablit l'état mémorisé.