adjustColors

Testing Env

https://{{host}}:8092

POST

/json-rpc/output/adjustment

WebsocketHTTP/S

Adjustments reflect the color calibration.

Request Example

Shell

JavaScript

Java

Swift

cURL

Example 1Example 2Example 3Example 4

curl --location -g --request POST 'https://localhost:8092/json-rpc/output/adjustment' \
--header 'Content-Type: application/json' \
--data-raw '{
    "command": "adjustment",
    "adjustment": {
        "gammaRed": 1.5
    },
    "tan": 4711
}'

Response Example

{
    "command": "adjustment",
    "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:

adjustment

instance

array[integer]

optional

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

adjustment

object

required

Adjustment profile

id

string

optional

Profile identifier

red

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

green

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

blue

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

yellow

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

magenta

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

cyan

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

white

array[integer]

optional

An array of R G B Integer values e.g. [R,G,B]

>= 3 items<= 3 items

gammaRed

number

optional

The gamma of red. 1.0 is neutral. Over 1.0 it reduces red, lower than 1.0 it adds red.

>= 0.1<= 5

Multiple of:

0.1

gammaGreen

number

optional

The gamma of green. 1.0 is neutral. Over 1.0 it reduces green, lower than 1.0 it adds green.

>= 0.1<= 5

Multiple of:

0.1

gammaBlue

number

optional

The gamma of blue. 1.0 is neutral. Over 1.0 it reduces blue, lower than 1.0 it adds blue.

>= 0.1<= 5

Multiple of:

0.1

backlightThreshold

integer

optional

Minimum brightness! Disabled for effect/color/image

>= 0<= 100

backlightColored

boolean

optional

If true the backlight is colored, false it is white. Disabled for
effect/color/image

brightness

integer

optional

The overall brightness of LEDs.

>= 0<= 100

brightnessCompensation

integer

optional

Compensates brightness differences between red green blue, cyan magenta yellow and white. 100 means full compensation, 0 no compensation.

>= 0<= 100

saturationGain

number

optional

Saturation of colors. 1.0 means no change, over 1.0 increases saturation, under 1.0 desaturates.

>= 0<= 10

brightnessGain

number

optional

Brightness of colors. 1.0 means no change, over 1.0 increases brightness, under 1.0 decreases brightness.

>= 0.1<= 10

temperature

integer

optional

Color temperature

>= 1000<= 40000

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