Profiles

Profiles

• Profiles
  • Root
    • Parameters
    • Code
  • Transitions
    • Code
  • Animations
    • Parameters
    • Code
  • Always on Elements
    • Parameters
    • Code
  • Always on Groups
    • Parameters
    • Code
  • Example

Profile configuration groups different animations and settings together.
Profiles files are located inside /usr/shared/ledspicer/profiles (this location can vary)

Root

The root node, like every other configuration file, is <LEDSpicer></LEDSpicer> with the following mandatory parameters: version, type and backgroundColor.

Parameters

version: leave it always to 1.0
type: is Profile
backgroundColor set a color name, the background color will be used when drawing the frames as the base color.

Code

<?xml version="1.0" encoding="UTF-8"?>
<LEDSpicer
    version="1.0"
    type="Profile"
    backgroundColor="someColor"
/>

Transitions

Every profile can execute a start transition animation when the profile starts and an end transition animation when it is terminated.
These transitions are normal animations and should be setup in the same way as any other Animations.

Code

<startTransitions>
    <animation name="animationFile1" />
    <animation name="animationFile2" />
    <animation name="animationFileX" />
</startTransitions>
<endTransitions>
    <animation name="animationFile1" />
    <animation name="animationFile2" />
    <animation name="animationFileX" />
</endTransitions>

Animations

One or more Animations can be called by name, so you can pile multiple animations together.

Parameters

name: The animation file name without the extension.

Code

<animations>
    <animation name="animation1" />
    <animation name="animation2" />
    <animation name="animationX" />
</animations>

Always on Elements

You can change the background color of some elements for this profile with a different one using the always on elements.

Parameters

name: The element name, mandatory.
color: A color name, if not set default color will be used.

Code

<alwaysOnElements>
    <element name="ELEMENT_1_NAME" color="someColor" />
    <element name="ELEMENT_2_NAME" color="someColor" />
    <element name="ELEMENT_X_NAME" color="someColor" />
</alwaysOnElements>

Always on Groups

Same as always on elements but for groups of elements.

Parameters

name: The group name (mandatory).
color: A color name, if not set default color will be used.

Code

<alwaysOnGroups>
    <group name="GROUP_1_NAME" color="someColor" />
    <group name="GROUP_2_NAME" color="someColor" />
    <group name="GROUP_X_NAME" color="someColor" />
</alwaysOnGroups>

Example

The profile file can look like this:

<?xml version="1.0" encoding="UTF-8"?>
<LEDSpicer
    version="1.0"
    type="Profile"
    backgroundColor="someColor"
>
    <startTransitions>
        <animation name="startTransition" />
    </startTransitions>
    <endTransitions>
        <animation name="endTransition" />
    </endTransitions>
    <animations>
        <animation name="animation1" />
        <animation name="animation2" />
        <animation name="animationX" />
    </animations>
    <alwaysOnElements>
        <element name="ELEMENT1_NAME" color="someColor" />
        <element name="ELEMENT2_NAME" color="someColor" />
        <element name="ELEMENTX_NAME" color="someColor" />
    </alwaysOnElements>
    <alwaysOnGroups>
        <group name="GROUP_1_NAME" color="someColor" />
        <group name="GROUP_2_NAME" color="someColor" />
        <group name="GROUP_X_NAME" color="someColor" />
    </alwaysOnGroups>
</LEDSpicer>

[Chris Newton]

This transitions are normal actors and should be setup in the same way as any other Actor.

The word "actor" is linked, but there's no Actor's page set up.