doityourselfchristmas.com - User contributions [en]

Vixen Plugin Development

2009-12-14T08:04:07Z

JonathonReinhart: /* Interface Definition */

[[Category:Vixen]]
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.

==Vixen 2.0 & 2.5==
In essence, all that is required to write your own output plugin for Vixen is to implement the <code>IEventDrivenOutputPlugin</code> interface (which also implies the <code>IOutputPlugIn</code> and <code>IPlugIn</code> interfaces.)

The simplest way to do this is to first create a new C# Class Library (.dll) project. Next, you must add Vixen.exe as a Reference to your project, giving you access to the Vixen namespace, which you can use by adding "<code>using Vixen;</code>". After this, your class must inherit the <code>IEventDrivenOutputPlugin</code> interface. Finally, add the required functions to your class definition. In Visual Studio, function prototypes can easily be added for you by right-clicking <code>: IEventDrivenOutputPlugin</code> and selecting "Implement Interface > Implement Interface".

===Interface Definition===
IEventDrivenOutputPlugin (Combined into one definition for clarity):

''Note:'' The return type for Startup() has changed from Vixen 2.0 to 2.5. See notes below:
<code>
public interface IEventDrivenOutputPlugIn : IOutputPlugIn, IHardwarePlugin, IPlugIn, ISetup
{
void Event(byte[] channelValues);
//Called when the plug-in needs to update the hardware state during execution.
// channelValues: Event values in channel order, 1 byte per channel.

void Initialize(IExecutable executableObject, SetupData setupData, XmlNode setupNode);
// Called anytime Vixen needs to make sure the plug-in's setup or other initialization is up to date.
// Initialize is called before the plug-in is setup, before sequence execution, and other times.
// It's called from multiple places at any time, therefore the plug-in can make no assumptions
// about the state of the program or sequence due to a call to Initialize.
// executableObject: An object which provides methods and fields which represent the
// executable object (typically a sequence) which is executing.
// setupData: A SetupData reference that provides some plug-incentric convenience methods.
// It can be safely ignored.
// setupNode: An XmlNode representing the root of the plug-in's setup data in the sequence.
// Please see the Vixen.Xml class for some convenience methods.

HardwareMap[] HardwareMap { get; }
// Provide an array of the hardware resources this plugin is using.

void Setup();
// Called when the user has requested to setup the plug-in instance. (Select COM Ports, etc)

void Shutdown();
// Called when execution is stopped or the plug-in instance is no longer going to be referenced.

// Vixen 2.0:
List<Form> Startup()
// Called when a sequence is executed.
// Returns a list of forms that the plug-in needs to have injected into Vixen's MDI interface.
// The previews are examples of plug-ins that return forms for this purpose.

// Vixen 2.5:
void Startup();
// Called when a sequence is executed. MDI forms are now handled differently.

string Author { get; } // The author's name
string Description { get; } // This plugin's description
string Name { get; } // This plugin's name
string ToString(); // Usually returns Name
}
</code>

