From cc287e868a2c1cd23f69efb466d2fe94420ff802 Mon Sep 17 00:00:00 2001 From: David Madison Date: Sun, 19 Mar 2017 19:20:07 -0400 Subject: [PATCH] Update README.md --- README.md | 14 ++++++++------ 1 file changed, 8 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index f75aa10..61f3af9 100644 --- a/README.md +++ b/README.md @@ -1,25 +1,27 @@ ## Synopsis -This is the Adalight library with the Arduino code modified to use [FastLED](https://github.com/FastLED/FastLED) ([fastled.io](http://fastled.io)). This expands Adalight to, in theory, work with [any supported FastLED strip](https://github.com/FastLED/FastLED/wiki/Chipset-reference) including WS2812B (aka Adafruit NeoPixels). +This project modifies the Adalight protocol to use [FastLED](https://github.com/FastLED/FastLED) ([fastled.io](http://fastled.io)). This expands Adalight to, in theory, work with [any supported FastLED strip](https://github.com/FastLED/FastLED/wiki/Chipset-reference) including WS2812B (aka Adafruit NeoPixels). In addition to ambilight setups, the protocol can be used to stream *any* color data from a computer to supported LED strips (data rate limited by serial throughput). - ## Configuration -Open the LEDstream_FastLED file in the Arduino IDE and edit the setting definitions at the top for your setup. These include: +Open the LEDstream_FastLED file in the Arduino IDE and customize the settings at the top for your setup. You will need to change: - Number of LEDs - LED data pin -- Max brightness - LED type + +Additional settings allow for adjusting: + +- Max brightness - LED color order - Serial speed - Serial timeout length There are also optional settings to configure a dedicated ground pin and to put the Arduino into a "calibration" mode, where all LED colors match the first LED. -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). +Upload to your Arduino and use a corresponding PC application to stream color data. You can get the Processing files from the [main Adalight repository](https://github.com/adafruit/Adalight), though I would recommend using [Patrick Siegler's](https://github.com/psieg/) fork of Lightpacks's Prismatik, which you can find [here](https://github.com/psieg/Lightpack). ## Issues and LED-types @@ -27,7 +29,7 @@ I've only tested the code with the WS2812B strips I have on hand, but so far it ## Credits and Contributions -The base for the original FastLED modifications is [this gist](https://gist.github.com/jamesabruce/09d79a56d270ed37870c) by [James Bruce](https://github.com/jamesabruce). Thanks James! +Thanks to Adafruit for the initial code and the Adalight protocol. The base for the original FastLED modifications is [this gist](https://gist.github.com/jamesabruce/09d79a56d270ed37870c) by [James Bruce](https://github.com/jamesabruce). Thanks James! Pull requests to improve this software are always welcome!