lapin
/
LJ
forked from protonphoton/LJ
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Easyer doc for newcomers.

This commit is contained in:
Sam 2020-10-11 15:29:54 +02:00
parent bfae3baa37
commit 3b0d44deb1
1 changed files with 9 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
README.md
View File

@ -7,15 +7,15 @@ LICENCE : CC BY
![LJ](https://www.teamlaser.fr/lj/images/lj2.png)
LJ is like a video projector where you fire images and forget. Lasers are dangerous : you can really fire real world objects. As content creator, it's damn easy to send frames. LJ is the heavy lifter for up to 4 lasers live actions. Think creative like games, Laser "battles", planetarium, sharing available lasers in demoparties for competition,...
LJ is like a video projector where you fire images and forget. Lasers are dangerous : you can really fire real world objects. As content creator, it's damn easy to send frames : LJ do the heavy lifting for up to 4 lasers live actions. Think creative like games, Laser "battles", planetarium, sharing available lasers in demoparties for competition,...
LJ has 5 main components :
- "Inputs" are "frames" generators to one or more lasers. Generators can be program "plugins" managed by LJ or you can feed the "connectors" directly. Remember with laser : *one frame = one polyline*, like in LOGO.
- Frame *generators* to one or more lasers. Generators can be program "plugins" managed by LJ or you can feed the "connectors" directly. Remember with laser : *one frame = one polyline*, like in LOGO.
- A "tracer" per etherdream/laser that take its given point list, correct geometry, recompute in laser controller coordinates, send it to its controller and report its status to the "manager".
- A "manager" that talk to all tracers (which point lists to draw, new geometry correction,...), handle IOs (webui functions, OSC commands,...) and plugins.
- A web GUI in html, css, and vanilla js. This UI can be used in a tablet, computer, whatever. LJ does not come with an html server but absolutely can . This GUI has a (currently slow) simulator, but one can also use an etherdream/laser emulator (see nannou simulator below) to work without physical lasers !!
- A network available database (redis). "Plugins" can send directly their pointlists to redis. Each "tracer" is instructed to get one of the avalaible pointlist in redis.
- A web GUI in html, css, and vanilla js. *Yes, there is a builtin simulator* so you can create without actual lasers. This UI can be used in a tablet, computer, whatever. You can open www directory and load html files. To not mess with user computer, it's "bring your own webserver".
- Frame *connectors* for pointlists, if you don't want to talk directly to the network available database (redis). Each "tracer" is instructed to get one of the avalaible pointlist in redis.
"Frames connectors" are :
@ -68,7 +68,7 @@ You can't specify an output framerate. It depends on your pointlist and laser mi
Inside "clitools" every point is [x,y,color]
See command reference for extensive documentation, but /pl is the only one you need to draw something.
See command reference for extensive documentation, but /pl is the only one you need to draw something. The webUI is here to masquerade all these commands.
@ -149,7 +149,8 @@ type all install.sh commands beginning line 4. An OS X install script soon !!
- KVM :
an ISO is available here : https://www.tmplab.org/wp-content/lazer-iso.zip
- Postinstall for all :
## Postinstall for all :
You probably want redis bound to all network interfaces : comment the bind line in /etc/redis/redis.conf and restart it.
@ -338,6 +339,8 @@ To use this visualiser as one of LJ's lasers, in LJ.conf edit one of line ip = s
#
You need to update LJ.conf to your network/etherdreams IPs and be sure to check command arguments : python3 configure.py
LJ is network based and this is *critical and flickering reason #1* if not managed properly, especially if you have several lasers.
Our "always working solution", as we regularly move our gear for different venues :
@ -357,8 +360,6 @@ By default LJ uses on 127.0.0.1 (localhost) :
- Some OSC clients defined in LJ.conf to forward commands to defined plugins.
You need to update LJ.conf to your network/etherdreams IPs and be sure to check command arguments : python3 main.py --help
The need for 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 idea and/or stop process interfering like redis monitoring,...
#