rschaten/IRlicht
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

reformatted readme to use markdown

Browse Source
This commit is contained in:
Ronald Schaten
2016-05-20 14:46:43 +02:00
parent 34fc0b7075
commit 773c793d2a
1 changed files with 26 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.md
View File

@@ -1,10 +1,12 @@
IRlicht -- a 4-channel (RGBW) controller for LED-lamps, based on Arduino and # IRlicht
controlled via infrared by a universal remote.
A 4-channel (RGBW) controller for LED-lamps, based on Arduino and controlled
via infrared by a universal remote.
Copyright 2014 Ronald Schaten <http://www.schatenseite.de> Copyright 2014 Ronald Schaten <http://www.schatenseite.de>
CIRCUIT ## Circuit
You can see how to connect your Arduino in the enclosed Fritzing files and You can see how to connect your Arduino in the enclosed Fritzing files and
their rendered breadboard schematics. Basically, it's just the IR receiver their rendered breadboard schematics. Basically, it's just the IR receiver
@@ -16,7 +18,7 @@ those, I dissected an old DVD player and desoldered the enclosed IR receiver
diode from that. Worked like a charm. :-) diode from that. Worked like a charm. :-)
SOFTWARE ## Software
After installing Ken Shirriff's IR receiver library in your Arduino After installing Ken Shirriff's IR receiver library in your Arduino
environment, everything you need is the enclosed sketch (irlicht.ino). environment, everything you need is the enclosed sketch (irlicht.ino).
@@ -30,40 +32,41 @@ With the initial brightness levels given in the sketch, you can select which
mode and colors should be active when the device is switched on. mode and colors should be active when the device is switched on.
USAGE ## Usage
If your remote is set up like mine, you get the following functions: If your remote is set up like mine, you get the following functions:
Some keys for basic color selection: Some keys for basic color selection:
1 -- red * 1 -- red
2 -- green * 2 -- green
3 -- blue * 3 -- blue
5 -- white * 5 -- white
7 -- yellow (red and green) * 7 -- yellow (red and green)
8 -- cyan (green and blue) * 8 -- cyan (green and blue)
9 -- magenta (blue and red) * 9 -- magenta (blue and red)
On the first press, the channel is turned on to 1/5 of maximum. Repeating the On the first press, the channel is turned on to 1/5 of maximum. Repeating the
key enhances the brightness, after five levels the channel is turned off again. key enhances the brightness, after five levels the channel is turned off again.
4 -- all channels on * 4 -- all channels on
6 -- all channels off * 6 -- all channels off
This turns the whole setup on or off with one single press of a button. This turns the whole setup on or off with one single press of a button.
Flash -- Hard cycle through all colors (except white). * Flash -- Hard cycle through all colors (except white).
Fade -- Soft cycle through all colors (except white). * Fade -- Soft cycle through all colors (except white).
Strobe -- Turn the currently selected color on and off. * Strobe -- Turn the currently selected color on and off.
Soft -- Fade the current color from dark to a certain level and back. * Soft -- Fade the current color from dark to a certain level and back.
Dim -- Decrease the maximum brightness of the lamp. * Dim -- Decrease the maximum brightness of the lamp.
Bright -- Increase the maximum brightness. * Bright -- Increase the maximum brightness.
AllLightsOn -- Misleading name: this speeds up the current animation. * AllLightsOn -- Misleading name: this speeds up the current animation.
AllLightsOff -- Also misleading, although consistent: slows down the animation. * AllLightsOff -- Also misleading, although consistent: slows down the
animation.
COMMENTS ## Comments
Feel free to drop me a line at <ronald@schatenseite.de>. Feel free to drop me a line at <ronald@schatenseite.de>.