Announcement

**spud** · March 26, 2014, 07:47 AM

FEATURES

Devices:

You can use the Hyperion devices created by the plugin to set the LEDs to a specific color using RGB values, or to activate a light effect like the "Knight Rider" effect or the "Rainbow swirl" effect.

The "Clear" button clear data for the priority channel specified in the config page, and the "Clear All" button clear data for all active priority channels.

Actions:

Here is the list of "Hyperion Action" you can run from an Event:

Set Color
Set Effect
Set Pattern
Clear
Clear All

The "Set Color" action lets you pick a color from a color picker widget (see screenshot below). Note: currently there is small bug in HS3 with this widget, one workaround to make sure the color you have chosen has been saved is to click twice on the "Run this action" button (white arrow on blue background)

Custom Effects:

From the config page / effects tab. you can define your own custom effects:

Click the green + button to add a new effect, then choose a master template for this effect, then change the parameters you want to customize.
color parameters are arrays of three values between 0 and 255 representing Red, Green and Blue components.

the test buttons let you apply the effect to your strip for 5 seconds to see what it looks like.

then you can use these custom effects in events actions or from your effect device as you would do with any other effect.

Patterns

From the Patterns tab you can create predefined static patterns.
The syntax to create a pattern is a list of ([R,G,B],NB_LEDS) separated by semi colons:

For example in the screenshot above,
([0,0,255],22) means Blue for the first 22 Leds
([255,255,255],20) means White for the next 20 Leds
([255,0,0],22) means Red for the next 22 Leds

once configured you can use it in a "Set Pattern" action

Scripting

SetColor, SetEffect, Clear, and ClearAll are also available as scripting functions. The red, green and blue parameters of SetColor must be integers between 0 and 255.

Here are the function signatures:

Code:

void SetColor(int red, int green, int blue, int priority=-1, int duration=-1)
void SetEffect(string effect, int priority=-1, int duration = -1)
void Clear(int priority=-1)
void ClearAll()

and an example of C# script:

Code:

public object Main(object[] Parms)
{
    hs.PluginFunction("Hyperion", "", "ClearAll", null);
    hs.PluginFunction("Hyperion", "", "SetColor", new object[] {245, 255, 0, 40, 10000});    
    System.Threading.Thread.Sleep(2000);
    hs.PluginFunction("Hyperion", "", "SetEffect", new object[] {"Knight rider", 40, 10000});

    return 0;
}

**spud** · September 21, 2014, 03:08 PM

MULTIPLE INSTANCES

If you want to control multiple LED strips from HS3, you need to create one instance of the plugin for each strip. To do so click the green '+' button from the "PLUG-INS > Manage" page like on the screenshot below.

Enter a name for your instance, submit, and then enable it.
This will create a new link in the "PLUG-INS > Hyperion" menu, allowing you to access the configuration screen for this new instance: