COEX-EN
  1. Monitoring
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
          GET
      • Set Blackout/Freeze Screen
        PUT
    • Cabinet
      • Retrieve Cabinet Information
        • Retrieve All Cabinet Information
      • 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. Monitoring

Retrieve Real-Time Monitoring Information

GET
/api/v1/device/monitor/info
/api/v1/device/monitor/info
All
TIP
Retrieve the monitoring information of the device, including the card temperature, voltage, fan speed, etc.

Request

Query Params
isNeedCabinetInfo
string 
optional
If 1 is passed, th returned monitoring data does not include the cabinet monitoring and cabinet uptime data.
Example:
0: Yes, 1: No

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/monitor/info'

Responses

🟢200Successful
application/json
Body
code
number 
optional
The return code, refer to "Error Codes."
data
object 
optional
name
string 
Controller name
optional
runtime
number 
The uptime of the controller (second).
optional
totalRuntime
number 
The total uptime of the controller (second).
optional
backupStatus
integer 
Backup status
required
109: primary in use, backup standby, 110: primary in use, backup in use, 111: primary in use, backup failed, 112: primary failed, backup standby, 113: primary failed, backup in use, 114: primary failed, backup failed.
mainBoardTemperature
object 
Mainboard temperature
optional
mainBoardVoltage
object 
Mainboard voltage
optional
fanInfos
array [object {3}] 
Fan information
optional
voltageInfos
array [object {3}] 
Voltage information
optional
temperatureInfos
array [object {3}] 
Temperature information
optional
cabinetPowerNumber
number 
Power supply quantity
required
controllerPortMonitorInfos
array [object {2}] 
Control port information
required
cardMonitorInfo
array [object {5}] 
required
screenSourceStatus
array [object {3}] 
Active source status
optional
outputStatus
array [object {4}] 
Output port status
optional
cabinets
array [object {8}] 
Cabinet
optional
rvCardsRuntime
array [object {4}] 
Run-time monitoring of receiving card
optional
screenRunTime
integer 
Total uptime of the screen
required
message
string 
optional
Example
{
  "code": 0,
  "data": {
    "name": "string",
    "runtime": 0,
    "totalRuntime": 0,
    "backupStatus": 0,
    "mainBoardTemperature": {
      "value": 0,
      "status": 0
    },
    "mainBoardVoltage": {
      "value": 0,
      "status": 0
    },
    "fanInfos": [
      {
        "fanSpeed": 0,
        "fanType": 0,
        "status": 0
      }
    ],
    "voltageInfos": [
      {
        "voltage": null,
        "voltageType": null,
        "status": null
      }
    ],
    "temperatureInfos": [
      {
        "temperature": null,
        "temperatureType": null,
        "status": null
      }
    ],
    "cabinetPowerNumber": 0,
    "controllerPortMonitorInfos": [
      {
        "controllerPortID": 0,
        "status": 0
      }
    ],
    "cardMonitorInfo": [
      {
        "cardID": 0,
        "cardType": 0,
        "status": 0,
        "cardTemperatureInfos": [
          {
            "temperature": 0,
            "temperatureType": 0
          }
        ],
        "cardVoltageInfos": [
          {
            "voltage": 0,
            "voltageType": 0
          }
        ]
      }
    ],
    "screenSourceStatus": [
      {
        "portID": 0,
        "status": 0,
        "inputCardID": 0
      }
    ],
    "outputStatus": [
      {
        "outputID": 0,
        "type": 0,
        "status": 0,
        "outputCardID": 0
      }
    ],
    "cabinets": [
      {
        "CabinetID": 0,
        "rvCardID": 0,
        "outPutID": 0,
        "index": 0,
        "temperature": {
          "value": 0,
          "status": 0
        },
        "voltage": {
          "value": 0,
          "status": 0
        },
        "rvCards": [
          {
            "cabinetID": 0,
            "rvCardID": 0,
            "netPortIndex": 0,
            "cabinetIndex": 0,
            "runtime": 0,
            "totalRuntime": 0,
            "temperature": {
              "value": 0,
              "status": 0
            },
            "voltage": {
              "value": 0,
              "status": 0
            },
            "humidity": {
              "value": 0,
              "status": 0
            },
            "errorBit": [
              {
                "value": 0,
                "type": 0,
                "status": 0
              }
            ],
            "backupStatus": {
              "mode": 0,
              "status": 0
            },
            "nextCabinetLinkStatus": {
              "linkStatus": true,
              "status": 0
            },
            "moduleInfos": [
              {
                "moduleIndex": "string",
                "temperature": {
                  "value": 0,
                  "status": 0
                },
                "voltage": {
                  "value": 0,
                  "status": 0
                }
              }
            ]
          }
        ],
        "powerInfo": [
          {
            "number": 0,
            "status": 0
          }
        ]
      }
    ],
    "rvCardsRuntime": [
      {
        "cabinetID": 0,
        "rvCardID": 0,
        "runtime": null,
        "totalRuntime": null
      }
    ],
    "screenRunTime": 0
  },
  "message": "string"
}
Modified at 2024-07-09 11:01:54
Previous
Device Identify
Next
Set Blackout/Freeze Screen
Built with