resources: add OS2L plugin documentation

mcallegari · Mar 31, 2019 · 3686fff · 3686fff
1 parent 8ed5fc9
commit 3686fff
Show file tree

Hide file tree

Showing 8 changed files with 78 additions and 0 deletions.
diff --git a/debian/changelog b/debian/changelog
@@ -4,6 +4,7 @@ qlcplus (4.12.2) stable; urgency=low
   * Simple Desk: fix universe reset erasing channel modifiers
   * Virtual Console/Slider: fix LTP channels being written continuously
   * Fixture Editor: fix 'Nothing' type not handled correctly
+  * NEW OS2L plugin (see documentation)
   * New fixture: Martin MAC Encore Performance (thanks to Flo Edelmann)
 
  -- Massimo Callegari <massimocallegari@yahoo.it>  Sun, 26 May 2019 12:13:14 +0200

diff --git a/platforms/linux/qlcplus.spec b/platforms/linux/qlcplus.spec
@@ -89,6 +89,7 @@ INSTALL_ROOT=$RPM_BUILD_ROOT make install
 %_libdir/qt5/plugins/qlcplus/libdmxusb.so
 %_libdir/qt5/plugins/qlcplus/libpeperoni.so
 %_libdir/qt5/plugins/qlcplus/libudmx.so
+%_libdir/qt5/plugins/qlcplus/libos2l.so
 %_libdir/qt5/plugins/qlcplus/libosc.so
 %_libdir/qt5/plugins/qlcplus/libartnet.so
 %_libdir/qt5/plugins/qlcplus/libe131.so

diff --git a/resources/docs/html_en_EN/index.html b/resources/docs/html_en_EN/index.html
@@ -134,6 +134,7 @@ <H2><img src="qrc:/input_output.png" width=32 align="absmiddle"> Plugins</H2>
      <LI><A HREF="file:loopbackplugin.html">Loopback</A></LI>
      <LI><A HREF="file:midiplugin.html">MIDI</A></LI>
      <LI><A HREF="file:olaplugin.html">OLA</A></LI>
+     <LI><A HREF="file:os2lplugin.html">OS2L</A></LI>
      <LI><A HREF="file:oscplugin.html">OSC</A></LI>
      <LI><A HREF="file:peperonioutput.html">Peperoni</A></LI>
      <LI><A HREF="file:udmxoutput.html">uDMX</A></LI>

diff --git a/resources/docs/html_en_EN/index_pdf.html b/resources/docs/html_en_EN/index_pdf.html
@@ -106,6 +106,7 @@
      <LI><A HREF="file:loopbackplugin.html">Loopback</A></LI>
      <LI><A HREF="file:midiplugin.html">MIDI</A></LI>
      <LI><A HREF="file:olaplugin.html">OLA</A></LI>
+     <LI><A HREF="file:os2lplugin.html">OS2L</A></LI>
      <LI><A HREF="file:oscplugin.html">OSC</A></LI>
      <LI><A HREF="file:peperonioutput.html">Peperoni</A></LI>
      <LI><A HREF="file:udmxoutput.html">uDMX</A></LI>

