COEX-EN
  1. Retrieve Cabinet Information
COEX-EN
  • Contents
    • API Instructions
    • Error Code
    • General
      • Retrieve Screen Information
      • Set Screen Brightness
      • Set Screen Gamma
      • Set Blackout/Freeze Screen
      • Retrieve Preset Information
      • Apply Preset
      • Retrieve All Cabinet Information
      • Enable Cabinet Mapping
      • Retrieve Input Source List
      • Switch Source for Layer
      • Set EDID
      • Set Screen Color Temperature
    • Input
      • Retrieve Input Information
        • Retrieve Input Data
        • Retrieve Input Source List
      • EDID
        • Set EDID
      • Color Adjustment
        • Set Saturation
        • Set Color Highlight
        • Set Color Shadow
        • Adjust Hue
        • Reset Color Adjustment
      • Internal Source
        • Set Sending Card Test Pattern
      • Set HDR Mode
        • Set HDR Mode
    • Screen
      • Image booster
        • Color Gamut
          • Set Custom Gamut on a Screen-Basis
          • Switch Color Gamut
        • Retrieve Screen Display Effect Parameters
        • Set Screen Color Temperature
        • Set Custom Gamma for the Screen
        • Set Screen Brightness
        • Set Screen Gamma
      • Layer
        • Switch Source for Layer
      • Processing
        • 3D LUT
          • Delete 3D LUT File
          • Import 3D LUT File
          • Set 3D LUT Strength
          • Enable 3D LUT
      • Canvas
        • Canvas Mapping
      • Preset
        • Modify Preset
        • Retrieve Preset Information
        • Apply Preset
      • Schedule
        • Retrieve All Schedule Information of the Screens
        • Set Schedule On\Off
        • Delete Brightness Schedule
      • Output
        • 3D function
          • 3D Emitter
            • Enable 3D Emitter
          • Enable/Disable 3D
        • Retrieve Output Parameters
          • Retrieve Screen Output Data
        • Display mode
          • Set Blackout/Freeze Screen
        • Multi-Mode
          • Set Multi-mode by Screens
        • 3D
          • 3D Emitter
        • Display Mode
        • Retrieve Display Status
        • Set Output Bit Depth
      • Image Booster
        • Color Gamut
      • Retrieve Screen Properties Information
      • Retrieve the Number of Cabinets of the Screen
      • Retrieve Screen Information
    • Device
      • Device Identify
        • Device Identify
      • Monitoring
        • Retrieve Real-Time Monitoring Information
      • Set Blackout/Freeze Screen
    • Cabinet
      • Retrieve Cabinet Information
        • Retrieve All Cabinet Information
          GET
      • Brightness Adjustment
        • Set Cabinet RGB Brightness
        • Set Cabinet Brightness
      • Color Temperature Adjustment
        • Adjust Cabinet Color Temperature
      • Cabinet Control
        • Set Receiving Card Test Pattern
      • Cabinet Identify
        • Enable Cabinet Mapping
      • Multi-Mode
        • Set Multi-mode by Cabinets
      • Configure Cabinet Topology
        • Move Cabinet
  1. Retrieve Cabinet Information

Retrieve All Cabinet Information

GET
/api/v1/device/cabinet
/api/v1/device/cabinet
All
TIP
Retrieve cabinet information

Request

None

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 -g --request GET 'http://127.0.0.1:8001/api/v1/device/cabinet'

Responses

