Updated README

This commit is contained in:
David Madison 2016-12-20 03:58:53 -05:00
parent ab14c0a996
commit 11b73f2e6d
1 changed files with 29 additions and 1 deletions

View File

@ -1,3 +1,31 @@
## Synopsis
This is the standard Adalight library, modified to work with 3-pin WS2812B LED strips (2016-era Adafruit NeoPixels). The Arduino code has been modified to use the FastLED library.
In addition to ambilight setups, the protocol can be used to stream any color data from a computer to a WS2812B strip (data rate limited by serial throughput).
## Configuration
Open the WS2812B file in the Arduino IDE and edit the definitions at the top for your setup. Specifically:
- Number of LEDs
- LED data pin
- LED grounding pin (optional)
- Brightness
- Serial speed
Upload to your Arduino and use a corresponding PC application to stream color data. The Processing files are included, though I would recommend using Patrick Siegler's (@psieg) fork of Lightpacks's Prismatik, which you can find [here](https://github.com/psieg/Lightpack).
## Tutorial
If you'd like you can follow Adafruit's tutorial, which is fairly comprehensive for the WS2801 they use but is otherwise out of date. You can find the tutorial here:
<https://learn.adafruit.com/adalight-diy-ambient-tv-lighting>
## License
Adalight is free software: you can redistribute it and/or modify Adalight is free software: you can redistribute it and/or modify
it under the terms of the GNU Lesser General Public License as it under the terms of the GNU Lesser General Public License as
published by the Free Software Foundation, either version 3 of published by the Free Software Foundation, either version 3 of
@ -9,4 +37,4 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Lesser General Public License for more details. GNU Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public You should have received a copy of the GNU Lesser General Public
License along with Adalight. If not, see <http://www.gnu.org/licenses/>. License along with Adalight. If not, see <http://www.gnu.org/licenses/>.