diff --git a/resources/docs/html_en_EN/os2lplugin.html b/resources/docs/html_en_EN/os2lplugin.html
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<HTML>
+<HEAD>
+<TITLE>Q Light Controller Plus - OS2L Plugin</TITLE>
+<SCRIPT SRC="utility.js" TYPE="text/javascript"></SCRIPT>
+<link href="style.css" rel="stylesheet" type="text/css" />
+</HEAD>
+<BODY onLoad="replaceqrc()">
+
+<H1>OS2L plugin</H1>
+
+<H2>Introduction</H2>
+<P>
+The OS2L plugin allows direct communication between QLC+ and an OS2L capable host.
+OS2L specifications can be found at: http://os2l.org/
+At the moment the only OS2L host supported is Virtual DJ.
+QLC+ OS2L plugin will work either on the same host (127.0.0.1) or on a different host with
+an OS of your choice (Windows, macOS, Linux)
+</P>
+
+<H2>Configuration - Virtual DJ</H2>
+
+<P>
+First and foremost, you need to tell VDJ where to send OS2L messages.<br>
+Open VDJ settings, go to the 'Options' panel and type 'os2l' in the top search box.<br>
+Modify the 'os2lDirectIp' field by setting the IP:port where VDJ can reach QLC+.
+For example, '127.0.0.1:9996' should work if QLC+ runs on the same (Windows) PC of VDJ.<br>
+Once done, restart VDJ.<br>
+<br>
+Now go to QLC+, enable the OS2L plugin on any universe. If you have set a specific port in VDJ,
+open the OS2L configuration dialog and set the same port there.<br>
+Once done, QLC+ will start receiving signals from VDJ (joystick icon will blink beside the Universe box)
+</P>
+
+</BODY>
+</HTML>
diff --git a/resources/docs/html_ja_JP/index.html b/resources/docs/html_ja_JP/index.html
@@ -133,6 +133,7 @@ <H2><img src="qrc:/input_output.png" width=32 align="absmiddle"> Plugins</H2>
      <LI><A HREF="file:loopbackplugin.html">Loopback</A></LI>
      <LI><A HREF="file:midiplugin.html">MIDI</A></LI>
      <LI><A HREF="file:olaplugin.html">OLA</A></LI>
+     <LI><A HREF="file:os2lplugin.html">OS2L</A></LI>
      <LI><A HREF="file:oscplugin.html">OSC</A></LI>
      <LI><A HREF="file:peperonioutput.html">Peperoni</A></LI>
      <LI><A HREF="file:udmxoutput.html">uDMX</A></LI>

diff --git a/resources/docs/html_ja_JP/index_pdf.html b/resources/docs/html_ja_JP/index_pdf.html
@@ -107,6 +107,7 @@
      <LI><A HREF="file:loopbackplugin.html">Loopback</A></LI>
      <LI><A HREF="file:midiplugin.html">MIDI</A></LI>
      <LI><A HREF="file:olaplugin.html">OLA</A></LI>
+     <LI><A HREF="file:os2lplugin.html">OS2L</A></LI>
      <LI><A HREF="file:oscplugin.html">OSC</A></LI>
      <LI><A HREF="file:peperonioutput.html">Peperoni</A></LI>
      <LI><A HREF="file:udmxoutput.html">uDMX</A></LI>

diff --git a/resources/docs/html_ja_JP/os2lplugin.html b/resources/docs/html_ja_JP/os2lplugin.html
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<HTML>
+<HEAD>
+<TITLE>Q Light Controller Plus - OS2L Plugin</TITLE>
+<SCRIPT SRC="utility.js" TYPE="text/javascript"></SCRIPT>
+<link href="style.css" rel="stylesheet" type="text/css" />
+</HEAD>
+<BODY onLoad="replaceqrc()">
+
+<H1>OS2L plugin</H1>
+
+<H2>Introduction</H2>
+<P>
+The OS2L plugin allows direct communication between QLC+ and an OS2L capable host.
+OS2L specifications can be found at: http://os2l.org/
+At the moment the only OS2L host supported is Virtual DJ.
+QLC+ OS2L plugin will work either on the same host (127.0.0.1) or on a different host with
+an OS of your choice (Windows, macOS, Linux)
+</P>
+
+<H2>Configuration - Virtual DJ</H2>
+
+<P>
+First and foremost, you need to tell VDJ where to send OS2L messages.<br>
+Open VDJ settings, go to the 'Options' panel and type 'os2l' in the top search box.<br>
+Modify the 'os2lDirectIp' field by setting the IP:port where VDJ can reach QLC+.
+For example, '127.0.0.1:9996' should work if QLC+ runs on the same (Windows) PC of VDJ.<br>
+Once done, restart VDJ.<br>
+<br>
+Now go to QLC+, enable the OS2L plugin on any universe. If you have set a specific port in VDJ,
+open the OS2L configuration dialog and set the same port there.<br>
+Once done, QLC+ will start receiving signals from VDJ (joystick icon will blink beside the Universe box)
+</P>
+
+</BODY>
+</HTML>