Hyperion

getLedsSnapshot

Testing Env

https://{{host}}:8092

POST

/json-rpc/instance-data/leds

WebsocketHTTP/S

Get a snapshot of LED colors which are currently processed by a given instance.

Request Example

Shell

JavaScript

Java

Swift

curl --location -g --request POST 'https://localhost:8092/json-rpc/instance-data/leds' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "instance-data",
    "subcommand": "getLedSnapshot",
    "instance": 1,
    "tan": 4711
}'

Response Example

Success

{
    "command": "instance-data-getLedSnapshot",
    "info": {
        "leds": [
            [
                7,
                0,
                155
            ],
            [
                4,
                0,
                171
            ],
            [
                1,
                0,
                197
            ],
            [
                0,
                0,
                235
            ],
            [
                2,
                0,
                183
            ],
            [
                2,
                0,
                27
            ],
            [
                0,
                0,
                0
            ],
            [
                2,
                0,
                4
            ],
            [
                12,
                0,
                15
            ],
            [
                25,
                0,
                21
            ]
        ]
    },
    "success": true,
    "tan": 4711
}

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:

instance-data

subcommand

enum<string>

required

The type of sub-command to execute.

Allowed value:

getLedSnapshot

instance

integer

required

Instance index (0-254) to which the command applies.

>= 0<= 254

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

getImageSnapshot

setColor