From c6bc7edb8cd745d1514638cf47d535c193ff2e5d Mon Sep 17 00:00:00 2001 From: Thomas White Date: Mon, 28 Jun 2021 18:26:13 +0200 Subject: Add doc about fixture display --- docs/fixture-display.rst | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) create mode 100644 docs/fixture-display.rst diff --git a/docs/fixture-display.rst b/docs/fixture-display.rst new file mode 100644 index 0000000..d7cbf02 --- /dev/null +++ b/docs/fixture-display.rst @@ -0,0 +1,33 @@ +========================= +Graphical fixture display +========================= + +The Starlet fixture display tool creates a graphical view of your fixtures, +more like a traditional lighting desk. It will show a rectangle representing +each patched fixture, indicating the selected fixtures via a highlight. + +As well as displaying information, the fixture display responds to a few key +presses: escape to deselect all fixtures, as well as keypad 'enter' and 'plus' +for sending 'go' and 'stop' commands (respectively) to a playback named ``pb``. + +This tool communicates with Starlet in the same way that you do, the Guile +REPL. You'll need to tell Guile to create a Unix domain socket to connect to, +via an additional option:: + + guile --listen=/home/user/guile.socket + +Now start the fixture display tool with:: + + starlet-fixture-display -s /home/user/guile.socket + +Obviously, the filenames for both commands must match. Replace it with +something appropriate for your setup. + +Note that Guile requires an absolute path for the socket filename, otherwise it +will be interpreted as a network location. Exposing the REPL via a network +port should work as well, but you should not do it that way unless you +**really** understand the risks. + +Add option ``-v`` to the fixture display tool to see the REPL communications. +Warning: extreme console spam if you use this option. + -- cgit v1.2.3