LJ/README.md

235 lines
9.2 KiB
Markdown
Raw Normal View History

2018-12-13 11:05:32 +00:00
LJ v0.7.0
By Sam Neurohack, Loloster, Cocoa
LICENCE : CC BY
2018-12-31 02:41:02 +00:00
Dear
I'm part of a group of laser freaks that use etherdreams in demoparty and many other occasions. Recently we started using your wonderful dac emulator that is so useful.
It compiles and works flawlessly in fairly new computers, we tried successfully several os X and different linux flavors, but with older generation i5 M560 (a dual core 2.67 Ghz) when i run ./visualiser I get an error :
thread 'main' panicked at 'could not build default app window: GlutinCreationError(NoAvailablePixelFormat)', libcore/result.rs:1009:5
note: Run with `RUST_BACKTRACE=1` for a backtrace.
My guess is to modify the display creation in... nannou ?
I don't speak Rust, but the dac emulator import a nannou crate, so I can't modify the code in dac emulator directly ?
Would you consider supporting older computers by testing configuration and then modifying the display creation accordingly ?
This will be very helpfull
2018-12-13 11:05:32 +00:00
![LJ](http://www.teamlaser.fr/thsf/images/fulls/THSF9-33.jpg)
2018-12-30 15:12:30 +00:00
A software laser server with GUI for up to 4 lasers live actions. Think creative like Laser "battles", planetarium,...
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
LJ has 3 main components :
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
- A tracer per etherdream/laser that take current client point list, correct geometry, recompute in etherdreams coordinates, send it to its controller,... and report etherdream status to the manager.
- A manager that talk to all tracers (which client number point lists to draw, new geometry correction,...), handle the webui functions, OSC commands,...
- Up to ten clients, that simultaneously send one point list per laser.
You run and write your clients in any redis capable programming langage (50+ : https://redis.io/clients).
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
Needs at least : an etherdream DAC connected to an ILDA laser, RJ 45 IP network (gigabits only !! no wifi, 100 mpbs doesn't work well with several lasers)
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
The server approach is based on redis.
2018-12-13 11:05:32 +00:00
LJ supports Linux and OS X. Windows is unkown but welcome, if someone want to jump in and care about it.
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
2018-12-13 11:05:32 +00:00
#
# Features among many others.
#
(Doc in progress)
2018-12-30 15:12:30 +00:00
- OSC and websocket commands. Very cool : LJ can script or be scripted.
2018-12-13 11:05:32 +00:00
- Interactive (mouse style) warp correction for each laser.
- Web ui : In your browser open webui/index.html. Javascript is needed.
2018-12-30 15:12:30 +00:00
- Status update every 0.5 seconds : every etherdream DAC state, number of buffer points sent,...
- "Optimisation" points automatically added, can be changed live for glitch art. Search "resampler" commands.
2018-12-30 15:12:30 +00:00
- A compiled version for os x of nannou.org etherdream+laser emulator is included. For more information https://github.com/nannou-org/ether-dream
- A 3D anaglyph client example
2018-12-13 11:05:32 +00:00
#
# External devices
#
(Doc in Progress)
#
2018-12-30 15:12:30 +00:00
# Networking
2018-12-13 11:05:32 +00:00
#
2018-12-30 15:12:30 +00:00
LJ is network based and this is *critical and flickering reason #1* if not managed properly, especially you have several lasers.
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
Our "always working solution", as we regularly move our gear for different venues :
2018-12-30 15:12:30 +00:00
We use static network configuration. Our Etherdreams controllers have static IPs defined in their SDcard from 192.168.1.1 to 192.168.1.9. Because wifi will always finally sucks for many reasons, our computers (laser server and clients) are *gigabits wired connected* with 192.168.1.10 and after. Don't trust end user gear marketing on wifi, we have a big gigabits switch for laser only stuff. We provide Internet through wifi on different network like 192.168.2.x
2018-12-30 15:12:30 +00:00
Even if etherdreams are 100 Mbits, we use gigabits gear.
By default LJ uses on 127.0.0.1 (localhost) :
- A websocket on port 9001 for WebUI interaction.
- The redis server on port 6379 ('ljayserverip')
2018-12-30 15:12:30 +00:00
- An OSC server on port 8002.
- An OSC client for 'bhoroscIP' port 8001.
- An OSC client for Nozoids support on 'nozoscIP', port 8003.
2018-12-27 11:40:30 +00:00
You need to update LJ.conf to your network/etherdreams IPs and be sure to check command arguments : python main.py --help
2018-12-30 15:12:30 +00:00
A dedicated computer to act as "laser server" usually depends on how many lasers you want to control and your main computer load. If you seen flickering with small point lists, try the dedicated computer option and/or stop process interfering like redis monitoring,...
2018-12-13 11:05:32 +00:00
Program your own "Client" :
-------------------------
- Read the Introduction part in this readme.
- Carefully read all comments in clients examples.
- Generate at least one point list array (say a square).
2018-12-30 15:12:30 +00:00
- Feed your point list array in string format to redis server.
2018-12-13 11:05:32 +00:00
#
# Install
#
With Linux, type in a terminal window :
2018-12-13 11:05:32 +00:00
./install.sh
For OS X, you need brew already installed, then :
brew update
brew upgrade
brew install redis
type all install.sh commands beginning line 4.
For Linux and OS X :
2018-12-13 11:05:32 +00:00
Check the bind line in /etc/redis/redis.conf :
- If client and laser servers computers are the same, use 127.0.0.1
- Client and laser server are different, use the laser server computer IP.
In webui/index.html change the ws ip adress to the server IP or 127.0.0.1 if client computer = laser server computer.
2018-12-27 11:40:30 +00:00
Using the same idea check all ip address in LJ.conf.
2018-12-13 11:05:32 +00:00
#
# To run
#
2018-12-30 15:12:30 +00:00
A typical start is python main.py -L numberoflasers. Use -h to display all possible arguments.
Always start the redis server first, then laser server, maybe those two should run on the same computer, then your client.
2018-12-13 11:05:32 +00:00
Case 1 : the laser server computer is the same that the computer running a client :
2018-12-27 11:40:30 +00:00
python main.py
2018-12-13 11:05:32 +00:00
Open/reload in browser webui/index.html. (javascript must be enabled)
2018-12-30 15:12:30 +00:00
Check in your client code if the laser server IP is the good one
2018-12-13 11:05:32 +00:00
Run your client
to monitor redis server :
redis-cli monitor
Case 2 : Server and Client computers are different :
Say the laser server computer (running LJ) IP is 192.138.1.13, the client computer is 192.168.1.52
On the server computer :
edit /etc/redis/redis.conf
2018-12-30 15:12:30 +00:00
use -r argument :
2018-12-27 11:40:30 +00:00
python main.py -r 192.168.1.13
2018-12-13 11:05:32 +00:00
2018-12-30 15:12:30 +00:00
run the client on client computer, like :
2018-12-13 11:05:32 +00:00
node testredis.js
to monitor redis server :
2018-12-30 15:12:30 +00:00
redis-cli -h redisserverIP monitor
2018-12-13 11:05:32 +00:00
#
# Todo
#
(Doc in Progress)
- kpps live modification for glitch art.
- Improve Bhoreal & LaunchPad inputs
- Improve WebUI with simulator.
- Warp corrections should not used warpdestinations default values in conf file.
#
# Ether dream configuration
#
![Etherdream Laser DAC](https://www.ether-dream.com/ed2-external.jpg)
This program suppose that the ether dream is configured in a certain way especially for its IP address. For ether dream 1 : write an autoplay.txt file inside an SD Card within the ether dream DAC, with the following lines you can adjust i.e for pps or fps. Yes, there is a builtin DHCP client in the ether dream DAC but if you run multiple lasers, having a fixed dedicated network makes you focus on laser stuff.
/net/ipaddr 192.168.1.3
/net/netmask 255.255.255.0
/net/gateway 192.168.1.1
/ilda/pps 25000
/ilda/fps 25
About hardware setup, especially if you have several lasers : ILDA cables are insanely expensive. You may consider the Power Over Ethernet 'POE' option. Buy a very small ILDA cable, a POE splitter and connect everything to the ether dream fixed near your laser. You can have then a simple and very long network cable and use a Power Over Ethernet injector or switch closed to the driving computer. Beware some vendors use 24V POE Injector : POE injectors and splitters must match.
#
# Coordinates if you use the proj() function
#
3D points (x,y,z) has *0,0,0 in the middle*
A square centered around origin and size 200 (z =0 is added automatically) :
([-200, -200, 0], [200, -200, 0], [200, 200, 0], [-200, 200, 0], [-200, -200, 0])
Pygame screen points are 2D. *0,0 is top left*
with no 3D rotations + 3D -> 2D Projection + translation to top left:
[(300.0, 400.0), (500.0, 400.0), (500.0, 200.0), (300.0, 200.0), (300.0, 400.0)]
Pygame points with color is fed to laser renderer
[(300.0, 400.0, 0), (500.0, 400.0, 16776960), (500.0, 200.0, 16776960), (300.0, 200.0, 16776960), (300.0, 400.0, 16776960)]
Laser points traced
Because of blanking many points are automatically added and converted in etherdream coordinates system -32765 to +32765 in x and y axis.
16 (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 65280, 65280, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0), (-1500.0, 1500.0, 0, 0, 0)
8 (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0), (1500.0, 1500.0, 65280, 65280, 0)
8 (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0), (1500.0, -1500.0, 65280, 65280, 0)
8 (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0), (-1500.0, -1500.0, 65280, 65280, 0)