diff --git a/README.md b/README.md index 9350bec..81583d8 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,60 @@ # osc_led -OSC control of LEDs for Jembo \ No newline at end of file +OSC control of LEDs for Jembo + +# Install dependencies +1. Open lxterminal +2. Copy/paste the following: + + +``` +sudo apt-get install git +sudo pip3 install osc4py3 +mkdir git +cd git +git clone https://git.sav.net.au/Public/osc_led.git +``` + +# Setup Reaper, load the template +Set up reaper to listen on port 9000 and send to port 8000. + Control surface mode: OSC + Mode: Configure device IP + local port + Device port: 9000 + Device IP: 127.0.0.1 + Local Listen port: 8000 + Local IP: doesn't matter [1] + Wait between packets: 100ms [2] + Allow binding messages to REAPER actions and FX learn: [X] + +Notes: + +1. I couldn't set the address to listen on in the GUI, but it binds to 0.0.0.0 so it's listening on every local address anyway. +2. I've set this to 100ms for testing. If this is too long a latency it can be dropped, but the python components are set with thresholds between .5% and 1% of brightness and colour respectively before changing the LEDs so that grandients aren't crazily chatty. + +# Start osc_server +1. Open lxterminal +2. Run the following: + +``` +cd ~/git/osc_led +./osc_server.py +``` + +# Controlling Reaper +You can do it from reaper, or use some basic controls from osc_client.py +1. Open lxterminal + + +``` +cd ~/git/osc_led +./osc_client.py play +# OR +./osc_client.py stop +# OR +./osc_client.py restart +``` + + + + +