Skip to content

Commit

Permalink
Missing doc for setMax
Browse files Browse the repository at this point in the history
  • Loading branch information
Koryphon committed Apr 5, 2018
1 parent 046f4e6 commit 4be104b
Showing 1 changed file with 5 additions and 1 deletion.
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,13 +52,17 @@ The following functions are available:

### LightDimmer::update()

LightDimmer::update shall be called in loop to allow the library to update the state of each LED. If the call frequency is not high enough you will get discontinuous update in the fading and brightening process for LightDimmer objects (those using hardware PWM). LightDimmerSoft object (those using software PWM) will flicker. So you shall never use the delay function your sketch.
LightDimmer::update shall be called in loop to allow the library to update the state of each LED. If the call frequency is not high enough you will get discontinuous update in the fading and brightening process for LightDimmer objects (those using hardware PWM). LightDimmerSoft object (those using software PWM) will flicker. So you shall never use the delay function in your sketch.

### begin(pin, level)

begin has to be called in setup for each LED. ```pin``` is the pin to which the
LED is connected. ```level``` is the logical level, HIGH or LOW, to light up the LED.

### setMax(max)

max is a 8 bits integer (uint8_t or byte). setMax sets the duty cycle to set the LED on. setMax allows to adjust the brightness of each LED of your signal without changing the resistor.

### setFadingTime(time)

Set the time it take to fade the LED from the maximum value to the
Expand Down

0 comments on commit 4be104b

Please sign in to comment.