Skip to content
This repository has been archived by the owner on Mar 1, 2024. It is now read-only.

Commit

Permalink
Fix merge
Browse files Browse the repository at this point in the history
  • Loading branch information
SciLor committed May 5, 2018
1 parent fdfa441 commit d3ea91d
Showing 1 changed file with 1 addition and 67 deletions.
68 changes: 1 addition & 67 deletions README.md
@@ -1,43 +1,13 @@
# Hyperion LED Controller for ESP8266/ESP32

<<<<<<< HEAD
This code allows you to use a ESP8266 with a fitting led strip as extension for [hyperion](https://github.com/hyperion-project) (ambilight clone).
=======
This code allows you to use a ESP8266/ESP32 with a fitting led strip as extension for [hyperion](https://github.com/hyperion-project) (ambilight clone).
>>>>>>> develop
You need to configure hyperion to stream the leds as UDP to the esp.

German Tutorial:
https://forum-raspberrypi.de/forum/thread/25242-tutorial-esp8266-nodemcu-addon-wifi-led-controller-udp/

Tested with following following libraries (other versions may work):
# IDE
<<<<<<< HEAD
a) Arduino IDE 1.6.12, 1.8.5

# Board Library
a) esp8266 2.3.0 http://arduino.esp8266.com/stable/package_esp8266com_index.json - add to board urls - Version > 2.3.0 don't work

# Libraries
a) ArduinoThread 2.1.0, 2.1.1
b) ArduinoJSON 5.7.0, 5.12.0
c) LinkedList 1.2.3
d) FastLED 3.1.3
e) Logging https://github.com/SciLor/Arduino-logging-library - install manually: Download zip from github and install via Arduino IDE, Sketch -> Include Library -> Add .ZIP Library

# Installation

# Configuration of the board
1. Go to the `HyperionRGB` folder and create a copy of `ConfigStatic.h.example`. Remove the `.example` suffix
2. Configure the `ConfigStatic.h` for your needs:
- Select your LED chip type. All LEDs of the [FastLed](https://github.com/FastLED/FastLED) libraries are supported
- Configure the used LED pins. You can also change the Pin Order. The NodeMCU order doesn't work sometimes to please also try the `RAW_PIN_ORDER``
- Define the number of used LEDs
- Define one of the standard modes which are active when your light is idle. Choose one from: OFF, HYPERION_UDP, STATIC_COLOR, RAINBOW, FIRE2012
- You maydefine Wifi configuration but you can also change it from the Webinterface
3. Open the `HyperionRGB.ino` the Arduino IDE
4. Compile and upload to your board
=======
a) Arduino IDE 1.8.5

# Board Library
Expand All @@ -53,44 +23,9 @@ add to board urls - Version 2.4.0 don't work (bug see https://github.com/esp8266
a) ArduinoThread 2.1.1

b) ArduinoJSON 5.12.0
>>>>>>> develop
# Configuration of Hyperion
You need two running hyperion instances. The first grabs the data on e.g. a rasbperry pi and controls any local attached LED strips. This first instance is configured to forward its data to a second hyperion instance on the same machine. Be sure to only forward the UDP data:

```
"forwarder" :
{
"proto" : [ "localhost:19447" ]
},
```

The second hyperion instance is configured to use UDP as device so that it can talk to the ESP directly. This second hyperion instance can run on the same machine as the first instance. Just make sure that you set the UDP ports, hostnames/IPs and LED number accordingly to the values you've configured for the ESP.

```
{
    "colorOrder" : "rgb",
    "maxpacket" : 1450,
    "name" : "AmbiSZ-ESP8266",
    "output" : "ESP8266:19446", ///
    "protocol" : 0,
    "rate" : 250000,
    "type" : "udp"
},

c) LinkedList 1.2.3

"protoServer" :
{
"port" : 19447
},
"jsonServer" :
{
"port" : 19446
},
```

<<<<<<< HEAD
=======
d) FastLED 3.1.6

e) Logging https://github.com/SciLor/Arduino-logging-library - install manually: Download zip from github and install via Arduino IDE, Sketch -> Include Library -> Add .ZIP Library
Expand Down Expand Up @@ -143,6 +78,5 @@ The second hyperion instance is configured to use UDP as device so that it can t
"port" : 19446
},
```
>>>>>>> develop

There's a detailed instruction page for [controlling multiple devices](https://hyperion-project.org/wiki/Controlling-Multiple-Devices).

0 comments on commit d3ea91d

Please sign in to comment.