🟢200Successful
application/json
Body
array of:
resolution
object 
Cabinet pixels (internal use only)
required
width
integer 
Cabinet width
required
Int32
Default:
0
height
integer 
Cabinet height
required
int32
Default:
0
size
object 
Cabinet size
required
width
integer 
Cabinet width
required
Int32
Default:
0
height
integer 
Cabinet height
required
int32
weight
integer 
Cabinet weight (internal use only)
required
Int32
Default:
0
power
integer 
Cabinet power (internal use only)
required
Int32
Default:
0
colorTemperature
integer 
Color temperature value
required
Int32
Default:
6500
voltage
integer 
Cabinet voltage (internal use only)
required
Int32
Default:
5.0
rvCardName
string 
Name of receiving card in the cabinet (internal use only)
required
brightness
number 
Brightness
required
float
customGamma
boolean 
Custom gamma enable (internal use only)
required
Default:
false
gain
object 
Current Gain (internal use only)
required
r
integer 
Red gain
required
Int32
Default:
0
g
integer 
Green gain
required
Int32
Default:
0
b
integer 
Blue gain
required
Int32
Default:
0
outputID
integer 
Ethernet port number of the cabinet
required
uint8
Default:
0
canvasID
integer 
Canvas ID of the cabinet
required
outputCardID
integer 
Output card ID of the cabinet
required
index
integer 
Cabinet index (internal use only)
required
uint32
Default:
0
bunchesIndex
integer 
Index of the cabinet string (internal use only)
required
uint16
Default:
0
id
integer 
Cabinet ID
required
uint64
Default:
0
moduleCount
integer 
Number of modules of the cabinet (internal use only)
required
int
Default:
0
cabType
string 
Cabinet type (internal use only)
required
beacon
boolean 
Beacon enable (internal use only)
required
indicatorLightState
boolean 
Receiving card indicator status (internal use only)
required
manufacture
string 
Cabinet manufacturer (internal use only)
required
pointSpacing
string 
Cabinet pixel pitch (internal use only)
required
shortName
string 
Cabinet short name (internal use only)
required
familyName
string 
Cabinet series name (internal use only)
required
ncpVersion
string 
Cabinet library version (internal use only)
required
vsFreMax
Max frame rate (internal use only)
required
angle
integer 
Angle of rotation (internal use only)
required
moduleSize
object 
Overridden module size (internal use only)
required
overwrite
boolean 
Overwrite or not
required
moduleRow
integer 
Row
required
moduleCol
integer 
Column
required
rvCardInfo
object 
Receiving card information (internal use only)
required
firmware
string 
Firmware version
required
firmwareRemark
string 
FPGA version note
required
mcuFirmWare
string 
MCU firmware version
required
mcuFirmWareRemark
string 
MCU version note
required
driverChip
string 
Driver IC
required
decodeIc
string 
Decoding IC model
required
scanNumber
number 
Number of scans
required
moduleResolution
object 
Module specifications
required
refreshRate
Refresh rate
required
grayScale
number 
Grayscale level
required
chipEffectFlag
number 
Chip active high or low
required
maxGamma
number 
ICN chip max gamma value
required
cabinetFileParam
object 
Parameters of the cabinet file in use (internal use only)
required
manufactureName
string 
Manufacturer
required
cabinetName
string 
Cabinet name
required
cardModel
string 
Card model
required
status
string 
Releasing status
required
version
string 
Version number
required
issue
string 
Revision number
required
gamma
object 
RGB gamma values (internal use only)
optional
r
number 
Red gamma value
required
Default:
2.8
g
number 
Green gamma value
required
Default:
2.8
b
number 
Blue gamma value
required
Default:
2.8
Example
[
  {
    "resolution": {
      "width": "0",
      "height": "0"
    },
    "size": {
      "width": "0",
      "height": 0
    },
    "weight": "0",
    "power": "0",
    "colorTemperature": "6500",
    "voltage": "5.0",
    "rvCardName": "string",
    "brightness": 0,
    "customGamma": false,
    "gain": {
      "r": "0",
      "g": "0",
      "b": "0"
    },
    "outputID": "0",
    "canvasID": 0,
    "outputCardID": 0,
    "index": "0",
    "bunchesIndex": "0",
    "id": "0",
    "moduleCount": "0",
    "cabType": "string",
    "beacon": true,
    "indicatorLightState": true,
    "manufacture": "string",
    "pointSpacing": "string",
    "shortName": "string",
    "familyName": "string",
    "ncpVersion": "string",
    "vsFreMax": null,
    "angle": 0,
    "moduleSize": {
      "overwrite": true,
      "moduleRow": 0,
      "moduleCol": 0
    },
    "rvCardInfo": {
      "firmware": "string",
      "firmwareRemark": "string",
      "mcuFirmWare": "string",
      "mcuFirmWareRemark": "string",
      "driverChip": "string",
      "decodeIc": "string",
      "scanNumber": 0,
      "moduleResolution": {
        "width": 0,
        "height": 0
      },
      "refreshRate": null,
      "grayScale": 0,
      "chipEffectFlag": 0,
      "maxGamma": 0
    },
    "cabinetFileParam": {
      "manufactureName": "string",
      "cabinetName": "string",
      "cardModel": "string",
      "status": "string",
      "version": "string",
      "issue": "string"
    },
    "gamma": {
      "r": "2.8",
      "g": "2.8",
      "b": "2.8"
    }
  }
]
Modified at 2024-07-09 11:01:54
Previous
Set Blackout/Freeze Screen
Next
Set Cabinet RGB Brightness
Built with