No announcement yet.

Hyperion Plug-in - User Guide

This topic is closed.
This is a sticky topic.
  • Filter
  • Time
  • Show
Clear All
new posts

    Hyperion Plug-in - User Guide


    System Requirements:

    This plugin is for HS3/HS3PRO

    You need one or several digital RGB LED strips controlled by one or several Hyperion server. You can find a lot of information on which LED strips are supported, and how to configure and install the Hyperion software in the Hyperion wiki:
    Alternatively I'm selling some Raspberry Pi kits with everything wired, installed and configured, see this thread.

    Plugin Installation:
    Download and install from the updater or download package from the Beta Testing thread and follow instructions to install.

    Plugin Configuration
    - Start the plugin from the "PLUG-INS > Manage" page
    - Go to the config page "PLUG-INS > Hyperion > Config" and enter the IP address and port of your Hyperion server.

    Click image for larger version

Name:	config.jpg
Views:	1
Size:	34.3 KB
ID:	1206279

    The priority parameter specify the priority channel used by the plugin. The lower the number, the higher the priority. For example if the plugin is set to priority=40, and the Android app remote control is set to priority=50, and if both try to set the LEDs to a different color, the plugin will have priority over the Android app.

    The duration parameter specify how long the LEDs should be switched on, in seconds. If you set duration=0, the LEDs will never switch off.
    Last edited by spud; February 6, 2015, 05:52 PM.



    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.

    Click image for larger version

Name:	devices.jpg
Views:	1
Size:	66.2 KB
ID:	1171896


    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)

    Click image for larger version

Name:	action.jpg
Views:	1
Size:	81.6 KB
ID:	1171897

    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.

    Click image for larger version

Name:	customeffects.jpg
Views:	2
Size:	64.3 KB
ID:	1173984


    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:

    Click image for larger version

Name:	patterns.jpg
Views:	2
Size:	39.8 KB
ID:	1186879

    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
    Click image for larger version

Name:	setpattern.jpg
Views:	2
Size:	23.4 KB
ID:	1186880


    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:

    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:

    public object Main(object[] Parms)
        hs.PluginFunction("Hyperion", "", "ClearAll", null);
        hs.PluginFunction("Hyperion", "", "SetColor", new object[] {245, 255, 0, 40, 10000});    
        hs.PluginFunction("Hyperion", "", "SetEffect", new object[] {"Knight rider", 40, 10000});
        return 0;
    Last edited by spud; March 11, 2017, 04:11 PM.



      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.

      Click image for larger version

Name:	multiinstance.png
Views:	1
Size:	34.6 KB
ID:	1186887

      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:

      Click image for larger version

Name:	multiinstance2.png
Views:	1
Size:	41.7 KB
ID:	1186888
      Last edited by spud; August 31, 2016, 10:15 AM.


        here is a video and some pics showing what you can do with this plugin

        Click image for larger version

Name:	20140531_0854412.jpg
Views:	1
Size:	140.2 KB
ID:	1186886

        Click image for larger version

Name:	frenchflag.jpg
Views:	1
Size:	51.4 KB
ID:	1186884

        Click image for larger version

Name:	hyperion.jpg
Views:	2
Size:	36.1 KB
ID:	1186885