# Set Screen Brightness

This interface allows you to set the brightness of a specified screen.

# API Path

{CLTPlatform-ip}:8086/processor/setBrightness

  • Replace {CLTPlatform-ip} with the corresponding IP address.
  • The request port is 8086.

# Protocol

HTTP

# Method

POST

# Request Parameter

  • Set the Content-Type of the request body to application/json.
Parameter Name Description Required Type Data Dictionary Limit Example
command Command type Yes string processor/setBrightness
data Data Yes object
data >> index Sender index (starting from 0, -1 for all senders) Yes int 0
data >> groupIndex Screen group index (0~screenGroupCount-1) Yes int 0
data >> brightness Brightness (0~100) Yes int 100

# Request Example

{
    "command": "processor/setBrightness",
    "data": {
        "index": 0,
        "groupIndex": 0,
        "brightness": 100
    }
}

# Response

Parameter Name Description Required Type Data Dictionary Limit Example
command Command type Yes string processor/setBrightness
code Status code Yes int 20000
message Message Yes string Common_Success
data Data No object

# Response Example

{
    "code": 20000,
    "command": "processor/setBrightness",
    "data": {},
    "message": "Common_Success"
}

# Detailed Description

* 2023.11.16
    1. Standardized description.