===Example Source Code===
The source code for the Elexol USB 24 I/O plugin is available [http://lights.onthefive.com/vixen-plugins here].

==Vixen 1.* (outdated)==

===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==
*[http://www.vixenlights.com/downloads.html Programmer's Guide] (Only for Vixen 1.*)
*[http://www.vixenlights.com/downloads.html Example Source Code] (Only for Vixen 1.*)

Vixen Plugin Development

2009-12-14T08:02:52Z

JonathonReinhart:

[[Category:Vixen]]
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.

==Vixen 2.0 & 2.5==
In essence, all that is required to write your own output plugin for Vixen is to implement the <code>IEventDrivenOutputPlugin</code> interface (which also implies the <code>IOutputPlugIn</code> and <code>IPlugIn</code> interfaces.)

The simplest way to do this is to first create a new C# Class Library (.dll) project. Next, you must add Vixen.exe as a Reference to your project, giving you access to the Vixen namespace, which you can use by adding "<code>using Vixen;</code>". After this, your class must inherit the <code>IEventDrivenOutputPlugin</code> interface. Finally, add the required functions to your class definition. In Visual Studio, function prototypes can easily be added for you by right-clicking <code>: IEventDrivenOutputPlugin</code> and selecting "Implement Interface > Implement Interface".

===Interface Definition===
IEventDrivenOutputPlugin (Combined into one definition for clarity):
<code>
public interface IEventDrivenOutputPlugIn : IOutputPlugIn, IHardwarePlugin, IPlugIn, ISetup
{
void Event(byte[] channelValues);
//Called when the plug-in needs to update the hardware state during execution.
// channelValues: Event values in channel order, 1 byte per channel.

void Initialize(IExecutable executableObject, SetupData setupData, XmlNode setupNode);
// Called anytime Vixen needs to make sure the plug-in's setup or other initialization is up to date.
// Initialize is called before the plug-in is setup, before sequence execution, and other times.
// It's called from multiple places at any time, therefore the plug-in can make no assumptions
// about the state of the program or sequence due to a call to Initialize.
// executableObject: An object which provides methods and fields which represent the
// executable object (typically a sequence) which is executing.
// setupData: A SetupData reference that provides some plug-incentric convenience methods.
// It can be safely ignored.
// setupNode: An XmlNode representing the root of the plug-in's setup data in the sequence.
// Please see the Vixen.Xml class for some convenience methods.

HardwareMap[] HardwareMap { get; }
// Provide an array of the hardware resources this plugin is using.

void Setup();
// Called when the user has requested to setup the plug-in instance. (Select COM Ports, etc)

void Shutdown();
// Called when execution is stopped or the plug-in instance is no longer going to be referenced.

// Vixen 2.0:
List<Form> Startup()
// Called when a sequence is executed.
// Returns a list of forms that the plug-in needs to have injected into Vixen's MDI interface.
// The previews are examples of plug-ins that return forms for this purpose.

// Vixen 2.5:
void Startup();
// Called when a sequence is executed. MDI forms are now handled differently.

string Author { get; } // The author's name
string Description { get; } // This plugin's description
string Name { get; } // This plugin's name
string ToString(); // Usually returns Name
}
</code>

===Example Source Code===
The source code for the Elexol USB 24 I/O plugin is available [http://lights.onthefive.com/vixen-plugins here].

==Vixen 1.* (outdated)==

===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==
*[http://www.vixenlights.com/downloads.html Programmer's Guide] (Only for Vixen 1.*)
*[http://www.vixenlights.com/downloads.html Example Source Code] (Only for Vixen 1.*)

Electronics Hardware

2009-12-14T07:23:09Z

JonathonReinhart: /* Pictures of Various Coop Boards (mostly assembled) */

This page contains links to ChristmasWiki entries relating to electronics hardware. It also has an overview of various types of DIY hardware that works with [[Vixen]] software.

==Links==

[[Hardware Design Guidelines]]- The DIYC community standard for hardware design. It is recommended that you check your electronic device and PCB designs against this standard.

[[Co-Op Boards and Assembly Instructions]]- Assembly instructions and documentation on boards that can be obtained through a DIYC COOP.

[[Comparison of DIY Boards]]- Charts that compare statistics on various COOP boards, including their channel count, cost, and COOP status.

[[Renard Main Page]]- Renard is a simple PIC-Based Light Dimmer Controller for use with Vixen.

[[Solid State Relays]]- Solid State Relays (SSRs) are used for switching of mains-voltage lights in a computerized display.

[[DMX to Grinch/595 convertor]]- How to make your Grinch speak DMX.

[[All In One Tester]]- A single unit for testing controllers, cables, and SSR's

[[Olsen 595]]- How to make an Olsen 595 controller at home.

[[DMX ROBO Spot Light]]- How to build a Robotic Full Color Spotlight.

[[Control boards and Contacts]]- list of board designs found on DIYC and contact sources for them.

[[Compatible Serial Adapters]]- list of known serial port adapters that will work with our displays.

==Overview of DIY Hardware Approaches That Work With Vixen==

This section provides information about Do-It-Yourself (DIY) hardware that works with the [[Vixen]] software program. Vixen is a Windows (.NET Framework 2) program that runs on a PC, and is used to create and run light shows that may be synchronized to music. Here is a brief list of the DIY approaches that you can take that will work with Vixen.

===Non-Dimmable Light Controllers===

====SSR Direct Attach====

* Controlled through: Parallel Port
* Documentation: [[Solid State Relays]]

If you need 12 or fewer channels, you can just buy or build SSRs and connect them to the parallel port on your PC, and use them to turn 110VAC light strings (or just plain lamps) on and off (no dimming). These ssrs must be sourced or positive switched. From time to time there are coop buys of SSR boards,but these are usually sinked, and/or parts, to reduce your expense. You could place a couple ULN2803s and use the coop sinked ssrs. For more information on this come over to the forum and/or ask on the LiveChat.

====Kit74====
*Controlled through: Parallel Port

This is a kit with mechanical relays that can be purchased from various places. It is similar to the SSR Direct Attach, although the mechanical relays are noisy and have a limited lifespan. There are probably other similar kits available as well.

====Hill320====
* Controlled through: Parallel Port
* Documentation: http://computerchristmas.com/christmas/link-how_to/HowToId-4/How_To_Build_A_Parallel_Port_Controller_Box

This is a controller originally designed by Hill Robertson http://computerchristmas.com to allow up to 320 channels to be controlled by a PC, and requires an external power supply and SSRs. There isn't any coop board for this design at the moment. It is a more complicated design, and it is not currently recommended for newbies.

====Olsen 595/Grinch====
*Controlled through: Parallel Port
*Documentation: [[The GRINCH Controller]], [[GRINCH Controller Assembly Instructions]]
*Documentation: [[Olsen 595]]

This is a popular controller based on an approach first popularized on the http://computerchristmas.com and/or http://planetchristmas.com forums by Peter Olsen. In its first incarnation it used 8-bit 74HC595 logic chips, often with external buffers, while a later design (Grinch), popularized by Robert Jordan, uses 16-bit chips specialized for this use. There are coop boards available for both of these designs. These coop boards need external power supplies, and work with external (coop) SSR boards to control AC lighting.

There are some variations of this approach that support dimming, but they are not as popular and there aren't any coop boards available. However, using a [[Ren-C]] board can add dimming capability to a 595 or Grinch, which causes the board to operate as a Renard board. There is also an option available to run a Grinch or 595 from DMX, [[DMX to Grinch/595 convertor|here]].

The Grinch board is a good choice if you need more than 12 channels but want a board that is simple to build. It doesn't use very many parts, and is easy to assemble.

===Dimmable Light Controllers===
====Firegod====
*Controlled through : Serial Port
*Documentation: [[Firegod]]

This is a modular system that supports 32 to 128 channels per serial port, in increments of 32 channels, with 100 levels of dimming (using pulse width modulation - PWM). It consists of a host controller module and one to four field modules. The SSRs are not included on these boards, and must be provided separately. The interface to this system is RS-232. This system is available on a coop basis from time to time, with the kits including the boards, the parts, and pre-programmed microcontroller chips (PICs). This board is intermediate in complexity to build.

====Renard====
*Controlled through: Serial Port
*Documentation: [[Renard]]

This is another modular system that supports a varying number of channels, depending on baud rate selection. It supports 256 levels of dimming, and can be configured with or without PWM, or for use in DC applications. There are several coop boards available for this system with varying capabilities. It can be a fairly complex system because there are so many options. More information is available at the link listed above.

====Lynx====
*Controlled through: [[DMX]]
*Manual [[LYNX_Controller_Manual]]
The Lynx is a DIY dimmer design that uses [[DMX]] as its protocol but uses standard Cat5 cable for interconnections. It's designed to be similar to the layout of commercially available dimmers (LOR, AL, etc). It is an all in one unit that has its own power supply and SSR's built into it. You connect your DMX Cat5 and plug it in. Lights plug into female cord connections that exit from the board. It allows for a full 256 levels of dimming. The starting address is programmed via vixen. Since it uses the DMX protocol you can run 512 channels of Lynx on one DMX universe at 25ms timming.

In an effort to prevent variations in the design (leading to complications for the newer builders), insure that troubleshooting help can be provided, and keep the total cost as low as possible it is done as a modified coop. All the parts including the PCB and an enclosure are included. The necessary PIC microprocessor will come with the program preloaded so that the builder will not need a PIC programmer. A detailed instruction manual with pictures is included and should allow anyone with basic soldering skills to successfully build the controller.

===Other Controllers (Signs, Servos, etc.)===
====Ledtriks====
*Controlled through: Parallel Port
*Documentation: [[LedTriks Controller Assembly Instructions]] [http://www.christmasinshirley.com/wiki/images/8/8e/LEDTriks_Wiring_Schematic.pdf LedTriks Wiring Diagram]

This is a controller to control low-voltage LED panels, designed by Robert Jordan. These panels are typically 16 LEDs high by 48 LEDs wide, for a total of 768 LEDs. Vixen can control up to four panels through one parallel port, and can even display text.

====Triks-C====
*Controlled through: Serial port or standalone
*Documentation: [[TRIKSC]], [http://www.christmasinshirley.com/wiki/index.php?title=Image:TRIKSC_CONTROLLER_v.0.1_manual.pdf Manual in PDF format]

This is a an add on controller/process for the Ledtricks. One of the problems with the original LEDTRIKS design was the load placed on the PC to chunk the data out the parallel port. The TRIKS-C uses a ATMEL process to take a LEDSTRIKS file and send it out to the LEDTRIKS Controller, via the serial prot.

====JEC Pixel Displays====
*Controlled through: [[DMX]]

Pixels are a stand-alone lighting fixture controlled by DMX-512. Each pixel has banks of red, green and blue wide-angle LEDs, currently six of each. Firmware is available in two versions: 3 and 4 channel. 3 channel requires a dmx channel for red, green and blue intensity. Four channel adds master intensity control to the original three.

Pixels require a stiff +12v switching power supply. Each circuit board draws ~ 130 mA at full brightness. Pixels chain together using standard CAT5 networking cable. Per the DMX spec, no more than 32 pixels should be connected together without using an optosplitter / signal buffer.

LED refresh rate is nearly 100 Hz.

More details can be found at http://www.response-box.com/rgblights

Currently in progress is a version of the firmware which will allow the DMX address to be changed in the field. Currently the address is hard-coded.

====rgbLED====
TBA

==Pictures of Various Coop Boards (mostly assembled)==
<gallery caption="Coop Boards (mostly assembled)" widths="150px" heights="150px" perrow="4">

Image:SSROZ 2.5a (small).jpg|[[4_Channel_SSROZ_Assembly_Instructions | SSR (solid state relay)]]
Image:SSRez.jpg|[[SSRez | SSR (solid state relay ez)]]
Image: coop595.jpg|[[64_Channel_Olsen_595_Controller_Assembly_Instructions | 595 Coop Board]]
Image: Coopgrinch.jpg|[[GRINCH_Controller_Assembly_Instructions | Grinch]]
Image: Ren24.jpg|[[24 Channel Renard with SSR Assembly Instructions | Renard by FKostyun: 24 ports with on-board power supply and SSRs]]
Image:Wiki_-_Renard_SS8_Complete.jpg|Renard SS 8
Image:Wiki_-_Renard_SS16_Completed_Board.jpg|Renard SS 16
Image:Wiki_-_Renard_SS24_Completed_Board.jpg|Renard SS 24
Image:xmus.jpg|[[16_Channel_Renard_with_SSRs | Ren16 (xmus)]]

</gallery>

==Commercial Products Supported By Vixen==

===Digital Input/Output Cards===

*[[PCI-DIO-96]] by National Instruments
*[http://www.elexol.com/IO_Modules/USB_IO_24.php Elexol USB I/O 24] - ([http://lights.onthefive.com/vixen-plugins Plugin] by Jonathon Reinhart)
*[http://www.elexol.com/IO_Modules/Ether_IO_24.php Elexol Ether I/O 24] - ([http://lights.onthefive.com/vixen-plugins Plugin] by Jonathon Reinhart)

Electronics Hardware

2009-12-14T07:22:28Z

JonathonReinhart: /* Digital Input/Output Cards */

This page contains links to ChristmasWiki entries relating to electronics hardware. It also has an overview of various types of DIY hardware that works with [[Vixen]] software.

==Links==

[[Hardware Design Guidelines]]- The DIYC community standard for hardware design. It is recommended that you check your electronic device and PCB designs against this standard.

[[Co-Op Boards and Assembly Instructions]]- Assembly instructions and documentation on boards that can be obtained through a DIYC COOP.

[[Comparison of DIY Boards]]- Charts that compare statistics on various COOP boards, including their channel count, cost, and COOP status.

[[Renard Main Page]]- Renard is a simple PIC-Based Light Dimmer Controller for use with Vixen.

[[Solid State Relays]]- Solid State Relays (SSRs) are used for switching of mains-voltage lights in a computerized display.

[[DMX to Grinch/595 convertor]]- How to make your Grinch speak DMX.

[[All In One Tester]]- A single unit for testing controllers, cables, and SSR's

[[Olsen 595]]- How to make an Olsen 595 controller at home.

[[DMX ROBO Spot Light]]- How to build a Robotic Full Color Spotlight.

[[Control boards and Contacts]]- list of board designs found on DIYC and contact sources for them.

[[Compatible Serial Adapters]]- list of known serial port adapters that will work with our displays.

==Overview of DIY Hardware Approaches That Work With Vixen==

This section provides information about Do-It-Yourself (DIY) hardware that works with the [[Vixen]] software program. Vixen is a Windows (.NET Framework 2) program that runs on a PC, and is used to create and run light shows that may be synchronized to music. Here is a brief list of the DIY approaches that you can take that will work with Vixen.

===Non-Dimmable Light Controllers===

====SSR Direct Attach====

* Controlled through: Parallel Port
* Documentation: [[Solid State Relays]]

If you need 12 or fewer channels, you can just buy or build SSRs and connect them to the parallel port on your PC, and use them to turn 110VAC light strings (or just plain lamps) on and off (no dimming). These ssrs must be sourced or positive switched. From time to time there are coop buys of SSR boards,but these are usually sinked, and/or parts, to reduce your expense. You could place a couple ULN2803s and use the coop sinked ssrs. For more information on this come over to the forum and/or ask on the LiveChat.

====Kit74====
*Controlled through: Parallel Port

This is a kit with mechanical relays that can be purchased from various places. It is similar to the SSR Direct Attach, although the mechanical relays are noisy and have a limited lifespan. There are probably other similar kits available as well.

====Hill320====
* Controlled through: Parallel Port
* Documentation: http://computerchristmas.com/christmas/link-how_to/HowToId-4/How_To_Build_A_Parallel_Port_Controller_Box

This is a controller originally designed by Hill Robertson http://computerchristmas.com to allow up to 320 channels to be controlled by a PC, and requires an external power supply and SSRs. There isn't any coop board for this design at the moment. It is a more complicated design, and it is not currently recommended for newbies.

====Olsen 595/Grinch====
*Controlled through: Parallel Port
*Documentation: [[The GRINCH Controller]], [[GRINCH Controller Assembly Instructions]]
*Documentation: [[Olsen 595]]

This is a popular controller based on an approach first popularized on the http://computerchristmas.com and/or http://planetchristmas.com forums by Peter Olsen. In its first incarnation it used 8-bit 74HC595 logic chips, often with external buffers, while a later design (Grinch), popularized by Robert Jordan, uses 16-bit chips specialized for this use. There are coop boards available for both of these designs. These coop boards need external power supplies, and work with external (coop) SSR boards to control AC lighting.

There are some variations of this approach that support dimming, but they are not as popular and there aren't any coop boards available. However, using a [[Ren-C]] board can add dimming capability to a 595 or Grinch, which causes the board to operate as a Renard board. There is also an option available to run a Grinch or 595 from DMX, [[DMX to Grinch/595 convertor|here]].

The Grinch board is a good choice if you need more than 12 channels but want a board that is simple to build. It doesn't use very many parts, and is easy to assemble.

===Dimmable Light Controllers===
====Firegod====
*Controlled through : Serial Port
*Documentation: [[Firegod]]

This is a modular system that supports 32 to 128 channels per serial port, in increments of 32 channels, with 100 levels of dimming (using pulse width modulation - PWM). It consists of a host controller module and one to four field modules. The SSRs are not included on these boards, and must be provided separately. The interface to this system is RS-232. This system is available on a coop basis from time to time, with the kits including the boards, the parts, and pre-programmed microcontroller chips (PICs). This board is intermediate in complexity to build.

====Renard====
*Controlled through: Serial Port
*Documentation: [[Renard]]

This is another modular system that supports a varying number of channels, depending on baud rate selection. It supports 256 levels of dimming, and can be configured with or without PWM, or for use in DC applications. There are several coop boards available for this system with varying capabilities. It can be a fairly complex system because there are so many options. More information is available at the link listed above.

====Lynx====
*Controlled through: [[DMX]]
*Manual [[LYNX_Controller_Manual]]
The Lynx is a DIY dimmer design that uses [[DMX]] as its protocol but uses standard Cat5 cable for interconnections. It's designed to be similar to the layout of commercially available dimmers (LOR, AL, etc). It is an all in one unit that has its own power supply and SSR's built into it. You connect your DMX Cat5 and plug it in. Lights plug into female cord connections that exit from the board. It allows for a full 256 levels of dimming. The starting address is programmed via vixen. Since it uses the DMX protocol you can run 512 channels of Lynx on one DMX universe at 25ms timming.

In an effort to prevent variations in the design (leading to complications for the newer builders), insure that troubleshooting help can be provided, and keep the total cost as low as possible it is done as a modified coop. All the parts including the PCB and an enclosure are included. The necessary PIC microprocessor will come with the program preloaded so that the builder will not need a PIC programmer. A detailed instruction manual with pictures is included and should allow anyone with basic soldering skills to successfully build the controller.

===Other Controllers (Signs, Servos, etc.)===
====Ledtriks====
*Controlled through: Parallel Port
*Documentation: [[LedTriks Controller Assembly Instructions]] [http://www.christmasinshirley.com/wiki/images/8/8e/LEDTriks_Wiring_Schematic.pdf LedTriks Wiring Diagram]

This is a controller to control low-voltage LED panels, designed by Robert Jordan. These panels are typically 16 LEDs high by 48 LEDs wide, for a total of 768 LEDs. Vixen can control up to four panels through one parallel port, and can even display text.

====Triks-C====
*Controlled through: Serial port or standalone
*Documentation: [[TRIKSC]], [http://www.christmasinshirley.com/wiki/index.php?title=Image:TRIKSC_CONTROLLER_v.0.1_manual.pdf Manual in PDF format]

This is a an add on controller/process for the Ledtricks. One of the problems with the original LEDTRIKS design was the load placed on the PC to chunk the data out the parallel port. The TRIKS-C uses a ATMEL process to take a LEDSTRIKS file and send it out to the LEDTRIKS Controller, via the serial prot.

====JEC Pixel Displays====
*Controlled through: [[DMX]]

Pixels are a stand-alone lighting fixture controlled by DMX-512. Each pixel has banks of red, green and blue wide-angle LEDs, currently six of each. Firmware is available in two versions: 3 and 4 channel. 3 channel requires a dmx channel for red, green and blue intensity. Four channel adds master intensity control to the original three.

Pixels require a stiff +12v switching power supply. Each circuit board draws ~ 130 mA at full brightness. Pixels chain together using standard CAT5 networking cable. Per the DMX spec, no more than 32 pixels should be connected together without using an optosplitter / signal buffer.

LED refresh rate is nearly 100 Hz.

More details can be found at http://www.response-box.com/rgblights

Currently in progress is a version of the firmware which will allow the DMX address to be changed in the field. Currently the address is hard-coded.

====rgbLED====
TBA

==Pictures of Various Coop Boards (mostly assembled)==
<gallery caption="Coop Boards (mostly assembled)" widths="150px" heights="150px" perrow="4">

Image:SSROZ 2.5a (small).jpg|[[4_Channel_SSROZ_Assembly_Instructions | SSR (solid state relay)]]
Image:SSRez.jpg|[[SSRez | SSR (solid state relay ez)]]
Image: coop595.jpg|[[64_Channel_Olsen_595_Controller_Assembly_Instructions | 595 Coop Board]]
Image: Coopgrinch.jpg|[[GRINCH_Controller_Assembly_Instructions | Grinch]]
Image: Ren24.jpg|[[24 Channel Renard with SSR Assembly Instructions | Renard by FKostyun: 24 ports with on-board power supply and SSRs]]
Image:Wiki_-_Renard_SS8_Complete.jpg|Renard SS 8
Image:Wiki_-_Renard_SS16_Completed_Board.jpg|Renard SS 16
Image:Wiki_-_Renard_SS24_Completed_Board.jpg|Renard SS 24
Image:xmus.jpg|[[16_Channel_Renard_with_SSRs | Ren16 (xmus)]]

http://www.christmasinshirley.com/wiki/images/b/bf/SSRez.jpg
</gallery>

==Commercial Products Supported By Vixen==

===Digital Input/Output Cards===

*[[PCI-DIO-96]] by National Instruments
*[http://www.elexol.com/IO_Modules/USB_IO_24.php Elexol USB I/O 24] - ([http://lights.onthefive.com/vixen-plugins Plugin] by Jonathon Reinhart)
*[http://www.elexol.com/IO_Modules/Ether_IO_24.php Elexol Ether I/O 24] - ([http://lights.onthefive.com/vixen-plugins Plugin] by Jonathon Reinhart)

Comparison of DIY Boards

2009-12-07T07:34:14Z

JonathonReinhart: /* Light Controllers */

== Notes on the use of these charts ==

:'''The cost estimates are only that, estimates.'''
::*They are generally based on placing a Mouser order for the parts for one board using the BOM that has been provided.
::*They do not include shipping.
::*The costs may significantly lower if the parts are obtained through a coop or from other sources.
::*The price of electronic components and PCBs changes quickly.
::*Individual results will vary.
:'''My apologies to any/all board designers if I omitted some critical information.'''
 

== Board Comparison ==

:The following tables have been updated to only include boards that are actively being supported by the DoItYourselfChristmas.com community. Correct and accurate information concerning boards supported by other forums is best found there.
 

=== Light Controllers===

{| border="1" cellpadding="10" style="text-align: center;"
|-
!| Controller Board || Number of Channels || Dimmable || PC Communication Method
!| Compatible with COOP SSR || Requires External Power Supply || Estimated cost to populate 1 board || Board COOP Status || PCB Dimensions
|-
| [[Olsen 595|COOP Olsen 595]] || 64 || No¹ || Parallel Port || Yes || Yes || $40-$50 || Boards Available Contact macrosill || 4.4” x 7.8”
|-
| [[GRINCH_Controller_Assembly_Instructions|Grinch]] || 64 || No¹ || Parallel Port || Yes || Yes || $20-$25 || Boards Available Contact wjohn || 2" x 6.8"
|-
| [[The Renard SS8 Controller Board | Renard SS8]] || 8 || Yes || Serial Port (RS-232/RS-485) || N/A On-board SSRs || No || $35-$45 || Boards Available Contact Wayne J || 3.4" x 6"
|-
| [[Renard16]] (Xmus16) || 16 || Yes || Serial Port (RS-232/RS-485) || N/A On-board SSRs || Yes || $50-$60 || Boards Available Contact wjohn || 2.9" x 7"
|-
| [[The Renard SS16 Controller Board | Renard SS16]] || 16 || Yes || Serial Port (RS-232/RS-485) || N/A On-board SSRs || No || $50-$60 || Boards Available Contact Wayne J || 4.1" x 8"
|-
| [[24 Channel Renard with SSR Assembly Instructions | Renard24]] || 24 || Yes || Serial Port (RS-232/RS-485) || N/A On-board SSRs || No || $75-$85 || COOP complete contact fkostyun || 7” x 5.8”
|-
| [[The Renard SS24 Controller Board | Renard SS24]] || 24 || Yes || Serial Port (RS-232/RS-485) || N/A On-board SSRs || No || $65-$75 || Boards Available Contact Wayne J || 4" x 11"
|-
| [[Renard64]] || 64 || Yes || Serial Port (RS-232/RS-485) || Yes || Yes * Requires LV AC source || $55-$65 || Boards Available Contact wjohn || 5" x 6.5" (Rev XC)
|-
| Firegod W/ 4 field Modules || 128 || Yes || Serial Port (RS-232) || Yes (with latest firmware)
| No || $135-$145 (w/ 4 field modules) || COOP complete No boards available || 2.5" x 3.8"
|-
| [[Solid State Relays|COOP SSR]] & SSROZ V2.d || 4 || Yes || 4 Sinking inputs from Controller Boards || N/A || N/A || $10-$12 || SSR COOP complete No boards available SSROZ Boards Available Contact wjohn

|}
 

:*Note¹ - Olsen 595 and Grinch can be dimmed by using a Ren-T (or other Zero Cross source) and [[Ren-C]] board
 

=== Other Boards Available ===

{| border="1" cellpadding="10" style="text-align: center; margin: 1em auto 1em auto"
|-
!| Board || PC Communication Method || Function(s) || Estimated cost to populate board || Board COOP Status
|-
| [[Renard-595 Converter|Ren-C]] || Serial Port (RS-232)
| align="left" |
#Converts dimming Renard serial data into 595 compatable dimming data
#Creates dimming for the Olsen 595 and Grinch boards
 
:*Requires a ZC signal
|| $10-$12 || Boards Available Contact wjohn
|-
| LEDTriks || Parallel Port
| align="left" | Used to generate messages/effects on a 16 x 48 grid of LEDs || $20-$25 || Boards Available
 Contact wjohn
|}

== Board Construction Difficulty ==

:'''This information is completely subjective and opinions will vary.'''

:An empty entry does not imply no problems. It only implies that, at this posting, no first-hand experience was available to make an entry.

{| border="1" cellpadding="10" style="text-align: center; margin: 1em auto 1em auto"
!width="125"|
!width="175"|
!width="350"|
|-
!|Board || Difficulty Level || Construction Issues
|-
| COOP Olsen 595 || Easy || None
|-
| Grinch || Easy || None
|-
| Renard SS8 || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| Renard16 (Xmus16) || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| Renard SS16 || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| Renard24 || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| Renard SS24 || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| Renard64 || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| Firegod W/ 4 field Modules || Moderate
| align="left" |
|-
| COOP SSR & SSROZ V2.d || Easy || None
|-
| Ren-C || Moderate
| align="left" | - Requires a PIC programmer for the PIC IC
|-
| LEDTriks || Moderate
| align="left" | - LED panel itself a large undertaking
|}

Vixen Script Projects

2009-12-07T07:29:48Z

JonathonReinhart: /* Vixen Standard Scripts */

Vixen Script Projects are written in C#, and allow for non-sequential control of displays.

==Vixen Standard Scripts==
Vixen Standard Scrips provide basic on/off, fade/ramp, timed control. To use this, create a New Event Sequence > Script Project. Then, one must select ''Standard.dll'' from the Script > Modules menu.

===Standard.dll===
'''Note:''' The examples will use this example channel list:
* Channel_1
* Channel_2
* Channel_3
* Channel_4

====Properties====
Any of the channels imported into the scripted sequence are available by name.
Also, there is an additional "All" channel, which is all of the channels.

====Methods====
All assume to operate asynchronously; the action will return unless the Wait modifier is used (below).
* void On(channels, modifiers);
* void Off(channels, modifiers);
* void Ramp(channels, int startIntensity, int endIntensity, modifiers); // Intensities are 0-100
* void Random(channels, int saturationLevel, modifiers); // Saturation level is 0-100
* void Chase(channels, modifiers);

=====Arguments=====
"channels" is a ChannelCollection. There are a number of ways to create a ChannelCollection:

* ChannelCollection ChannelRange(startChannel, endChannel);
: Example: ChannelRange(Channel_2, Channel_4)
* ChannelCollection ChannelRange(startChannel, int count);
: Example: ChannelRange(Channel_2, 3)
* ChannelCollection ChannelRange(int startIndex, int count);
: Example: ChannelRange(1, 3)
* ChannelCollection Channels(...);
: The parameters for Channels() is a params list of channel collections. It can be used to create a single set of disjointed channel collections.
: Example: Channels( Channel_1, ChannelRange(Channel_3,2) );
: Example: Channels( ChannelRange(DateTime.Now.Hour,1), ChannelRange(10,10), Channel_2 );

"modifiers" is a params list made up of 0 or more of the following:
* At(int level) // Intensity level, 0-100
* For(int seconds) // Applies the action for the given time period.
* Over(int seconds) // Same as For(), just makes better sense in some uses.
* Wait // Wait for the action to complete.
* Every(int seconds) // Occurs at every time interval.

'''Modifier time span'''
The default measure of time is seconds. So For(5) would cause the action to span 5 seconds. The measure of time can be changed with one of the following properties on the modifer:
* Millisecond
* Second
* Minute
* Hour
: The plural version of each of those is also valid.
: Example: To have a chase span 3.7 seconds over the first 10 channels synchronously...
:: Chase( ChannelRange(1,10), Over(3700).Milliseconds, Wait )

====Example Scripts====
To have certain channels on for a given time range:
<pre>
void Start() {
Off(All);

DateTime now = DateTime.Now; //get the current time

//The DateTime constructor goes (YYYY, MM, DD, HH, MM, SS)
DateTime start = new DateTime(now.Year, now.Month, now.Day, 17, 30, 00);
DateTime end = new DateTime(now.Year, now.Month, now.Day, 23, 00, 00);

//We only want the channels to turn on while the current time is
//between 5:30 and 11 pm
while (now.CompareTo(start) >= 0 && now.CompareTo(end) <= 0)
{
On (Channels(Tree_1), At(100));
On (ChannelRange(1,15), At(100));
On (ChannelRange(18,7), At(100));
On (ChannelRange(27,8), At(100));

Random (ChannelRange(15,2), 50, For(50).Second);

now = DateTime.Now; //update the current time
}

Off(All);
}
</pre>

Vixen Script Projects

2009-12-07T07:25:10Z

JonathonReinhart: From <http://www.doityourselfchristmas.com/forums/showthread.php?t=5263>

Vixen Script Projects are written in C#, and allow for non-sequential control of displays.

==Vixen Standard Scripts==
Vixen Standard Scrips provide basic on/off, fade/ramp, timed control. To use this, create a New Event Sequence > Script Project. Then, one must select ''Standard.dll'' from the Script > Modules menu.

====Standard.dll====
'''Note:''' The examples will use this example channel list:
* Channel_1
* Channel_2
* Channel_3
* Channel_4

=====Properties=====
Any of the channels imported into the scripted sequence are available by name.
Also, there is an additional "All" channel, which is all of the channels.

=====Methods=====
All assume to operate asynchronously; the action will return unless the Wait modifier is used (below).
* void On(channels, modifiers);
* void Off(channels, modifiers);
* void Ramp(channels, int startIntensity, int endIntensity, modifiers); // Intensities are 0-100
* void Random(channels, int saturationLevel, modifiers); // Saturation level is 0-100
* void Chase(channels, modifiers);

======Arguments======
"channels" is a ChannelCollection. There are a number of ways to create a ChannelCollection:

* ChannelCollection ChannelRange(startChannel, endChannel);
: Example: ChannelRange(Channel_2, Channel_4)
* ChannelCollection ChannelRange(startChannel, int count);
: Example: ChannelRange(Channel_2, 3)
* ChannelCollection ChannelRange(int startIndex, int count);
: Example: ChannelRange(1, 3)
* ChannelCollection Channels(...);
: The parameters for Channels() is a params list of channel collections. It can be used to create a single set of disjointed channel collections.
: Example: Channels( Channel_1, ChannelRange(Channel_3,2) );
: Example: Channels( ChannelRange(DateTime.Now.Hour,1), ChannelRange(10,10), Channel_2 );

"modifiers" is a params list made up of 0 or more of the following:
* At(int level) // Intensity level, 0-100
* For(int seconds) // Applies the action for the given time period.
* Over(int seconds) // Same as For(), just makes better sense in some uses.
* Wait // Wait for the action to complete.
* Every(int seconds) // Occurs at every time interval.

======Modifier time span======
The default measure of time is seconds. So For(5) would cause the action to span 5 seconds. The measure of time can be changed with one of the following properties on the modifer:
* Millisecond
* Second
* Minute
* Hour
: The plural version of each of those is also valid.
: Example: To have a chase span 3.7 seconds over the first 10 channels synchronously...
:: Chase( ChannelRange(1,10), Over(3700).Milliseconds, Wait )

New Event Sequence

2009-12-07T07:10:18Z

JonathonReinhart: /* Vixen Script Projects */

==Ledtriks Sequence==
Creates a new LedTriks sequence, for the LedTriks LED panel display.
==Vixen Script Projects==
Creates a new scripted item. Vixen scripts are written in C# and can be used in several ways in Vixen. Learn more on the [[Vixen Script Projects]] page.

==Vixen Standard Sequence==
Creates a standard sequence, which is edited in a grid and is used to control channels of lights.
==Vixen Trigger Sequence==
Creates a response to an external hardware or software trigger.

Vixen Script Projects

2009-12-07T07:09:21Z

JonathonReinhart: New page: Vixen Script Projects stub

Vixen Script Projects stub

Vixen

2009-12-07T07:08:06Z

JonathonReinhart: Fixed link to betas

[[Category:Vixen]]
==What is Vixen?==
Vixen is Windows software running on the .NET platform that will put the computer in the do-if-yourself computer lighting animation. With a PC and some DIY [[Electronics Hardware]], anyone can have a professional looking lighting display synchronized to music.

Vixen is geared primarily towards the DIYer. For those that prefer a packaged all-in-one solution, there are commerical solutions available. For those that prefer a lower-cost DIY solution, Vixen may be the software for you. There are a broad base of software [[Vixen_Plugins | plug-ins]] to support different hardware designs. Additionally, you can create you own plug-ins to support your hardware.

==Minimum System Requirements==
''Just about any computer 10 years old or newer should support DIY projects. Performance may vary depending on channel count, lighting controller, and various other configurations.''

*Processor - 486 or greater
*Memory - 128MB or greater
*Hard Drive - 2GB or greater
*OS - Windows 98 or newer with the [http://www.microsoft.com/downloads/details.aspx?FamilyID=0856eacb-4362-4b0d-8edd-aab15c5e04f5&DisplayLang=en Microsoft .NET Framework] installed.

==Download==
Vixen Light Animation Software can be downloaded for free [http://www.vixenlights.com Here]

[http://www.vixenlights.com/releases/Vixen%202.0%20Release.zip Vixen 2.0 ]

There was a small bug identified in the update program that may or may not cause a problem for some. If you want to feel a bit safer, you can download an updated version of it '''before''' updating [http://www.vixenlights.com/files/Update.zip here] (it's a zip file that needs to be unzipped with the resulting update.exe residing in the Vixen directory.

Beta versions of Vixen are available via the [http://doityourselfchristmas.com/forums/forumdisplay.php?f=26 DIY Christmas Forum].

==Documentation==

* [[Vixen Reference]]
* [[Vixen Script Projects]]
* [[Vixen Plugins]]
** [[Vixen Plugin Development]]
** [[Vixen "Input" Plugin Development]]
* [[Vixen Add-ins]]
* [[Vixen Troubleshooting]]
* [[Vixen How-To's]]
* [[Vixen Help]]

==Other Resources==
* [http://vixenlights.com/ Vixenlights.com] Primary website for Vixen software
* [http://www.christmasinshirley.com/forum/index.php/forum/viewforum.php?f=6 DIY Christmas Thread] Discussions, Beta releases and other information.
* [http://blinkyflashy.14.forumer.com/ Blinky Flashy Forum] Vixen's original site; locked since DIY Christmas was started.

Vixen

2009-12-07T07:06:24Z

JonathonReinhart: /* What is Vixen? */

[[Category:Vixen]]
==What is Vixen?==
Vixen is Windows software running on the .NET platform that will put the computer in the do-if-yourself computer lighting animation. With a PC and some DIY [[Electronics Hardware]], anyone can have a professional looking lighting display synchronized to music.

Vixen is geared primarily towards the DIYer. For those that prefer a packaged all-in-one solution, there are commerical solutions available. For those that prefer a lower-cost DIY solution, Vixen may be the software for you. There are a broad base of software [[Vixen_Plugins | plug-ins]] to support different hardware designs. Additionally, you can create you own plug-ins to support your hardware.

==Minimum System Requirements==
''Just about any computer 10 years old or newer should support DIY projects. Performance may vary depending on channel count, lighting controller, and various other configurations.''

*Processor - 486 or greater
*Memory - 128MB or greater
*Hard Drive - 2GB or greater
*OS - Windows 98 or newer with the [http://www.microsoft.com/downloads/details.aspx?FamilyID=0856eacb-4362-4b0d-8edd-aab15c5e04f5&DisplayLang=en Microsoft .NET Framework] installed.

==Download==
Vixen Light Animation Software can be downloaded for free [http://www.vixenlights.com Here]

[http://www.vixenlights.com/releases/Vixen%202.0%20Release.zip Vixen 2.0 ]

There was a small bug identified in the update program that may or may not cause a problem for some. If you want to feel a bit safer, you can download an updated version of it '''before''' updating [http://www.vixenlights.com/files/Update.zip here] (it's a zip file that needs to be unzipped with the resulting update.exe residing in the Vixen directory.

Beta versions of Vixen are available via the [http://www.christmasinshirley.com/forum/index.php/forum/viewforum.php?f=6 DIY Christmas Forum].
==Documentation==

* [[Vixen Reference]]
* [[Vixen Script Projects]]
* [[Vixen Plugins]]
** [[Vixen Plugin Development]]
** [[Vixen "Input" Plugin Development]]
* [[Vixen Add-ins]]
* [[Vixen Troubleshooting]]
* [[Vixen How-To's]]
* [[Vixen Help]]

==Other Resources==
* [http://vixenlights.com/ Vixenlights.com] Primary website for Vixen software
* [http://www.christmasinshirley.com/forum/index.php/forum/viewforum.php?f=6 DIY Christmas Thread] Discussions, Beta releases and other information.
* [http://blinkyflashy.14.forumer.com/ Blinky Flashy Forum] Vixen's original site; locked since DIY Christmas was started.