setEffect - Hyperion

Set a color for all LEDs or provide a pattern of LED colors.
For best practices on using priorites, see Components & Priorities.

curl --location -g --request POST 'https://localhost:8092/json-rpc/input/effect' \ --header 'Content-Type: application/json' \ --data-raw '{ "command": "effect", "effect": { "name": "Warm mood blobs" }, "priority": 50, "origin": "My Fancy App" }'

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

command

enum<string>

required

The type of command to execute.

Allowed value:

effect

instance

array[integer]

optional

List of instance indices (0-254) to which the command applies. An empty array applies a command to all instances.

priority

integer

required

The priority of this input (1-253). Lower values override higher ones.

>= 1<= 253

origin

string

optional

Origin string (4-20 characters), e.g., the application name.

>= 4 characters<= 20 characters

duration

integer

optional

Duration in milliseconds to keep this input. Use -1 for indefinite duration.

>= -1

Example:

-1

effect

object

optional

Effect object containing the name and optional argument overrides.

name

string

required

args

object

optional

pythonScript

string

optional

Custom Python script for an effect.

imageData

string

optional

Image data to be used with the effect.

tan

integer

optional

Transaction number for tracking requests and responses.

>= 0

Example:

4711

Examples

Responses

🟢200Success

application/json

Body

command

string

required

The command executed

subcommand

string

optional

The sub-command executed

success

boolean

required

Result, if the request excuted successfully

info

object

optional

Information requested

Additional properties

integer | number | string | boolean

optional

error

string

optional

Reason why a request did not execute successfully

errorData

array [object {1}]

optional

Detailed error explaination

description

string

optional

tan

integer

required

Request's transaction number