播放盒-EN
  1. Screen control-related
播放盒-EN
  • API access guide
  • Common Error Codes
  • FAQ
  • User-related
    • Log in to devices
      POST
    • Log out of the device
      DELETE
    • Change user information
      PUT
  • System control-related
    • Screenshot
      GET
    • Restart the device immediately
      POST
    • Obtain device restart schedules
      GET
    • Schedule device restarts
      POST
    • Set time
      POST
    • Install apps
      PUT
    • Obtain time
      GET
    • Factory reset
      PUT
    • Obtain terminal information
      GET
    • Obtain volume
      GET
    • Set volume
      POST
    • Upgrade the device
      PUT
    • Check local upgrade status
      GET
  • Screen control-related
    • Receiving card-related
      • Obtain receiving card connection information
      • Obtain receiving card monitoring information
      • Obtain basic information of the receiving card
      • Configure the screen via receiving card configuration (send .rcfgx file)
      • Configure the screen via receiving card configuration (send .scr file)
      • Upgrade the receiving card
      • Obtain the receiving card upgrade progress
    • Send Card-related
      • Obtain the basic Information of the sending card
    • Obtain screen brightness
      GET
    • Set screen brightness
      POST
    • Obtain screen status
      GET
    • Set screen status
      POST
    • Obtain screen-on/off schedules
      GET
    • Set screen-on/off schedules
      POST
    • Set brightness adjustment schedules
      POST
    • Obtain brightness adjustment schedules
      GET
  • General capabilities
    • Upload files
    • Download files
  • Serial port control
    • Activate RS-485 serial communication
    • Check RS-485 serial port status
  • Board relays
    • Obtain relay information
    • Set relay information
  1. Screen control-related

Set screen brightness

POST
/terminal/core/v1/brightness
Last modified:2024-09-01 14:17:01
Set screen brightness

Request

Header Params
Content-Type
string 
optional
Example:
application/json
Authorization
string 
optional
Default:
1724333189506EO5Zqpduu4+azwYYXMJJhg==
Body Params application/json
ratio
number 
Brightness percentage
optional
Screen brightness percentage (0.0-100.0);When brightness is provided, the percentage can be omitted.Keep one decimal place.
>= 0<= 100
brightness
number 
Brightness value
optional
Screen brightness value (0-255). A brightness value will be used first. If there is no brightness value, percentage will be used.
>= 0<= 255
solidity
boolean 
Save to hardware
optional
Saving to hardware is to save the brightness value to the receiving card . The brightness value can be maintained after power failure and restart. However, the time to save to hardware is long. It is recommended not to save to hardware frequently. The interval should be more than 5s.
Default:
true
Example
{
  "ratio": 18,
  "brightness": 125,
  "solidity": true
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://192.168.0.10:16674/terminal/core/v1/brightness' \
--header 'Authorization: 1724333189506EO5Zqpduu4+azwYYXMJJhg==' \
--header 'Content-Type: application/json' \
--data-raw '{
    "ratio":18,
    "brightness":125,
    "solidity": true
}'

Responses

🟢200Success
application/json
Body
code
integer 
Status code
required
message
string 
Detailed information
required
data
object 
optional
Example
{
  "code": 0,
  "message": "",
  "data": {}
}
Previous
Obtain screen brightness
Next
Obtain screen status
Built with