Vixen Plugin Development: Difference between revisions

From doityourselfchristmas.com
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
Although [[Vixen]] provides a standard set of [[Vixen_Plugins|plugins]] for a variety of hardware, individuals with different or custom hardware will need to develop their own plugin.  Plugin development requires Microsoft Visual Studio, or another development environment for coding and compilation using Microsoft's .NET framework.
Although [[Vixen]] provides a standard set of [[Vixen_Plugins|plugins]] for a variety of hardware, individuals with different or custom hardware will need to develop their own plugin.  Plugin development requires Microsoft Visual Studio, or another development environment for coding and compilation using Microsoft's .NET framework.
==Example Source Code==
[http://www.vixenlights.com/downloads.html Source code] for the Parallel 12 plugin is available to assist plugin developers.  The plugin is written in C# and works with Vixen 1.*.
Modifications are required for the plugin to work with Vixen 2.0:
* Change the <code>Parallel12</code> class to implement the <code>IEventDrivenOutputPlugIn</code>, <code>IOutputPlugIn</code>, <code>IPlugIn</code> interfaces instead of the <code>PlugIn</code> interface.
* Change the first parameter of the the <code>Initialize</code> to <code>IExecutable executable</code>. The <code>List<Channels> Channels</code> property of <code>IExecutable</code> can be used in place of the <code>Channel[] channels</code> parameter.
* In the <code>get</code> method for the <code>HardwareMap</code> property, change the call to <code>new HardwareMap</code> to pass the string constant <code>"Parallel"</code> as its first parameter.  The enumeration <code>PortType</code> no longer exists.


==Resources==
==Resources==
*[http://www.vixenlights.com/files/Vixen%20Programmer%27s%20Guide.zip Programmer's Guide] (Only for Vixen 1.*)
*[http://www.vixenlights.com/downloads.html Programmer's Guide] (Only for Vixen 1.*)
*[http://www.vixenlights.com/files/Parallel12.zip Example Source Code] (Only for Vixen 1.*)
*[http://www.vixenlights.com/downloads.html Example Source Code] (Only for Vixen 1.*)

Revision as of 13:44, 12 July 2008

Although Vixen provides a standard set of plugins for a variety of hardware, individuals with different or custom hardware will need to develop their own plugin. Plugin development requires Microsoft Visual Studio, or another development environment for coding and compilation using Microsoft's .NET framework.

Example Source Code

Source code for the Parallel 12 plugin is available to assist plugin developers. The plugin is written in C# and works with Vixen 1.*.

Modifications are required for the plugin to work with Vixen 2.0:

  • Change the Parallel12 class to implement the IEventDrivenOutputPlugIn, IOutputPlugIn, IPlugIn interfaces instead of the PlugIn interface.
  • Change the first parameter of the the Initialize to IExecutable executable. The List<Channels> Channels property of IExecutable can be used in place of the Channel[] channels parameter.
  • In the get method for the HardwareMap property, change the call to new HardwareMap to pass the string constant "Parallel" as its first parameter. The enumeration PortType no longer exists.

Resources